Go to full article


Event type ID: 22


Overview

This is the event that delivers the invoice via email. It is used when the customer's invoice delivery method is set to Email or Email and Post.

The customer needs an email address either against the Billing Contact or the Primary Contact.

When editing the template, ensure that the checkbox Invoice is ticked under the Attachments sub heading.

Please note that the email attachment size limit is 10MB. Invoice files that exceed this limit will not be sent as an attachment.
If this is likely to happen for your invoices, we recommend that you use the 'Download URL' variable as alternative means of providing your customers with a copy of their invoice.

Licensing

This event is:

  • a standard event for Wholesale and Retail service providers 
  • included with a module or feature
  • a standalone event available upon request (please contact your Account Manager)





Trigger

The event is triggered when an invoice is approved, either manually or automatically.

Action Types

The event supports the following actions. 

  • Message
  • SMS
  • Log
  • On Screen

Template Variables

  • Account ID
  • Account Name
  • Contact First Name
  • Contact Surname
  • Overdue Amount (inc tax)
  • Previous Balance (inc tax)
  • Invoice ID
  • Original Invoice ID
  • Invoice Issue Date
  • Invoice Due Date
  • Account Balance (inc tax)
  • Invoice Amount (ex tax)
  • Invoice Amount (inc tax)
  • BPay Ref
  • BPay Biller Code
  • Cumulus username (this will output the end user portal username)
  • Payments received
  • Export reference
  • PPD Total (prompt payment discount amount inc tax)
  • PPD Ex (prompt payment discount amount ex of tax)
  • PPD Expiry (the prompt payment discount expiry. Equal to the invoice due date)
  • Download URL
  • Trading Name


Legacy Variables

The table below shows the template variables that have both legacy and updated variable tags. The legacy variables remain useable, but amounts will not display two decimal places if the decimal's value ends in a zero or double zero. For example, $2.00 would appear as $2.0 and $5.40 would appear as $5.4. If using the new variable, amounts will display two decimal places for those values ending in zero or double zero.


Variable NameLegacy VariableNew Variable

Account Invoice Balance

{$invoice->accountBalanceIncGst()}

%%invoiceAccountBalanceIncGst%%

Invoice Amount (Excl:GST)

{$invoice->amountExGst()}

%%invoiceAmountExTax%%

Invoice Amount (Incl:GST)

{$invoice->amount()}

%%invoiceAmountIncTax%%

Invoice Due Date

{$invoice->invoiceDue}

%%invoiceDueDate%%

Invoice Id

{$invoice->id}

%%invoiceId%%


Prompt Payment Discount (PPD) Variables

The event will only display the PPD figures for the balance on the current invoice - it will not include PPDs the customer may be eligible for on past invoices, where

  • the balance is carried forward; and
  • the customer is still eligible for PPD on the balance carried forward.

If using PPD, Emersion recommends wording the event template carefully to avoid any confusion by customers.

Download URL

This variable can be used to provide the customer with a link to download their invoice.
This is required in situations where the invoice file is larger than 10MB, which prevents it from being added as an email attachment.

To add a link via the template editor, you can use the 'Insert/Edit Link' button, with '%%download_url%%' as the value for the 'Url' field:

Alternatively, if you are editing HTML directly, the code for the hyperlink would look like this:

<a href="%%download_url%%" target="_blank">Download Invoice</a>


No thresholds apply to this event.


Related Articles

Related Events