Invoice Fields Reference

Modified on Thu, 24 Sep at 9:27 AM

Invoice fields allow you to insert information from a WorkGuru invoice into your document templates. These fields can be used to display information such as:

Document Compatibility

Invoice fields are only supported on the following document templates:

Invoice fields are Universal Fields, which means they can be placed directly within a Invoice document template and do not need to be inside a repeating table. If you need to display repeating invoice line information, such as individual products, tasks, purchases or payments, you will need to use Table Fields. Common invoice table types include:

See the Table Fields Reference for instructions on creating and configuring table fields. Merge fields are case sensitive and must be entered exactly as displayed below.

Invoice Information

Description
Merge Field
Invoice Number
[InvoiceNumber]
Invoice Description
[InvoiceDescription]
Invoice Reference
[InvoiceReference]

Invoice Dates

All dates are printed in the DD/MM/YYYY format.

Description
Merge Field

Invoice Date

[InvoiceDate]
Invoice Due Date
[InvoiceDueDate]

Invoice Financials

Description
Fields
Notes
Invoice Subtotal
[InvoiceSubTotal]

Invoice Tax Total
[InvoiceTaxTotal]

Invoice Total
[InvoiceTotal]

Amount Outstanding
[AmountOutstanding]
Amount Outstanding displays the invoice total minus payments received against the invoice.

Product Totals

These fields display totals relating to products included on the invoice.

Description
 Merge Field
Product Total
[InvoiceProductTotal]
Product Tax Total
[InvoiceProductTotalTax]
Product Total Including Tax
[InvoiceProductTotalIncTax]

Task Totals

These fields display totals relating to tasks included on the invoice.

Description
Merge Field
Task Total
[InvoiceTaskTotal]
Task Tax Total
[InvoiceTaskTotalTax]
Task Total Including Tax
[InvoiceTaskTotalIncTax]

Purchase Order Disbursement Totals

These fields display Purchase Order disbursement totals associated with the invoice.

Description
Merge Field
Purchase Order Disbursements Total
[PODisbursementsTotal]
Purchase Order Disbursements Tax Total
[PODisbursementsTaxTotal]

Purchase Order Disbursements Total Including Tax

[PODisbursementsTotalIncTax]

Invoice Client Information

When you raise an invoice or client credit note from a stock sale or a project, their billing client and contacts become the standard client and contacts on the invoice.  When building an Invoice template, use the specific Invoice and Client-related fields supported by the Invoice document type rather than the Billing Client fields. Refer to the standard Client and Contact Fields Reference for Invoice-specific Client fields.

Projects

These fields display information for the client associated with the project being invoiced. They can be useful where the client associated with the underlying project needs to be displayed separately from other client information available on the invoice.

Project Client Details

Description
Merge Field
Project Client Name
[ProjectClientName]
Project Client ABN
[ProjectClientABN]
Project Client Website
[ProjectClientWebsite]
Project Client Phone
[ProjectClientPhone]
Project Client Fax
[ProjectClientFax]

Project Client Address

Description
Merge Field

Project Client Address Line 1

[ProjectClientAddress1]
Project Client Address Line 2
[ProjectClientAddress2]
Project Client City
[ProjectClientCity]
Project Client State
[ProjectClientState]
Project Client Postcode
[ProjectClientPostcode]

Project Client Financial Information

Description
Merge Field
Project Client Credit Limit

[ProjectClientCreditLimit]

Project Client Credit Days
[ProjectClientCreditDays]

Stock Sales

The following fields display client information when the invoice relates to a Stock Sale.

Stock Sale Client Details

Description
Merge Field

Stock Sale Client Name

[StockSaleClientName]
Stock Sale Client ABN
[StockSaleClientABN]
Stock Sale Client Email
[StockSaleClientEmail]
Stock Sale Client Website
[StockSaleClientWebsite]
Stock Sale Client Phone
[StockSaleClientPhone]
Stock Sale Client Fax
[StockSaleClientFax]

Stock Sale Client Address

Description
Merge Field
Full Stock Sale Client Address
[StockSaleClientAddressBlock]
Stock Sale Client Address Line 1
[StockSaleClientAddress1]
Stock Sale Client Address Line 2
[StockSaleClientAddress2]
Stock Sale Client City
[StockSaleClientCity]
Stock Sale Client State
[StockSaleClientState]
Stock Sale Client Postcode
[StockSaleClientPostcode]

Stock Sale Client Financial Information

Description
Merge Field
Stock Sale Client Credit Limit
[StockSaleClientCreditLimit]
Stock Sale Client Credit Days

[StockSaleClientCreditDays]

Invoice Custom Fields

Custom fields assigned to Invoices can also be included in document templates. Use the Custom prefix followed by the custom field name within the square brackets:

Custom Field Name
Example Merge Field
DeliveryReference
[CustomDeliveryReference]

Custom field availability depends on the transaction type the custom field is assigned to and the document type being generated. For more information, see the Custom Fields Guide.

Troubleshooting

Invoice Fields Are Blank

Any field without a corresponding value may return blank as it is correctly printing nothing. Check that:

  • The source transaction has an asset assigned to it.
  • The required information has been entered against the field in the Asset.

Merge Fields Appear Instead of Values

If fields such as [InvoiceNumber] appears in the generated document instead of their values, check:

  • Merge field spelling
  • Capitalisation
  • Document compatibility
  • That both square brackets are present

Merge fields are case sensitive.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article