Invoices

Merge Tag	Type	Description
{{invoice.invoice_id}}	integer	Invoice ID #
{{invoice.refnumber}}	string	Invoice reference number
{{invoice.external_key}}	string	External key value
{{invoice.invoice_index}}	integer	The invoice subscription sequence number on a subscription
{{invoice.package_id}}	integer	Subscription ID # this invoice was generated from
{{invoice.customer_id}}	integer	The customer ID # this invoice belongs to
{{invoice.brand_id}}	integer	Brand ID #
{{invoice.brand_name}}	string	Brand name
{{invoice.write_datetime}}	datetime	Date/time the invoice was created
{{invoice.mod_datetime}}	datetime	Date/time the invoice was last updated
{{invoice.void_datetime}}	datetime	Date/time the invoice was voided
{{invoice.date}}	date	Invoice date
{{invoice.currency_id}}	integer	Currency ID #
{{invoice.currency_symbol}}	string	Currency symbol
{{invoice.currency_iso4217}}	string	Currency ISO 4217 representation
{{invoice.class_id}}	integer	Class ID #
{{invoice.class_name}}	string	Class name
{{invoice.paycycle}}	string	Payment cycle
{{invoice.paycycle_name}}	string	Payment cycle name
{{invoice.terms_id}}	integer	Terms ID #
{{invoice.terms_name}}	string	Terms name
{{invoice.terms_days}}	integer	Terms # of days
{{invoice.admin_id}}	integer	Admin/Worker ID #
{{invoice.admin_name}}	string	Admin/Worker name
{{invoice.token}}	string	Unique token
{{invoice.bill_addr1}}	string	Billing address line 1
{{invoice.bill_addr2}}	string	Billing address line 2
{{invoice.bill_addr3}}	string	Billing address line 3
{{invoice.bill_city}}	string	Billing address city
{{invoice.bill_state}}	string	Billing address state/province
{{invoice.bill_postcode}}	string	Billing address postal code
{{invoice.bill_country}}	string	Billing address country
{{invoice.bill_notes}}	string	(deprecated)
{{invoice.bill_block}}	string	Printable billing address
{{invoice.ship_addr1}}	string	Ship address line 1
{{invoice.ship_addr2}}	string	Ship address line 2
{{invoice.ship_addr3}}	string	Ship address line 3
{{invoice.ship_city}}	string	Ship address city
{{invoice.ship_state}}	string	Ship address state/province
{{invoice.ship_postcode}}	string	Ship address postal code
{{invoice.ship_country}}	string	Ship address country
{{invoice.ship_notes}}	string	(deprecated)
{{invoice.ship_block}}	string	Printable shipping address
{{invoice.cycle_pre_from_date}}	date	For pre-billing cycle start date
{{invoice.cycle_pre_to_date}}	date	For pre-billing cycle end date
{{invoice.cycle_this_date}}	date	Cycle date (generally the invoice date)
{{invoice.cycle_post_from_date}}	date	For post-billing (in arrears) cycle start date
{{invoice.cycle_post_to_date}}	date	For post-billing (in arrears) cycle end date
{{invoice.url_permalink}}	string	URL to view the invoice
{{invoice.url_pdflink}}	string	URL to download the invoice PDF
{{invoice.url_paylink}}	string	URL to pay for the invoice
{{invoice.url_self}}	string	URL for viewing the invoice in the GUI
{{invoice.is_paid}}	boolean	Whether or not the invoice has been paid
{{invoice.is_void}}	boolean	Whether or not the invoice has been voided
{{invoice.is_overdue}}	boolean	Whether or not the invoice is overdue
{{invoice.due_date}}	date	Date the invoice is due
{{invoice.days_overdue}}	integer	# of days overdue the invoice is
{{invoice.paid_date}}	date	Date the invoice was paid
{{invoice.balance}}	float	Balance of the invoice
{{invoice.applied}}	float	Amount applied to the invoice
{{invoice.total}}	float	Invoice total
{{invoice.subtotal}}	float	Invoice subtotal
{{invoice.taxes}}	float	Taxes
{{invoice.credits}}	float	Amount of credits applied to the invoice
{{invoice.payments}}	float	Amount of payments applied to the invoice
{{invoice.writeoffs}}	float	Amount written off
{{invoice.refunds}}	float	Amount refunded
{{invoice.overdue}}	float	Amount overdue
{{invoice.declines}}	integer	# of times that payment was attempted and failed for this invoice
{{invoice.sum_base}}	float	Sum of the amounts of all base fees on the invoice
{{invoice.sum_usage}}	float	Sum of the amounts of all usage-based/metered fees on the invoice
{{invoice.sum_onetime}}	float	Sum of the amounts of all the one-time charges on the invoice
{{invoice.invoice_status_name}}	string	Human-friendly invoice status
{{invoice.invoice_status_str}}	string	Status string
{{invoice.invoice_status_state}}	string	Status code
{{invoice.memo}}	string	Memo/notes to customer
{{invoice.custom_1}}	mixed	Custom field #1
{{invoice.custom_2}}	mixed	Custom field #2
{{invoice.custom_3}}	mixed	Custom field #3
{{invoice.custom_4}}	mixed	Custom field #4
{{invoice.custom_5}}	mixed	Custom field #5
{{invoice.custom_6}}	mixed	Custom field #6
{{invoice.custom_7}}	mixed	Custom field #7
{{invoice.custom_8}}	mixed	Custom field #8
{{invoice.custom_9}}	mixed	Custom field #9
{{invoice.custom_10}}	mixed	Custom field #10
{{invoice.custom_11}}	mixed	Custom field #11
{{invoice.custom_12}}	mixed	Custom field #12
{{invoice.custom_13}}	mixed	Custom field #13
{{invoice.custom_14}}	mixed	Custom field #14
{{invoice.custom_15}}	mixed	Custom field #15
{{invoice.custom_16}}	mixed	Custom field #16
{{invoice.custom_17}}	mixed	Custom field #17
{{invoice.custom_18}}	mixed	Custom field #18
{{invoice.custom_19}}	mixed	Custom field #19
{{invoice.custom_20}}	mixed	Custom field #20
{{invoice.line_items}}	array	A list of line items for the invoice
{{invoice.schedule}}	array	A list of scheduled payments for the invoice
{{invoice.tags}}	array	A list of tags for the invoice