Invoice with surcharge information template

The invoice with surcharge information template is an example document template. When your veterinary practice must show surcharge information in printed and PDF client invoices, use this template.

The invoice with surcharge information template shows this information:

Invoice number and invoice date
Organization logo
Client and patient information
Invoice line items with product description, staff member, item quantity, and line total
Subtotal, tax, and total value of the invoice
Payment method and balance of the invoice
For unpaid invoices, text about why your veterinary practice uses surcharges, surcharge quantity, and total with surcharge for credit card payment
For paid invoices with surcharge, quantity paid without the surcharge, surcharge quantity paid, total quantity paid, and text about why your veterinary practice uses surcharges

Note: This template is a Twig document example. ezyVet does not install it automatically on new sites.

Invoice output

When you use the invoice with surcharge information template for printed invoices and PDF invoices, ezyVet automatically shows different payment information for:

Unpaid invoice
Paid invoice without a surcharge
Paid invoice with a surcharge

If the invoice is unpaid, the invoice shows:

Text about why your veterinary practice uses surcharges
Note: If the client pays by debit card, cash, or check, ezyVet does not add a surcharge.
Surcharge (surcharge quantity for credit card payment)
Outstanding Total With Surcharge (total with surcharge for credit card payment)

The template calculates the Surcharge and Outstanding Total With Surcharge quantities from the outstanding balance and the configured surcharge percentage. The quantities are estimates and are not always correct. If this information must not show on unpaid invoices, you can remove this section.

Unpaid invoice with surcharge information example output — Figure 1. Example PDF output: Unpaid invoice

If the client paid and ezyVet did not add a surcharge, the invoice shows:

Payment method
Total amount paid

The surcharge information does not show.

Paid invoice without surcharge information example output — Figure 2. Example PDF output: Paid invoice without surcharge information

If the client paid by credit card and ezyVet added a surcharge, the invoice shows:

Payment method
Base amount paid
Surcharge amount paid
Total amount paid
Text about why your veterinary practice uses surcharges

Paid invoice with surcharge information example output — Figure 3. Example PDF output: Paid invoice with surcharge information

Before you use this template

Do these tasks before you use this template:

Contact support for your payment integration (for example, PayJunction or Windcave) so your account can use surcharges.
Use the Twig template system. In the document template configuration, select Use New Templating Engine.
Change surchargePercentage in the template source code to your veterinary practice's surcharge percentage (for example, 0.05).
Important: The surcharge percentage is written directly in the template source code {% set surchargePercentage = 0.03 %}.
Change the text about why your veterinary practice uses surcharges.
Do a check of the surcharge regulations with your payment provider and legal counsel.
Remove or keep the unpaid invoice surcharge information in the template.
Note: The surcharge quantity shown on unpaid invoices is an estimate for credit card payment. ezyVet does not add a surcharge if the client pays by debit card, cash, or check.

Template variables in the source code

This table gives the applicable template variables and their function:


Template variable	Function
`{{ invoice.surchargeAmount }}`	Shows the surcharge quantity.
`{{ invoice.Paid }}`	Shows the total dollar value paid by a client for the invoice.
`{{ invoice.Outstanding }}`	Shows the total outstanding dollar quantity of the invoice.
`{{ invoice.Due }}`	Shows the total value dollar that is due of the invoice. Note: Use the `{{ invoice.Due }}` variable. Do not use `invoice.total - invoice.paid` because it does not include credits.