Twig template variables: Payments
The payment variables show data of a payment (for example, the quantity, the payment method and the department). Each variable starts with payment.
Variables
| Name | Classic template system equivalent? | Function |
|---|---|---|
{{ payment.Amount }} | {PaymentAmount} | Shows the quantity paid of the payment. |
{{ payment.ClientContact.BalanceAt }} | {PaymentOutstandingBalance} | Shows the client's outstanding balance of the payment. |
{{ payment.ClientContact.Code }} | {ContactCode} | Shows the code of the client. |
{{ payment.ClientContact.Name }} | {ContactName} | Shows the name of the client. Note: This variable uses the format Title Last name, First name. |
{{ payment.Comments }} | {PaymentComment} | Shows the comments of the payment. |
{{ payment.Date }} | {PaymentDate} | Shows the date of the payment. |
{{ payment.Number }} | {PaymentNumber} | Shows the number of the payment. |
{{ payment.PaymentMethod }} | {PaymentMethod} | Shows the payment method of the payment. |
{{ payment.department.Name }} | No | Shows the name of the department. Note: This variable shows:
|
{{ payment.department.CompanyNumber }} | No | Shows the Australian business number of the department. |
{{ payment.department.PhysicalAddressText }} | No | Shows the full address of the department. Note: If your organization uses a single-site configuration, the template variable shows the address of your organization. |
{{ payment.department.PhysicalAddress.Street1 }} | No | Shows the first line of the physical address of the department. |
{{ payment.department.PhysicalAddress.Street2 }} | No | Shows the second line of the physical address of the department. |
{{ payment.department.PhysicalAddress.Suburb }} | No | Shows the suburb of the department. |
{{ payment.department.PhysicalAddress.City }} | No | Shows the city of the department. |
{{ payment.department.PhysicalAddress.Region }} | No | Shows the region of the department. Note: You cannot use this variable in a template at this time. A template that uses this variable shows an error message, and ezyVet does not show the document. |
{{ payment.department.PhysicalAddress.State }} | No | Shows the state of the department. |
{{ payment.department.PhysicalAddress.Country }} | No | Shows the country of the department. |
{{ payment.department.PhysicalAddress.Postcode }} | No | Shows the postcode of the department. Note: If your organization uses a single-site configuration, the template variable shows the postcode of your organization. |
{{ payment.department.Emailaddress }} | No | Shows the email address of the department. |
{{ payment.department.PhoneNumber }} | No | Shows the phone number of the department. |
{{ payment.department.FaxNumber }} | No | Shows the fax number of the department. |
{{ payment.department.Website }} | No | Shows the website address of the department. |
{{ payment.department.BankAccountNumber }} | No | Shows the bank account number of the department. |
{{ payment.department.PaymentReference }} | No | Shows the payment reference of the department. |
{{ payment.department.TaxNumber }} | No | Shows the tax number of the department. |
{{ payment.Details }} | {PaymentDetails} | Shows the content of the Details box of the payment. |
{{ payment.getSurchargeAmount }} | {PaymentSurchargeAmount} | Shows the surcharge value of the payment. Note: This template variable is only applicable to payment integrations. Before you can use the template variable, a practice manager must:
|
{{ payment.AmountTendered }} | No | Shows the cash quantity that the client gave. |
{{ payment.Change }} | No | Shows the change quantity that the veterinary practice gave to the client. |
{{ payment.RoundedAmount }} | No | Shows the payment quantity after cash rounding. Note: ezyVet calculates the payment quantity as the cash quantity that the client gave, minus the change. |
{{ payment.SurchargeRate }} | No | Shows the surcharge rate of the payment method of the payment, for example 3.5%. Note: If the payment method has no surcharge, this variable shows no value. |
{{ payment.SurchargeType }} | No | Shows the type of the surcharge of the payment method. The possible values are:
|