...
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] => |
|
| 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
(
[alpha2due] => US0
[alpha3line_items] => USAArray
[name] => United States
(
[alt_name0] => stdClass Object
)
[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] => (1181
[id] => 505
[invoice_id_format] => {num}505
[id_value] => 171
[clientservice_id] => 1
[date_billed] => 2014-09-18 07:00:00
[date_duedescription] => 2014-09-23 07:00:00
Line Item Description
[date_closed] => 2014-09-22 23:56:04
[date_autodebitqty] => 1.0000
[status] => active
[subtotalamount] => 1.0000
[total] => 1.0000
[paidsubtotal] => 1.000000000000
[previous_due] => 829.5010
[currencytaxes] => USD
Array
[note_public] =>
(
[note_private] =>
[id_code] => 171
[delivery_date_sent] => )
[due] => 0
[linetaxes_itemsapplied] => Array
(
(
[0] => stdClass Object
()
[idtax_subtotal] => 11810
[invoicetax_idtotal] => 5050
[service_idtotal] => 1
[descriptiontotal_w_tax] => Line1
Item Description
)
[qty] => 1.0000
)
[delivery] => Array
[amount] => 1.0000
(
[subtotal0] => stdClass 1.00000000Object
[taxes] => Array(
[id] => (510
[invoice_id] => 505
)
[taxes_appliedmethod] => Arrayemail
[date_sent] => (
)
)
[tax_subtotalmeta] => 0Array
[tax_total] => 0(
)
[totaltax_subtotal] => 10
[tax_total] => 0
[total_w_tax[taxes] => 1Array
)(
)
[deliverybilling] => ArraystdClass Object
(
[0id] => stdClass Object1
[client_id] (
=> 1
[user_id] => 510
[invoicecontact_idtype] => 505primary
[contact_type_id] =>
[method] => email
[first_name] => First
[datelast_sentname] => Last
[title] => )
)
[metacompany] => ArrayCompany Co.
(
[email] => first.last@domain.com
)
[tax_subtotaladdress1] => 0
123 Main St.
[tax_total] => 0
[taxesaddress2] => Array
(
[city] => City
)
[billingstate] => CA
stdClass Object
[zip] => (90001
[idcountry] => 1
stdClass Object
[client_id] => 1
(
[user_id] =>
[alpha2] => US
[contact_type] => primary
[contact_type_idalpha3] => USA
[first_ [name] => United FirstStates
[lastalt_name] => Last
[title] => )
[companydate_added] => Company Co.2014-05-08 21:35:13
[emailcontact_type_name] => first.last@domain.com
[address1contact_type_is_lang] => 123 Main St.
)
[address2] =>
[client] => stdClass Object
[city] => City(
[stateid] => CA1
[zipid_format] => 90001{num}
[countryid_value] => stdClass Object1500
[user_id] => 2
(
[client_group_id] => 1
[alpha2] => US
[primary_account_id] =>
[alpha3primary_account_type] => USA
[status] => active
[name] => United States
[id_code] => 1500
[altcontact_nameid] => 1
[first_name] )=> First
[datelast_addedname] => 2014-05-08 21:35:13
Last
[contact_type_namecompany] => Company Co.
[contact_type_is_langemail] => first.last@domain.com
)
[address1] => 123 Main St.
[client] => stdClass Object
[address2] => (
[idcity] => 1City
[id_formatstate] => {num}CA
[id_valuezip] => 150090001
[user_idcountry] => 2US
[client_group_idname] => 1General
[primarycompany_account_id] => 1
[primary_account_typeusername] => first.last@domain.com
[statustwo_factor_mode] => activenone
[idtwo_factor_codekey] => 1500
[contacttwo_factor_idpin] => 1
[firstdate_nameadded] => First 2014-05-08 21:35:13
[last_namesettings] => LastArray
[company] => Company Co.(
[email] => first.last@domain.com
...
[address1] => 123 Main St.
[language] => en_us
[address2] =>
...
[city] => City
)
[state] => CA
)
[zipapplied_transactions] => 90001Array
[country] => US(
[group_name0] => GeneralstdClass Object
[company_id] => 1
(
[usernameid] => first.last@domain.com126
[two_factor_mode [amount] => none1.0000
[two_factor_key] =>
[currency] => USD
[two_factor_pin] =>
[date_added] => 2014-0509-0822 2123:35:13
56:01
[settingstype] => Arraycc
[transaction_type_id] => (
... [transaction_id] => 126
[languageinvoice_id] => en_us505
...
[applied_amount] => 1.0000
[applied_date] => 2014-09-22 )
23:56:01
)
[appliedtype_transactionsname] => Array
(
[invoice_id_code] => 171
[0] => stdClass Object
[client_id] => (1
[account_id] => 1264
[amountgateway_id] => 1.00005
[currencygateway_name] => USDAuthorize.Net
[dategateway_addedtype] => 2014-09-22 23:56:01=> merchant
[typereference_id] => cc1111
[transaction_type_idstatus] => approved
[transactiontype_real_idname] => 126
Credit Card
)
[invoice_id] => 505 )
[payment_url] => domain.com/billing/client/pay/method/505/?sid=X6V8FU5X%2BdGtT9nZQ5DVOO2SsZdc5hC9k1ct6AiLtBs%3D
[appliedautodebit_amountdate] => 1.00002014-09-22 07:00:00
[autodebit_date_formatted] => Sep 22, 2014
[applied_date] => 2014-09-22 23:56:01
[type)
) |
| Code Block |
|---|
| language | text |
|---|
| title | {payment_account} |
|---|
| 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
[invoice_id_codestate] => 171CA
[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
[client_idexpiration] => 1202105
[last4] => 1234
[type] => mc
[gateway_id] =>
[account[client_reference_id] => 4
[reference_id] =>
[status] => active
[gatewayclient_id] => 51
[type_name] => Master Card
[account_type] => cc
)
An ACH payment account:
stdClass Object
(
[id] => 2
[gatewaycontact_nameid] => Authorize.Net1
[first_name] => First
[last_name] => Last
[address1] => 123 Main St.
[gateway_typeaddress2] => merchant
[city] => City
[state] => CA
[zip] => 90001
[country] => US
[reference_idaccount] => 1111
m6gfz+Ee2SUldJIiBntBfbdnpLSsosZs7GVgpG24N1+IAqjl57RuxnsZU+COFBlwP26r8TzUmiINRrlh6EhsdzTiiFYHtdF1KT4Ht+UYlp7giLKW8tIYF05Xtt5Q+yNIj6zViYGV/6ZjZWNanfIwafwfcrHfqjBFyuY5a+mjOsf1/eW0lc2RyFIMwNFh8uSUM++bTfUEBSxKnEwSb8yQhrrD35CjNlmHn30Hql45nJkPFQEsbUOlNxeiOo/IAwj+J8X3Zc3WKQrFHD/F92XtRpHeYCyRSVF9QaK71qgeyly/H1xdVOGI2bYYgy7ARV071AXXACSOMHAlp88X1BR5Q0wWjspTeBjRN0fDE5UEjKMaLPa777Bcz5BmlmgGm63A994nPl5xK+DDx+e4c54zOJY7gDR/AUnlumAYZ0Dp4XmFRY3uI5qPQ9Iucpui9cWxH4ItC/Jyh0f2gw93qG3EKQAxY/0YMeRKkDlCqo1spdTvU0YowSz6qmJRm57EhugW
[statusrouting] => approved
e+p5fZGqTYiFzUcM1eHJo15j/lCnuKKPn6aHYy9Sj1/P4kCawX8AUxAJYUp4jGUzuKUuDV+N5P9tQUb85DIeCPrFqb11lRCe6sSjjEbDxNXlgGoILNzx/OZdcqXo5oUqd8Rt/dLpdLrwUPyNOpTQi7xaOh+APiCk5B3rFE7wq4nPjzl+OvQXp28IkN7ehw1ZOnFj8EoTGFDVfNIspYd6IqLiopDOvO2iDesga6YLbnCBJQ/rVMwCF6/jGpgtXMH1YbMq0qNO8jIjrxudFmIF9TaAPxV4UpQ2adl2u5O6iKhqRYeKxpyylZk07CeqI3PZOVHzdHGvo2AILzfA3BJUtzuYCW4nGVNUwfEaUxE12PHUE7GThdkucBtnOBhJBIQlmr6OEwPLYXa7163slmHUQ/wWLPJNfm09eux32KZhxXx1F+oZo4K+nVXQMaZJQPctKUhvcl8Ssb4i+aVOH/Ei7ga+5kuWT+d7Pzycyi5mGp/K+Y9ZiI/wiwstAtJJSwZH
[last4] => 1112
[type_real_name] => Credit Cardchecking
)[gateway_id] =>
)
[client_reference_id] =>
[paymentreference_urlid] => domain.com/billing/client/pay/method/505/?sid=X6V8FU5X%2BdGtT9nZQ5DVOO2SsZdc5hC9k1ct6AiLtBs%3D
[status] => active
[autodebitclient_dateid] => 2014-09-22 07:00:001
[autodebit_date_formatted[type_name] => Sep 22, 2014Checking
[account_type] => )ach
) |
|