Tokens

Tokens represent data from the database. They can represent a single item such as a product name, a list of items such as of the invoice lines associated with a purchase, or characteristics of invoices lines such as whether they are credits or not. You can use tokens in the following ways:

• Add tokens to text, Markdown text, field, table components, and page number components. They return data they represent from the database and display it on invoices.
• Add sorting and grouping tokens to table components so the system can identify invoice lines that meet the data criteria that the token specifies, and group and sort the invoice lines accordingly (see Build invoice line tables).

Following is the JSON format for tokens:

{{Token Name}}

To display data on invoices with tokens, you can add one or more tokens to text, field, page number, and Markdown components. Examples are shown in the following table:

Additionally, you can combine tokens and Markdown markup syntax for Markdown components (see Build Markdown text components).

Tokens are organized into categories and some are only valid for specific component types. To determine which token categories you can use in a component, refer to the following table.

All available tokens, by category, follow.

Token category: User details

Use these tokens to display customer details such as name and address. In the default invoice template, these appear in the invoice header Billed To section, as shown in the following example image.

These tokens are valid for all components that have data properties except those in the following:

• An Invoice lines table component.
• A tax summary table component.
• A page number component.

Token category: Seller details

Use this token to display seller details on invoices. In the default invoice template, these appear in the invoice header Payable to section, as shown in the following example image.

This token is valid for Markdown text components. See Build Markdown text components.

Token category: Invoice details

Use these tokens to display invoice and billing details such as the invoice number, invoice date, due date, and invoice status (paid, unpaid, and carried) on invoices. In the default invoice template, these appear in the invoice header, as shown in the following image:

These tokens are valid for cell and field components except those in the following:

• An Invoice lines table component.
• A tax summary table component.
• A page number component.

Token category: Invoice line details

Populate the invoice lines with these tokens to display data such as product and edition name, billing frequency, quantity, fees, discounts, and credits. See Build invoice line tables.

These, and tokens from the Grouping and sorting category, are the only tokens valid for invoice line table components.

Token category: Grouping and sorting tokens

These, and tokens from the Invoice line details category, are the only tokens valid for invoice line table components. See Build invoice line tables.

Use the tokens in this category to define the Grouping and sorting order of invoice line details tokens. They do not display data. Instead, they group the type of data in the order you specify in the table component.

Token category: Tax summary details

Populate tax summary tables with these tokens to display tax data on invoices. In the default invoice templates, these appear below the invoice lines table, as shown in the following example image.

Populate tax summary table components with these tokens. See Build tax summary tables.

Token category: Pagination tokens

Use these tokens to display the page number and total number of pages in invoice headers and footers.

These are the only tokens valid for page number components. See Build page number components.