| Table of Contents |
|---|
| 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 of the clients' billing contacts will receive this email if any are set, otherwise the primary contact will receive the email.
...
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 |
|---|
|
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
(
)
[tax_subtotal] => 0
[tax_total] => 0
[taxes] => Array
(
)
[billing] => 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] =>
)
[client] => 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-05-08 21:35:13
[settings] => Array
(
...
[language] => en_us
...
)
)
[applied_transactions] => Array
(
[0] => stdClass Object
(
[id] => 126
[amount] => 1.0000
[currency] => USD
[date_added] => 2014-09-22 23:56:01
[type] => cc
[transaction_type_id] =>
[transaction_id] => 126
[invoice_id] => 505
[applied_amount] => 1.0000
[applied_date] => 2014-09-22 23:56:01
[type_name] =>
[invoice_id_code] => 171
[client_id] => 1
[account_id] => 4
[gateway_id] => 5
[gateway_name] => Authorize.Net
[gateway_type] => merchant
[reference_id] => 1111
[status] => approved
[type_real_name] => Credit Card
)
)
[payment_url] => domain.com/billing/client/pay/method/505/?sid=X6V8FU5X%2BdGtT9nZQ5DVOO2SsZdc5hC9k1ct6AiLtBs%3D
[autodebit_date] => 2014-09-22 07:00:00
[autodebit_date_formatted] => Sep 22, 2014
)
) |
| Code Block |
|---|
| language | text |
|---|
| title | The {payment_account} object |
|---|
| collapse | true |
|---|
| A credit card payment account:
stdClass Object
(
[id] => 4
[contact_id] => 1
[first_name] => First
[last_name] => Last
[address1] => 123 Main St.
[address2] =>
[city] => City
[state] => CA
[zip] => 90001
[country] => US
[number] => d6/No/zCxnjXmcAPxxRvpTm4a84+MiM6IepKj79Nh1gxmDplUl9Gz6ehFLiCjOhDZgGGRHmEx1Z7DRiy+Y97tuAnMi3nEAZppTI4Qs3f8BSZdKWjfGsXiYr9F0miUJ8Ret9/3F+o980q2vQ3SPBIGWk18f0AflMe3R1mapP3IZcrijVpcTYfI1Z99eNmXwcZ5TmeAyqd9+Sj7lbkf2yWtBonMogvrcclH9DhCORW7hQjm2jYFZQT74M6UWT990aOI/yghQVACWWho217vkWB+nwjmBsVbB5QgY/X29BFmjUpmqw73Qi2h/TpYlG3zCFFDrmRyCPy+CjCNWiWxLd/fCd9MR7dXEzEzN/vg3d35nfbM+71vTDRe4SDn4Q9VjQhI7rwDYMlhQ5f7U7HeTt9m/l5ggB7rg//iYoOtTYo+OncN0+qnQ99dQ5pZWatenXfZAhPVDS3eLNdQxZhKpcd2OyU/DjpFEYIA0dytWzbEMWoUO7/rKUv6LvbEpx3M57b
[expiration] => 202105
[last4] => 1234
[type] => mc
[gateway_id] =>
[client_reference_id] =>
[reference_id] =>
[status] => active
[client_id] => 1
[type_name] => Master Card
[account_type] => cc
)
An ACH payment account:
stdClass Object
(
[id] => 2
[contact_id] => 1
[first_name] => First
[last_name] => Last
[address1] => 123 Main St.
[address2] =>
[city] => City
[state] => CA
[zip] => 90001
[country] => US
[account] => m6gfz+Ee2SUldJIiBntBfbdnpLSsosZs7GVgpG24N1+IAqjl57RuxnsZU+COFBlwP26r8TzUmiINRrlh6EhsdzTiiFYHtdF1KT4Ht+UYlp7giLKW8tIYF05Xtt5Q+yNIj6zViYGV/6ZjZWNanfIwafwfcrHfqjBFyuY5a+mjOsf1/eW0lc2RyFIMwNFh8uSUM++bTfUEBSxKnEwSb8yQhrrD35CjNlmHn30Hql45nJkPFQEsbUOlNxeiOo/IAwj+J8X3Zc3WKQrFHD/F92XtRpHeYCyRSVF9QaK71qgeyly/H1xdVOGI2bYYgy7ARV071AXXACSOMHAlp88X1BR5Q0wWjspTeBjRN0fDE5UEjKMaLPa777Bcz5BmlmgGm63A994nPl5xK+DDx+e4c54zOJY7gDR/AUnlumAYZ0Dp4XmFRY3uI5qPQ9Iucpui9cWxH4ItC/Jyh0f2gw93qG3EKQAxY/0YMeRKkDlCqo1spdTvU0YowSz6qmJRm57EhugW
[routing] => e+p5fZGqTYiFzUcM1eHJo15j/lCnuKKPn6aHYy9Sj1/P4kCawX8AUxAJYUp4jGUzuKUuDV+N5P9tQUb85DIeCPrFqb11lRCe6sSjjEbDxNXlgGoILNzx/OZdcqXo5oUqd8Rt/dLpdLrwUPyNOpTQi7xaOh+APiCk5B3rFE7wq4nPjzl+OvQXp28IkN7ehw1ZOnFj8EoTGFDVfNIspYd6IqLiopDOvO2iDesga6YLbnCBJQ/rVMwCF6/jGpgtXMH1YbMq0qNO8jIjrxudFmIF9TaAPxV4UpQ2adl2u5O6iKhqRYeKxpyylZk07CeqI3PZOVHzdHGvo2AILzfA3BJUtzuYCW4nGVNUwfEaUxE12PHUE7GThdkucBtnOBhJBIQlmr6OEwPLYXa7163slmHUQ/wWLPJNfm09eux32KZhxXx1F+oZo4K+nVXQMaZJQPctKUhvcl8Ssb4i+aVOH/Ei7ga+5kuWT+d7Pzycyi5mGp/K+Y9ZiI/wiwstAtJJSwZH
[last4] => 1112
[type] => checking
[gateway_id] =>
[client_reference_id] =>
[reference_id] =>
[status] => active
[client_id] => 1
[type_name] => Checking
[account_type] => ach
) |
|
...