1. General

2. Taxes

Indicates whether the business pays taxes or not. A business pays taxes if they are enabled.

If you want to do something when the business pays taxes:

[#if business.taxLiable]
...
[/#if]

If you want to do something when the business doesn't pay taxes:

[#if !business.taxLiable]
...
[/#if]

3. Contact

A list with all the invoices of a client. This is useful if you want to create a statement. To access an invoice from the list use the following Freemarker code:

[#list client.invoices as invoice]
...
[/#list]

2. Contact

The number the client associates with the contract. In most cases, this number is a purchase order number.

Note: contract.reference replaces contract.clientNumber since version 2.1

A list with all the payments of an invoice. To access a payment from the list use the following Freemarker code:

[#list invoice.payments as payment]
...
[/#list]

3. Contents

The contents of an invoice may be accessed either by project or directly by referencing its items.

A list with all the items of an invoice. To access an item from the list use the following Freemarker code:

[#list invoice.items as item]
...
[/#list]

Since version 2.0, this placeholder has a new meaning. The list contains all items, including products and expenses. Previously, it contained only services.

Instead of accessing the entire list of items, one can access the services, the products and the expenses separately using the invoice.services, invoice.products and invoice.expenses placeholders.

A list with all the service items of an invoice. To access a service from the list use the following Freemarker code:

[#list invoice.services as service]
...
[/#list]

A list with all the product items of an invoice. To access a product from the list use the following Freemarker code:

[#list invoice.products as product]
...
[/#list]

A list with all the expense items of an invoice. To access an expense from the list use the following Freemarker code:

[#list invoice.expenses as expense]
...
[/#list]

A list with all the projects whose items or expenses belong to this invoice. The list of projects is useful if you invoice multiple projects.

To access a project from the list use the following Freemarker code:

[#list invoice.projects as project]
...
[/#list]

A list with all the exchange rates of an invoice if it uses multiple currencies. To access exchange rates from the list use the following Freemarker code:

[#list invoice.exchangeRates as exchangeRate]
...
${exchangeRate.source}
${exchangeRate.target}
${exchangeRate.rate}
...
[/#list]

Indicates whether the invoice has taxes or not. If you want to do something when the invoice has taxes:

[#if invoice.taxable]
...
[/#if]

If you want to do something when the invoice doesn't have taxes:

[#if !invoice.taxable]
...
[/#if]

A list with all the taxes of an invoice. To access a tax from the list use the following Freemarker code:

[#list invoice.taxes as tax]
...
[/#list]

This is a function that gives you the total amount for a certain tax.

The most common situation when this function is used is at the end of the invoice to display the total for each tax of the invoice. If the invoice has more than one tax.

If the total of an invoice is discounted, this field indicates the total before the discount. You may want to use this field like this:

[#if item.totalDiscounted]
    ${item.regularTotal}
[/#if]

The regular total is accessed only when the total is discounted.

If an invoice has discounts for both its items and its total value, this field represents the value of the invoice without any discount.

It's how much you would make if no discount is applied.

1. General

The general fields are used to describe an item.

self-explained

${item.catalogItem!"-"}

Note: item.catalogItem replaces item.itemCategory (introduced in version 2.0) and item.service (used before version 2.0).

Indicates if this item is a service. The following code prints a plus character if the item is a service.

[#if item.service]
    +
[/#if]

To access the list of services of a project see the project.services placeholder. For an invoice, see invoice.services.

Indicates if this item is a product. The following code prints a plus character if the item is a product.

[#if item.product]
    +
[/#if]

To access the list of products of a project see the project.products placeholder. For an invoice, see invoice.products.

Indicates if this item is an expense. The following code prints a plus character if the item is an expense.

[#if item.expense]
    +
[/#if]

To access the list of expenses of a project see the project.expenses placeholder. For an invoice, see invoice.expenses.

2. Billing

The billing fields are used to show billing information (price, quantity, total) about the item. If an item is discounted, you may also want to use the fields that show the regular (before any discount is applied) values.

More information about discounts and when they are available is provided in the discount section below.

Indicates whether this item is exempt from taxes or not. The following code prints a plus character if the item is exempt from taxes.

[#if item.taxExempt]
    +
[/#if]

Items can be marked as exempt from taxes only if taxes are enabled for your business.

The price used to bill the item. If the item is discounted, it indicates the price after the discount.

Note: item.price replaces item.rate which was used up until version 1.11.

The quantity used to bill the item. If the item is discounted, it indicates the quantity after the discount.

If the item is billed in hours, this field indicates the number of hours in decimal format. Otherwise it indicates the number of units.

Note: item.quantity replaces item.units which was used up until version 1.11.

Indicates whether a service item is billed in units or hours. Expense and product items are always billed in units.

[#if item.quantityType.id == 0]
    units
[/#if]

[#if item.quantityType.id == 1]
    hours
[/#if]

The amount of money that is charged for the item. If the item is discounted, it indicates the amount after all discounts.

Note: item.total replaces item.amount which was used up until version 1.11.

If the price of an item is discounted, this field indicates the price before the discount. You may want to use this field like this:

[#if item.priceDiscounted]
    ${item.regularPrice}
[/#if]

The regular price is accessed only when the price is discounted.

Note: item.regularPrice replaces item.regularRate which was used up until version 1.11.

If the quantity of an item is discounted, this field indicates the quantity before the discount. You may want to use this field like this:

[#if item.quantityDiscounted]
    ${item.regularQuantity}
[/#if]

The regular quantity is accessed only when it is discounted.

Note: item.regularQuantity replaces item.regularUnits which was used up until version 1.11.

If an item is discounted, this field indicates the total amount for the item before any discount is applied to it. You may want to use this field like this:

[#if item.discounted]
    ${item.regularTotal}
[/#if]

The regular total is accessed only when it is discounted.

Note: item.regularTotal replaces item.regularAmount which was used up until version 1.11.

3. Discount

The discount fields can be used to determine the discounts for the price or quantity of an item. There are also a few fields that can be used to determine if a discount has been applied to an item or not.

If an item is discounted by price, this field indicates the discount. It can be used to display the actual discount.

Note: item.priceDiscount replaces item.rateDiscount which was used up until version 1.11.

If an item is discounted by quantity, this field indicates the discount. It can be used to display the actual discount.

Note: item.quantityDiscount replaces item.unitsDiscount which was used up until version 1.11.

Indicates if the price of an item is discounted. See the item.regularPrice field above.

Note: item.priceDiscounted replaces item.rateDiscounted which was used up until version 1.11.

Indicates if the quantity of an item is discounted. See the item.regularQuantity field above.

Note: item.quantityDiscounted replaces item.unitsDiscounted which was used up until version 1.11.

Indicates if an item is discounted (either by rate or number of units). See the item.regularAmount field above.

4. Time

The time fields can be used to get more detailed information about the time recorded for an item.

A list with all the time entries recorded for a project item. This list is useful if you want to create a very detailed invoice that shows a breakdown for each invoiced item.

To access a time entry from the list use the following Freemarker code:

[#list item.timeEntries as timeEntry]
...
[/#list]

The total billed time for a project item in hour format. For instance 1 hour and 30 minutes is represented as 1:30.

The billed time may be slightly different than the elapsed time because of the time rounding that is applied to hourly-rated items.

The total time recorded for a project item in decimal format. For instance 1 hour and 30 minutes is represented as 1.50.

The billed time may be slightly different than the elapsed time because of the time rounding that is applied to hourly-rated items.

1. General

2. Contents

An invoice project contains billable items which can be service, product or expense items. The following fields let you access them.

A list with all the items of an invoice project. To access an item from the list use the following Freemarker code:

[#list project.items as item]
...
[/#list]

Since version 2.0, this placeholder has a new meaning. The list contains all items, including expenses. Previously, it contained only services.

Instead of accessing the entire list of items, one can access the services and the expenses separately using the project.services, project.products and the project.expenses placeholders.

A list with all the service items of an invoice project. To access a service from the list use the following Freemarker code:

[#list project.services as service]
...
[/#list]

A list with all the product items of an invoice project. To access a product from the list use the following Freemarker code:

[#list project.products as product]
...
[/#list]

A list with all the expense items of an invoice project. To access an expense from the list use the following Freemarker code:

[#list project.expenses as expense]
...
[/#list]

3. Totals

4. Time

Returns the current system time as a date object. It can be formatted using the ?date and ?time built-ins. See this section for more details on built-ins.

Use ${currentTime()?date} to display the system date or ${currentTime()?time} to display the system time.