Invoice Template Variables

Migration notice: This page was converted from the legacy TO3000 3D CHM. Classification: KEEP. Legacy wording is evidence only — verify against current TO3000 7.1 / qa before treating as authoritative.

Date and code | VARIABLE | DESCRIPTION —|— \STATUS\ | Invoice status (For example: “Expected within 30 days”, “Settled 5 days earlier” and so on.) \DATE_DUE\ \SETTLEMENT_DATE\ | Date when the invoice is due in the following format: 10/4/2006 \DATE_DUE_LONG\ \SETTLEMENT_LONGDATE\ \DUE_DATELONG\ | Date when the invoice is due in the following format: Monday, October 04, 2006 \INVOICE_DATE\ \INV_DATE\ | Date the invoice was sent in the following format: 10/4/2006 \INVOICE_DATE_LONG\ \INV_LONGDATE\ | Date the invoice was sent in the following format: Monday, October 04, 2006 \INVOICE _CODE\ \INV_CODE\ | Invoice code \INVOICE _GLOBAL_CODE\ \INV_GLOBAL\ \INV_GLOBALLONG\ | Invoice global code

Invoice totals

VARIABLE	DESCRIPTION
\INVOICE_TOTAL\	Invoice total in the client’s currency
\INVOICE_TOTAL_BASE\	Invoice total in the base currency
\JOBS_TOTAL\	Jobs total in the client’s currency
\JOBS_TOTAL_BASE\	Jobs total in the base currency
\NET_JOBS_TOTAL\	Jobs total with discounts in the client’s currency
\NET_JOBS_TOTAL_BASE\	Jobs total with discounts in the base currency
VOLUME_BASE	Jobs total volume in base units

Taxes

VARIABLE	DESCRIPTION
\TAX1\	Indicates if tax 1 has been added; used in algorithms (If tax 1 exists = True, if it doesn’t = False)
\TAX1_NAME\	Tax 1 name
\TAX1_PERCENTS\	Tax 1 value in percents
\TAX1_VALUE\	Tax 1 value in the client’s currency
\TAX1_VALUE_BASE\	Tax 1 value in the base currency
\TAX2\	Used in algorithms (If tax 2 exists = True, if it doesn’t = False)
\TAX2_NAME\	Tax 2 name
\TAX2_PERCENTS\	Tax 2 value in percents
\TAX2_VALUE\	Tax 2 value the in the client’s currency
\TAX2_VALUE_BASE\	Tax 2 value the in the base currency
\TAXES\	Indicates if the taxes in the Tax fields are set; used in algorithms (If any tax is set = True, if it they are not = False)
\AFTER_TAX1\	Total in the client’s currency after Tax 1 is applied
\AFTER_TAX1_BASE\	Total in the base currency after Tax 1 is applied

Discounts

VARIABLE	DESCRIPTION
\DISCOUNT1\	Indicates if the discount/markup in the Discount/Markup field is set; used in algorithms (If discount 1 exists = True, if it does not = False)
\DISCOUNT1_NAME\	Discount 1 name
\DISCOUNT1_PERCENTS\	Discount 1 value in percents
\DISCOUNT1_VALUE\	Discount 1 value in the client’s currency
\DISCOUNT1_VALUE_BASE\	Discount 1 value in the base currency
\DISCOUNT2\	Indicates if the discount/markup in the Discount/Markup field is set; used in algorithms (If discount 2 exists = True, if it does not = False)
\DISCOUNT2_NAME\	Discount 2 name
\DISCOUNT2_PERCENTS\	Discount 2 value in percents
\DISCOUNT2_VALUE\	Discount 2 value in the client’s currency
\DISCOUNT2_VALUE_BASE\	Discount 2 value in the base currency
\DISCOUNTS\	Indicates if the discounts/markups in the Discount/Markup fields are set; used in algorithms (If any discount is set = True, if there are no = False)
\AFTER_DISCOUNT1\	Total in the client’s currency after Discount 1 applied
\AFTER_DISCOUNT1_BASE\	Total in the base currency after Discount 1 applied

Payment status variables

Code to paste to template	Information to be displayed in the saved document
\INVOICE_DUE\	Balance due in client’s currency
\INVOICE_DUE_BASE\	Balance due in base currency
\INVOICE_PAID\	Total payments linked to this invoice in client’s currency
\INVOICE_PAID_BASE\	Total payments linked to this invoice in base currency
\INV_IS_PAID\	Used in algorithms (If the invoice is paid = True, if it’s not = False)
\BEFORE_ADJUSTMENTS\	Invoice total in client’s currency, excluding adjustments
\BEFORE_ADJUSTMENTS_BASE\	Invoice total in base currency, excluding adjustments
\ADJUSTMENTS_VALUE\	Value of the adjustments in client’s currency
\ADJUSTMENTS_VALUE_BASE\	Value of the adjustments in base currency
\ADJUSTMENTS_DESCR\	Description of the adjustments
\INVOICE_PAYMETHOD\	Invoice payment method.
\INVOICE_PAYMETHOD_DESCR\	Payment method description.

Credit note status variables

Code to paste to template	Information to be displayed in the saved document
\CN_TOTAL\	The total of credit notes linked to this invoice, in the clients currency
\CN_TOTAL_BASE\	The total of credit notes linked to this invoice, in the base currency

Jobs variables in invoice

The following variables refer to jobs added to invoice

VARIABLE	DESCRIPTION
\DTLINKJOBS:CJOB_PONUMB\	Client PO of the job
\DTLINKJOBS:CJOB_NAME\	Client job name
\DTLINKJOBS:PROJ_NAME\	Project name
\DTLINKJOBS:CJOB_SERV_NAME\	Service name.
\DTLINKJOBS:CJOB_GROUP_NAME\	Group of Services name.
\DTLINKJOBS:CJOB_ASSIGNED\	Date the client job was assigned
\DTLINKJOBS:CJOB_DEADLINE\	Deadline of the client job
\DTLINKJOBS:CJOB_ISCOMPLETED\	Completed (Boolean: True/False)
\DTLINKJOBS:CJOB_COMPLETED\	Date the client job was completed
\DTLINKJOBS:CJOB_PRICE\	Price of the client job
\DTLINKJOBS:CJOB_VOLUME\	Client job volume
\DTLINKJOBS:CJOB_FEE_KIND\	Pricing (per unit, flat fee)
\DTLINKJOBS:CJOB_RATE\	Exchange rate
\DTLINKJOBS:CJOB_TOTAL\	Job total in the client’s currency
\DTLINKJOBS:CJOB_TOTAL_BASE\	Job total in the base currency
\DTLINKJOBS:CJOB_INSTRUCTION\	Instructions of the client job
\DTLINKJOBS:CJOB_WORKNOTES\	Work notes of the client job
\DTLINKJOBS:CJOB_COUNTNOTES\	CATCount notes of the client job
\DTLINKJOBS:SERV_NAME\	Service name of the client job
\DTLINKJOBS:UNIT_NAME\	Volume units of the client job
\DTLINKJOBS:PROJ_CODE\	Project code of the client job
\DTLINKJOBS:CJOB_CODE\	Client job code
\DTLINKJOBS:CJOB_CLCODE\	Client Ref. of the job
\DTLINKJOBS:CCON_NAME\	Client PM of the client job

Linked Payment Variables

Code to paste to template	Information to be displayed in the saved document
\DTLINKPAYMENTS:CPAYM_CODE\	Linked payment’s code
\DTLINKPAYMENTS:CPAYM_DATE\	Linked payment’s creation date
\DTLINKPAYMENTS:CPAYM_TOTAL\	Linked payment’s total value
\DTLINKPAYMENTS:LINK_SUM\	Part of the payment’s value linked to this invoice

Linked Credit Note Variables

Code to paste to template	Information to be displayed in the saved document
\DTLINKCREDITNOTES:CN_CODE\	Credit Note’s code
\DTLINKCREDITNOTES:CN_DATE\	Credit Note’s creation date
\DTLINKCREDITNOTES:CN_TOTAL\	Credit Note’s total value
\DTLINKCREDITNOTES:CN_ASSIGN_TOTAL\	Credit note’s value covered by refunds
\DTLINKCREDITNOTES:BALANCE\	Credit note’s value not covered by refunds
\DTLINKCREDITNOTES:CN_STATUS\	Credit Note’s status. Has the following values: 0 - “Closed”: the CN’s total is subtracted from the invoice’s balance. 1 - “Awaiting payment”: the Invoice is paid and the CN requires a refund. 2 - “Partially paid”: the CN is partially covered by a refund. 3 - “Fully paid”: the CN is fully covered by a refund.

_bm2