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
    [client_id_format] => {num}1
    [user_id_value] => 1500
    [usercontact_idtype] => 2primary
    [clientcontact_grouptype_id] => 1
    [primaryfirst_account_idname] => First
    [primarylast_account_typename] => Last
    [statustitle] => active
    [id_codecompany] => 1500Company Co.
    [contact_idemail] => 1first.last@domain.com
    [first_nameaddress1] => First
123 Main   [last_nameSt.
    [address2] => Last
    [companycity] => Company Co.City
    [emailstate] => first.last@domain.comCA
    [address1zip] => 123 Main St.90001
    [address2country] => stdClass Object
    [city] => City    (
    [state] => CA
        [zipalpha2] => 90001US
    [country] => US
        [group_namealpha3] => GeneralUSA
      [company_id] => 1
    [usernamename] => first.last@domain.comUnited States
    [two_factor_mode] => none
        [twoalt_factor_keyname] => 
    [two_factor_pin] =>     )
    [date_added] => 2014-0605-2508 1821:0535:34
)13
    [contact_type_name] => 
    [contact_type_is_lang] => 
)
Code Block
languagephp
titleThe {invoices} array of objects
collapsetrue
Array (
    [0] => stdClass Object
        (
            [id] => 1505
            [id_format] => {num}
            [id_value] => 1171
            [client_id] => 1
            [date_billed] => 2014-0609-2518 0007:00:00
            [date_due] => 2014-0709-0123 0007:00:00
            [date_closed] => 2014-09-22 23:56:04
            [date_autodebit] => 2014-06-29 00:00:00

               [status] => active
            [subtotal] => 101.0000
            [total] => 101.0000
            [paid] => 101.0000
            [previous_due] => 0829.00005010
            [currency] => USD
            [note_public] => 
            [note_private] => 
            [id_code] => 1000171
            [delivery_date_sent] => 2014-06-25 23:15:00
            [due] => 0.0000
            [line_items] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 11181
                            [invoice_id] => 1505
                            [service_id] => 1
                            [description] => BronzeLine Standard - domain.comItem Description
                            [qty] => 1.0000
                            [amount] => 101.0000
                            [subtotal] => 101.00000000
                            [taxes] => Array
                                (
                                )
 
                            [taxes_applied] => Array
                                (
                                )
 
                            [tax_subtotal] => 0
                            [tax_total] => 0
                            [total] => 101
                            [total_w_tax] => 101
                        )
                )
 
            [delivery] => Array
                (
                     [0] => stdClass Object
                         (
                             [id] => 1510
                             [invoice_id] => 1505
                             [method] => email
                             [date_sent] => 
                         )
                )
 
            [meta] => Array
                (
                )
 
            [tax_subtotal] => 0
            [tax_total] => 0
            [taxes] => Array
                (
                )
        )
    [1billing] => stdClass Object
        (
        (
      [id] => 2
            [id_format] => {num}
     1
       [id_value] => 2
            [client_id] => 1
            [date_billed        [user_id] => 2014-06-26 00:00:00

             [date_due] => 2014-07-01 00:00:00
    [contact_type] => primary
      [date_closed] => 
            [datecontact_type_autodebitid] => 2014-06-29 00:00:00
 
                    [statusfirst_name] => activeFirst
            [subtotal] => 20.0000
       [last_name] => Last
      [total] => 20.0000
            [paidtitle] => 20.0000

                    [previous_duecompany] => Company 0Co.0000
            [currency] => USD
            [note_public[email] => first.last@domain.com
             [note_private       [address1] => 
123 Main St.
          [id_code] => 1001
            [delivery_date_sent[address2] => 2014-06-26 23:15:00
            [due] => 0.0000
            [line_items[city] => ArrayCity
                (
    [state] => CA
                    [0zip] => stdClass Object90001
                    [country] => stdClass  (Object
                            [id] => 1(
                            [invoice_idalpha2] => 2US
                            [service_idalpha3] => 1USA
                            [descriptionname] => Gold Standard - domain2.comUnited States
                            [qtyalt_name] => 1.0000

                        )
    [amount] => 20.0000
              [date_added] => 2014-05-08 21:35:13
            [subtotal] => 20.00000000
      [contact_type_name] => 
                    [taxescontact_type_is_lang] => Array
               )
           [client] => stdClass Object
   (
            (
                    )
 [id] => 1
                            [taxes_applied[id_format] => Array{num}
                   [id_value] => 1500
           (
        [user_id] => 2
                   [client_group_id] =>  )1
 
                  [primary_account_id] => 
        [tax_subtotal] => 0
         [primary_account_type] => 
                   [tax_totalstatus] => 0active
                   [id_code] => 1500
          [total] => 20
       [contact_id] => 1
                   [totalfirst_w_taxname] => 20First
                        )[last_name] => Last
                )
 
  [company] => Company Co.
       [delivery] => Array
          [email]      (
 => first.last@domain.com
                   [0address1] => stdClass Object123 Main St.
                   [address2] => 
   (
                [city] => City
          [id] => 2
       [state] => CA
                   [invoice_idzip] => 290001
                   [country] => US
         [method]  => email
       [group_name] => General
                   [datecompany_sentid] => 1
                   [username]     )=> first.last@domain.com
                )
 
            [meta  [two_factor_mode] => Arraynone
                (
   [two_factor_key] => 
           )
 
            [taxtwo_factor_subtotalpin] => 0
                   [taxdate_totaladded] => 02014-05-08 21:35:13
            [taxes] =>       [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
       )
)