Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleAdditional 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
languagephp
titleThe {contact} object
collapsetrue
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
languagephp
titleThe {invoice} object
collapsetrue
stdClass Object
(
    [id] => 1
    [id_format] => {num}
    [id_value] => 1
    [client_id] => 1
    [date_billed] => 2014-06-25 00:00:00
    [date_billed_formatted] => June 25, 2014 12:00:00 AM
    [date_due] => 2014-07-01 00:00:00
    [date_due_formatted] => July 1, 2014 12:00:00 AM
    [date_closed] => 
    [date_closed_formatted] =>
    [date_autodebit] => 2014-06-29 00:00:00
    [date_autodebit_formatted] => June 29, 2014 12:00:00 AM
    [status] => active
    [subtotal] => 10.0000
    [total] => 10.0000
    [paid] => 0.0000
    [previous_due] => 0.0000
    [currency] => USD
    [note_public] => 
    [note_private] => 
    [id_code] => 1000
    [delivery_date_sent] => 2014-06-25 23:15:00
    [client_id_code] => 1500
    [client_first_name] => First
    [client_last_name] => Last
    [client_company] => Company Co.
    [client_address1] => 123 Main St.
    [client_email] => first.last@domain.com
    [due] => 10.0000
)
Code Block
languagephp
titleThe {payment_account} object
collapsetrue
stdClass Object
(
    [id] => 1
    [contact_id] => 1
    [first_name] => First
    [last_name] => Last
    [address1] => 123 Main St.
    [address2] => 
    [city] => City
    [state] => CA
    [zip] => 90001
    [country] => US
    [gateway_id] => 1
    [client_reference_id] => 
    [reference_id] => 
    [status] => active
    [client_id] => 1
)


If the payment account is a credit card account, the following fields will be available as well:
stdClass Object (
    [number] => 4111111111111111
    [expiration] => 1712201712
    [last4] => 1111
    [type] => visa
    [account_type] => Visa
)


If the payment account is an ACH account, the following fields will be available as well:
stdClass Object (
    [account] => 12345678901
    [routing] => 1234567890
    [last4] => 8901
    [type] => checking
    [account_type] => Checking
)

 

 

...