Page History

Table of Contents

maxLevel	4
minLevel	2
outline	true
class	toc

Description

This email template is sent when a scheduled paid invoice is delivered to the client. It will contain a PDF attachment of the invoice. Each Billing contact of the clients' billing contacts will receive this email if any are set, otherwise the primary contact will receive the email.

Supported Tags

The tags described in Blesta are only a list of commonly-used tags, for brevity.

Because the {invoices} tag is an array of objects (i.e. possibly multiple invoices), it should not be used as written. Instead, you should configure the template to loop over through each invoice individually within by using the for notation described under Customizing Emails.

Image RemovedImage Added

The tags below are all of those available for this email template. For other email and tag customizations, see Customizing Emails.

Tag	Description	Notes	Since Version
{contact.first_name}	The client's first name


{contact.last_name}	The client's last name


{contact.email}	The client's email address


{contact.id_code}	The client's ID	e.g. 1500
{autodebit}	Whether or not autodebit is enabled for this client	i.e. 1 or 0, denoting yes or no, respectively
{client_url}	The URI to Blesta's client interface	e.g. domain.com/billing/client/
{payment_account.first_name}	The first name on the payment account assigned for autodebit		v4.4.0
{payment_account.last_name}	The last name on the payment account assigned for autodebit		v4.4.0
{payment_account.account_type}	The payment account type that is assigned for autodebit	i.e. "cc" or "ach"	v4.4.0
{payment_account.last4}	The last four digits on the payment account assigned for autodebit		v4.4.0

Expand

title	Additional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, an example dump of the tag objects are shown below.

Code Block

language	php
title	The {contact} object
collapse	true

stdClass Object
(
    [id] => 1
    [client_id] => 1
    [user_id] => 
    [contact_type] => primary
    [contact_type_id] => 
    [first_name] => First
    [last_name] => Last
    [title] => 
    [company] => Company Co.
    [email] => first.last@domain.com
    [address1] => 123 Main St.
    [address2] => 
    [city] => City
    [state] => CA
    [zip] => 90001
    [country] => stdClass Object
        (
            [alpha2] => US
            [alpha3] => USA
            [name] => United States
            [alt_name] => 
        )
    [date_added] => 2014-05-08 21:35:13
    [contact_type_name] => 
    [contact_type_is_lang] => 
)

Code Block

language	php
title	The {invoices} array of objects
collapse	true

Array (
    [0] => stdClass Object
        (
            [id] => 505
            [id_format] => {num}
            [id_value] => 171
            [client_id] => 1
            [date_billed] => 2014-09-18 07:00:00
            [date_due] => 2014-09-23 07:00:00
            [date_closed] => 2014-09-22 23:56:04
            [date_autodebit] => 
            [status] => active
            [subtotal] => 1.0000
            [total] => 1.0000
            [paid] => 1.0000
            [previous_due] => 829.5010
            [currency] => USD
            [note_public] => 
            [note_private] => 
            [id_code] => 171
            [delivery_date_sent] => 
            [due] => 0
            [line_items] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 1181
                            [invoice_id] => 505
                            [service_id] => 
                            [description] => Line Item Description
                            [qty] => 1.0000
                            [amount] => 1.0000
                            [subtotal] => 1.00000000
                            [taxes] => Array
                                (
                                )
                            [taxes_applied] => Array
                                (
                                )
                            [tax_subtotal] => 0
                            [tax_total] => 0
                            [total] => 1
                            [total_w_tax] => 1
                        )
                )
            [delivery] => Array
                (
                     [0] => stdClass Object
                         (
                             [id] => 510
                             [invoice_id] => 505
                             [method] => email
                             [date_sent] => 
                         )
                )
            [meta] => Array

Expand

title	Additional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, an example dump of the tag objects are shown below.

Code Block

language	php
title	The {contact} object
collapse	true

stdClass Object
(
    [id] => 1
    [id_format] => {num}
    [id_value] => 1500
    [user_id] => 2
    [client_group_id] => 1
    [primary_account_id] => 
    [primary_account_type] => 
    [status] => active
    [id_code] => 1500
    [contact_id] => 1
    [first_name] => First
    [last_name] => Last
    [company] => Company Co.
    [email] => first.last@domain.com
    [address1] => 123 Main St.
    [address2] => 
    [city] => City
    [state] => CA
    [zip] => 90001
    [country] => US
    [group_name] => General
    [company_id] => 1
    [username] => first.last@domain.com
    [two_factor_mode] => none
    [two_factor_key] => 
    [two_factor_pin] => 
    [date_added] => 2014-06-25 18:05:34
)

Code Block

language	php
title	The {invoices} array of objects
collapse	true

Code Block

language	text
title	The {payment_account} object
collapse	true

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Description

Supported Tags