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]

A list with all the deposits of a client. To access a deposit from the list use the following Freemarker code:

[#list client.deposits as deposit]
...
[/#list]

2. Contact

A reference number like the purchase order number.

Note: This field was known as contract.reference before version 3.1 and as contract.clientNumber before 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 service items, the mileage items, the expense items and the product items separately using the invoice.serviceItems, invoice.expenseItems, invoice.mileageItems and invoice.productItems placeholders.

A list with all the regular (non-project) items of an invoice. If you don't invoice projects then ${invoice.regularItems} is the same as ${invoice.items}. To access an item from this list use the following Freemarker code:

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

Note: invoice.regularItems replaces invoice.nonProjectItems which was used in version 3.0.

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

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

Note: invoice.serviceItems replaces invoice.services which was used up until version 2.6.

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

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

Note: invoice.expenseItems replaces invoice.expenses which was used up until version 2.6.

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

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

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

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

Note: invoice.productItems replaces invoice.products which was used up until version 2.6.

A list with all the projects whose items 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]

The total amount of money due for all the service items from the invoice.

Note: invoice.serviceItemsSubtotal replaces invoice.servicesSubtotal which was used up until version 2.6.

The total amount of money due for all the expense items from the invoice.

Note: invoice.expenseItemsSubtotal replaces invoice.expensesSubtotal which was used up until version 2.6.

The total amount of money due for all the mileage items from the invoice.

The total amount of money due for all the product items from the invoice.

Note: invoice.productItemsSubtotal replaces invoice.productsSubtotal which was used up until version 2.6.

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.

The total invoiced time in hour format. For instance 1 hour and 30 minutes is represented as 1:30.

Note: invoice.billedTimeAsHour replaces invoice.billableTimeAsHour which was used up until version 3.0.

The total invoiced time in decimal format. For instance 1 hour and 30 minutes is represented as 1.50.

Note: invoice.billedTimeAsDecimal replaces invoice.billableTimeAsDecimal which was used up until version 3.0.

8. Time Reporting

The following placeholders are useful if you need to create invoice templates that group time entries by date.

These placeholders are used by the invoice template editor (File » Template Editor) if time is displayed and time entris are grouped by date. It uses ${invoice.groupDatesByDate(item.timeEntries)} to determine the dates when time was recorded for a service item.

A list with all the time entries that belong to the service items of an invoice.

This list is useful if you want to determine the dates when the invoiced time was recorded (see invoice.groupDatesByDate).

A list with the dates when the specified time entries were recorded.

[#list invoice.groupDatesByDate(invoice.timeEntries)?sort as date]
...
[/#list]

Use ${date.toDate()?date} to print each date and ${date.toInterval()} to create an interval for a date.

1. General

The general fields are used to describe an item.

This placeholder is deprecated starting with version 3.0. Items don't actually have a date field.

Use ${item.date?date} to access the value of the item date.

self-explained

${item.catalogItem!"-"}

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

Indicates whether this item is a regular item or not. All items that are added directly to an invoice (i.e. they don't invoice a project) are regular items. The following code prints a plus character if the item is a regular item.

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

To access the regular items of an invoice, see the invoice.regularItems placeholder.

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

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

To access the list of service item of an invoice project see the project.serviceItems placeholder. For an invoice, see invoice.serviceItems.

Note: item.serviceItem replaces item.service (used before version 2.7).

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

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

To access the list of expense items of a project see the project.expenseItems placeholder. For an invoice, see invoice.expenseItems.

Note: item.expenseItem replaces item.expense (used before version 2.7).

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

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

To access the list of mileage items of a project see the project.mileageItems placeholder. For an invoice, see invoice.mileageItems.

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

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

To access the list of product items of a project see the project.productItems placeholder. For an invoice, see invoice.productItems.

Note: item.productItem replaces item.product (used before version 2.7).

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 a service item.

A list with all the time entries recorded for a service 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 service item in hour format. For instance 1 hour and 30 minutes is represented as 1:30.

The billed time may be different than the elapsed time because the time may be rounded for service items.

Note: item.billedTimeAsHour replaces item.billableTimeAsHour which was used up until version 3.0.

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

The billed time may be different than the elapsed time because the time may be rounded for service items.

Note: item.billedTimeAsDecimal replaces item.billableTimeAsDecimal which was used up until version 3.0.

5. Trips

The trip fields can be used to get more detailed information about the trips recorded for a mileage item.

A list with all the trips recorded for a mileage 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 trip from the list use the following Freemarker code:

[#list item.trips as trip]
...
[/#list]

Indicates whether this deposit was used to pay an invoice. The following code prints the number of the invoice paid by this deposit.

[#if deposit.invoiceDeposit]
    ${deposit.invoiceNumber}
[/#if]

To access the list of deposits of a client see the client.deposits placeholder.

1. General

2. Contents

An invoice project contains items that can be service, expense, mileage or product 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 expense items. 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.serviceItems, project.productItems and the project.expenseItems placeholders.

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

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

Note: project.serviceItems replaces project.services which was used up until version 2.6.

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

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

Note: project.expenseItems replaces project.expenses which was used up until version 2.6.

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

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

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

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

Note: project.productItems replaces project.products which was used up until version 2.6.

3. Totals

The total amount of money due for all the service items from this project.

Note: project.serviceItemsSubtotal replaces project.servicesSubtotal which was used up until version 2.6.

The total amount of money due for all the expense items from this project.

Note: project.expenseItemsSubtotal replaces project.expensesSubtotal which was used up until version 2.6.

The total amount of money due for all the mileage items from this project.

The total amount of money due for all the product items from this project.

Note: project.productItemsSubtotal replaces project.productsSubtotal which was used up until version 2.6.

4. Time

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

Note: project.billedTimeAsHour replaces project.billableTimeAsHour which was used up until version 3.0.

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

Note: project.billedTimeAsDecimal replaces project.billableTimeAsDecimal which was used up until version 3.0.

The total rounded time recorded in hour format. For instance 1 hour and 30 minutes is represented as 1:30.

Rounded elapsed time definition

If a time entry belongs to a billable task or to a service item that rounds time, the rounded time may be different from the actual recorded time.

For instance, if a time entry has 12 minutes of recorded time and it belongs to a billable task that rounds time up to 15 minutes then the rounded elapsed time for this time entry is 15 minutes.

This property makes sense if you need to create reports that show the rounded (billable) time and not the actual time. The timereport.calculateRoundedElapsedTimeAsHour and timereport.calculateRoundedElapsedTimeAsDecimal placeholders can be used in time reports to calculate totals for multiple time entries.

The total rounded time recorded in decimal format. For instance 1 hour and 30 minutes is represented as 1.50.

See timeEntry.roundedElapsedTimeAsHour for an explanation of what rounded elapsed time is.

1. General

self-explained

self-explained

self-explained

self-explained

2. Planning

Indicates whether the task is completed or not. If you want to do something when the task is completed:

[#if task.completed]
...
[/#if]

If you want to do something when the task isn't completed:

[#if !task.completed]
...
[/#if]

Indicates whether the task is overdue or not. If you want to do something when the task is overdue:

[#if task.overdue]
...
[/#if]

If you want to do something when the task isn't overdue:

[#if !task.overdue]
...
[/#if]

3. Time tracking

A list with all the time entries of a task. To access a time entry from the list use the following Freemarker code:

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

self-explained

self-explained

Use ${trip.startTime?time} to access the time when the trip started.

If you are only interested in the date, use ${trip.startTime?date}.

Use ${trip.endTime?time} to access the time when the trip ended.

The distance recorded by the trip. ${trip.distance} represents distance as value followed by unit (eg 30 km).

If you need to access each field separately then you should use ${trip.distance.value} and ${trip.distance.unit}.

self-explained

self-explained

self-explained

1. Parameters

The date interval used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and projectsreport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if projectsreport.dateIntervalStart??]
		[#if projectsreport.dateIntervalEnd??]
	${projectsreport.dateIntervalStart?date} - ${projectsreport.dateIntervalEnd?date}
		[#else]
	After ${projectsreport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if projectsreport.dateIntervalEnd??]
	Before ${projectsreport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

2. Projects

The report allows you to obtain a list with all its projects and project elements (tasks, expenses, trips and products).

A list with all the projects included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified projects that have elements (tasks, time, expenses, trips or products) in the reporting period.

This filter is useful if you don't want to deal with projects that were active during the reporting period but nothing was recorded on them.

Finds the subset of the specified projects that belong to the specified client.

3. Grouping

Fields like clients can be extracted as separate groups from a list of projects.

A list with all the clients.

[#list projectssreport.groupClients(projectsreport.projects)?sort as client]
...
[/#list]

4. Totals

The report can calculate totals for a list of projects. The list of projects can either be projectsreport.projects (all the projects included in the report) or a partial list determined by one of the filter functions.

The total expenses amount for the specified project.

The total distance for the specified project.

The total for the specified project.

The tasks subtotal for the specified project.

The expenses subtotal for the specified project.

The trips subtotal for the specified project.

The products subtotal for the specified project.

1. Parameters

The date interval used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and timereport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if timereport.dateIntervalStart??]
		[#if timereport.dateIntervalEnd??]
	${timereport.dateIntervalStart?date} - ${timereport.dateIntervalEnd?date}
		[#else]
	After ${timereport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if timereport.dateIntervalEnd??]
	Before ${timereport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

2. Time entries

The report allows you to obtain a list with all its time entries or partial lists (for instance time entries that were recorded in a certain month).

A list with all the time entries included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified time entries that belong to the specified task.

Finds the subset of the specified time entries that belong to the specified project.

Finds the subset of the specified time entries that belong to the specified client.

3. Grouping

Fields like clients or dates can be extracted as separate groups from a list of time entries.

A list with all the clients.

[#list timereport.groupClients(timereport.timeEntries)?sort as client]
...
[/#list]

A list with all the projects.

[#list timereport.groupProjects(timereport.timeEntries)?sort as project]
...
[/#list]

A list with all the tasks.

[#list timereport.groupTasks(timereport.timeEntries)?sort as task]
...
[/#list]

A list with the dates when the time entries included in the report were recorded.

[#list timereport.groupDatesByDate(timereport.timeEntries)?sort as date]
...
[/#list]

Use ${date.toDate()?date} to print each date and ${date.toInterval()} to create an interval for a date.

A list with the weeks when the time entries included in the report were recorded.

[#list timereport.groupDatesByWeek(timereport.timeEntries)?sort as week]
...
[/#list]

Use ${week.toString("yyyy-ww")} to print each week and ${week.toInterval()} to create an interval for a week.

A list with the months when the time entries included in the report were recorded.

[#list timereport.groupDatesByMonth(timereport.timeEntries)?sort as month]
...
[/#list]

Use ${month.toString("MMM yyyy")} to print each month and ${month.toInterval()} to create an interval for a month.

A list with the years when the time entries included in the report were recorded.

[#list timereport.groupDatesByYear(timereport.timeEntries)?sort as year]
...
[/#list]

Use ${year} to print each year and ${year.toInterval()} to create an interval for an year.

4. Totals

The report can calculate totals for a list of time entries. The list of time entries can either be timereport.timeEntries (all the time entries included in the report) or a partial list determined by one of the filter functions.

1. Parameters

The date interval used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and tasksreport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if tasksreport.dateIntervalStart??]
		[#if tasksreport.dateIntervalEnd??]
	${tasksreport.dateIntervalStart?date} - ${tasksreport.dateIntervalEnd?date}
		[#else]
	After ${tasksreport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if tasksreport.dateIntervalEnd??]
	Before ${tasksreport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

2. Tasks

The report allows you to obtain a list with all its tasks or partial lists (for instance tasks that were recorded for a certain project).

A list with all the tasks included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified tasks that have time or money in the reporting period.

This filter is useful if you don't want to deal with tasks that were active during the reporting period but nothing was recorded on them.

Finds the subset of the specified tasks that belong to the specified project.

Finds the subset of the specified tasks that belong to the specified client.

3. Grouping

Fields like clients or projects can be extracted as separate groups from a list of tasks.

A list with all the clients.

[#list tasksreport.groupClients(tasksreport.tasks)?sort as client]
...
[/#list]

A list with all the projects.

[#list tasksreport.groupProjects(tasksreport.tasks)?sort as project]
...
[/#list]

4. Totals

The report can calculate totals for a list of tasks. The list of tasks can either be tasksreport.tasks (all the tasks included in the report) or a partial list determined by one of the filter functions.

The billable total for the specified task.

How much money can be invoiced for the task in the reporting period.

The billable total for the specified list of tasks.

How much money can be invoiced for the list of tasks in the reporting period.

The billed total for the specified task.

How much money was invoiced for the task in the reporting period.

For instance, if a task started on January 1st and it was invoiced on February 10th for the whole month of January for $100 then the billed total for January will be $100.

The billed total for the specified list of tasks.

How much money was invoiced for the list of tasks in the reporting period.

The total (billable + billed) for the specified task.

How much money is the task worth in the reporting period.

The total (billable + billed) for the specified list of tasks.

How much money is the list of tasks worth in the reporting period.

1. Parameters

The date interval used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and expensesreport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if expensesreport.dateIntervalStart??]
		[#if expensesreport.dateIntervalEnd??]
	${expensesreport.dateIntervalStart?date} - ${expensesreport.dateIntervalEnd?date}
		[#else]
	After ${expensesreport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if expensesreport.dateIntervalEnd??]
	Before ${expensesreport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

2. Expenses

The report allows you to obtain a list with all its expenses or partial lists (for instance expenses that were recorded for a certain project).

A list with all the expenses included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified expenses that belong to the specified project.

Finds the subset of the specified expenses that belong to the specified client.

3. Grouping

Fields like clients or projects can be extracted as separate groups from a list of expenses.

A list with all the clients.

[#list expensesreport.groupClients(expensesreport.expenses)?sort as client]
...
[/#list]

A list with all the projects.

[#list expensesreport.groupProjects(expensesreport.expenses)?sort as project]
...
[/#list]

4. Totals

The report can calculate totals for a list of expenses. The list of expenses can either be expensesreport.expenses (all the expenses included in the report) or a partial list determined by one of the filter functions.

The total amount for the specified list of expenses.

Amount specifies the total amount of money spent.

The total for the specified list of expenses.

Total specifies the total amount of money billed if the expense is billable.

1. Parameters

The date interval used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and tripssreport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if tripsreport.dateIntervalStart??]
		[#if tripsreport.dateIntervalEnd??]
	${tripsreport.dateIntervalStart?date} - ${tripsreport.dateIntervalEnd?date}
		[#else]
	After ${tripsreport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if tripsreport.dateIntervalEnd??]
	Before ${tripsreport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

2. Trips

The report allows you to obtain a list with all its trips or partial lists (for instance trips that were recorded for a certain project).

A list with all the trips included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified trips that belong to the specified project.

Finds the subset of the specified trips that belong to the specified client.

3. Grouping

Fields like clients or projects can be extracted as separate groups from a list of trips.

A list with all the clients.

[#list tripsreport.groupClients(tripsreport.trips)?sort as client]
...
[/#list]

A list with all the projects.

[#list tripsreport.groupProjects(tripsreport.trips)?sort as project]
...
[/#list]

4. Totals

The report can calculate totals for a list of trips. The list of trips can either be tripsreport.trips (all the trips included in the report) or a partial list determined by one of the filter functions.

The total distance for the specified list of trips.

The total for the specified list of trips.

1. Parameters

The date and paid date intervals used to build the report can be accessed from the template.

Each interval may or may not have a start date and an end date. If a date interval is defined only by its start date then the end date will not be defined and salesreport.dateIntervalEnd?? will return false. The folowing code can be used to cover all situations, whether these fields are defined or not.

	[#if salesreport.dateIntervalStart??]
		[#if salesreport.dateIntervalEnd??]
	${salesreport.dateIntervalStart?date} - ${salesreport.dateIntervalEnd?date}
		[#else]
	After ${salesreport.dateIntervalStart?date}
		[/#if]
	[#else]
		[#if salesreport.dateIntervalEnd??]
	Before ${salesreport.dateIntervalEnd?date}
		[#else]
	All dates
		[/#if]
	[/#if]

self-explained

self-explained

self-explained

self-explained

2. Invoices

The report allows you to obtain a list with all its invoices or partial lists (for instance invoices that were issued in a certain month).

A list with all the invoices included in the report. This is probably most important placeholder because almost all reports need to use it.

Finds the subset of the specified invoices that belong to the specified client.

3. Grouping

Fields like clients or dates can be extracted as separate groups from a list of invoices. Dates can be grouped by month or year.

A list with all the invoiced clients.

[#list salesreport.groupClients(salesreport.invoices)?sort as client]
...
[/#list]

A list with the months when the invoices included in the report were issued.

[#list salesreport.groupDatesByMonth(salesreport.invoices)?sort as month]
...
[/#list]

Use ${month.toString("MMM yyyy")} to print each month and ${month.toInterval()} to create an interval for a month.

A list with the years when the invoices included in the report were issued.

[#list salesreport.groupDatesByYear(salesreport.invoices)?sort as year]
...
[/#list]

Use ${year} to print each year and ${year.toInterval()} to create an interval for an year.

A list with the months when the invoices included in the report were paid.

A list with the years when the invoices included in the report were paid.

4. Totals

The report can calculate totals for a list of invoices. The list of invoices can either be salesreport.invoices (all the invoices included in the report) or a partial list determined by one of the filter functions.

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.