Invoice Template Properties

OfficeRnD Invoice placeholders, or properties, are a way to customize your invoice templates. Properties contain the dynamically generated data about an invoice - such as its total price, currency, or VAT. To use them enter their name within double curly brackets - {{ placeholder }}.

You can find out more about how to use these placeholders in your invoice templates in this help article

Note: Any CSS code has to be input in the Custom Code field and not into the Code tab of the template in order for it to work correctly.

s1.PNG

There are a few primary data collections related to an invoice that are also available in the invoice templates:

  • contracts
  • items
  • location
  • organization
  • taxInfo
  • customer

Each has its own set of properties. The location collection, for example, contains your location billing details such as billing address, name, and custom properties. In addition to these data objects, there are associated data objects such as logoUrl, discount, vatPercent etc.

This article categorizes the placeholders by the data they display:

  • Invoice Data
  • Invoice Lines Data
  • Location Data
  • Invoice Tax Information
  • Invoice VAT Amounts
  • Location Data
  • Organization Data
  • Contracts Data
  • Customer Data

Invoice Data

The properties below give you access to general invoice data like amount, issue date, due date etc.

Property/Placeholder Description
paymentMethod The invoice payment method, eg. "Bank Transfer"
amount The total amount of the invoice with taxes
subtotal The total amount of the invoice without taxes
discount The discount value (percent or value off) applied on the invoice.
discountAmount The amount of the discount applied on the invoice.
payableAmount The amount to be paid.
isPaid Determines whether the invoice is fully paid.
baseAmount The amount of the invoice without taxes.
vatAmount The tax amount applied on the invoice.
vatPercent The tax percent applied on the invoice.
number The invoice number.
reference The invoice reference.
issueDate The date when the invoice was issued.
dueDate The date when the invoice is due.
currency The currency of the invoice.
issuedBy The name of the person who issued the invoice.
name The company or the member the invoice is made out to.
recipient The invoice recipient
exchangeRate The exchange rate between currencies that is set in the system
amountInBaseCurrency The total amount of the invoice with taxes, in the organization's default currency

 

Invoice lines data

The items placeholder is the one giving you access to the invoice line items' data.

Property/Placeholder Description
items[0].baseTotal The total amount of the invoice line without taxes.
items[0].total The total amount of the invoice line with taxes.
items[0].subtotal The invoice line subtotal(depends on the type of tax).
items[0].unitPrice The unit price of the item included in the invoice line with tax.
items[0].baseUnitPrice The unit price of the item included in the invoice line without tax.
items[0].description The line item description.
items[0].discount The discount percent or value off on the invoice line.
items[0].discountAmount The discount amount on the invoice line.
items[0].vatPercent The VAT percent on the invoice line.
items[0].vatAmount The VAT amount on the invoice line.
items[0].quantity The quantity of the item included in the line.
items[0].startDate Start date of the item(e.g. membership start date).
items[0].endDate End date of the item(e.g. membership end date).
items[0].account Revenue account of the item

 

Invoice tax information

The taxInfo placeholder is the one giving you access to the invoice tax information.

Property/Placeholder Description
taxInfo.totalTaxable Total taxable amount(without tax).
taxInfo.totalTaxes Total tax amount.
taxInfo.vatPercent VAT percent.
taxInfo.amounts[0].baseAmount Invoice amount without tax.
taxInfo.amounts[0].taxAmount Amount of tax on the invoice. 
taxInfo.amounts[0].components[0].name The name of the tax component applied on the invoice.
taxInfo.amounts[0].components[0].percent The percent of the tax component applied on the invoice. 
taxInfo.amounts[0].components[0].total The amount of the tax component on the invoice. 
taxInfo.amounts[0].taxRate.name The tax rate name applied on the amount.
taxInfo.amounts[0].taxRate.rate The tax rate percent applied on the amount.

 

VAT Amounts

The vatAmounts placeholder is the one giving you access to the invoice different VAT Amounts.

Property/Placeholder Description
vatAmounts[0].total Amount of the tax component.
vatAmounts[0].name Name of the tax component.
vatAmounts[0].percent Percent of the tax component.

 

Location Data

Property/Placeholder Description
locationId The ID number of the location targeted in the invoice.
location.name  Name of the location targeted in the invoice.
location.address Address of the location targeted in the invoice as configured under Space/Locations.
location.city The city of the location targeted in the invoice as configured under Space/Locations.
location.properties List of any custom location properties.
location.slug The slug (URL name) of the location targeted in the invoice.

 

Organization Data

The information about your organization, such as billing details and address. Here are the exact details of what you can display: 

Property/Placeholder Description
organizationaccountBank Your organization bank account.
organizationaccountBic Your organization BIC number.
organizationaccountIban Your organization IBAN.
organizationContact The name of your organization contact person.
organizationCurrency Your organization currency.
organizationInvoicingPeriod Your organization invoicing period.
organizationInvoicingVat Your organization VAT type(e.g. "included", "excluded").
organizationAddress Your organization address.
organizationCity Your organization city.
organizationVatId Your organization VAT Id.
logoUrl  The URL to your organization logo so that it can be automatically displayed on the invoice document.

 

Contracts Data

If you are invoicing contracts, the contracts placeholder will give you access to a list with the following data properties:

Property/Placeholder Description
contracts[0].signDate The date contract was signed.
contracts[0].startDate The contract start date.
contracts[0].endDate The contract end date.
contracts[0].number The contract number.

 

Customer Data

Property/Placeholder Description
customer.email The customer email.
customer.name The customer name.
Note: In case there's a business name added in the Billing details field of the customer's profile, the system will use that one instead of the customer's name.
customer.properties List of customer properties.

 

Other functions

Property/Placeholder Description
placeholder|money Formats the value of the placeholder to a currency format.
Example: Enter 20|money, the output would be 20.00 USD(currency depends on the space settings).
parseMoney(placeholder)

Parses the value of the placeholder so you can add or subtract numbers to it.
Example: Enter parseMoney(total) + 20. The result is the total amount of the invoice plus 20.

 

 

 

Was this article helpful?
2 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.