Catalog of Email Merge Fields

Using merge fields enables you to customize ReceivablesPro emails so they contain specific information about your company, your sales team, and your customers. With merge fields you can address emails to your customers by name, provide specific information about an individual payment, provide status updates for recurring payment schedules, generate custom signatures for your individual sales representatives, and more.

The following tables provides a full catalog of all the merge fields available for you to use when customizing email templates. To use a merge field, simply copy the code from the “Merge Code” column and paste it into the email template. (See Viewing and Editing Email Templates in Chapter 8 for detailed instructions.)

 

Client Email Merge Fields

Merge Field Name

Merge Code

Description

Company Name

[[Client.Contact.CompanyName]]

Your company name.

Main Contact First Name

[[Client.Contact.Name.FirstName]]

The first name of the Master Administrator User

Main Contact Last Name

[[Client.Contact.Name.LastName]]

The last name of the Master Administrator User.

Contact Address 1

[[Client.Address.AddressLine1]]

The first line of your street address.

Contact Address 2

[[Client.Address.AddressLine2]]

The second line of your street address.

Contact City

[[Client.Address.City]]

The city for your address.

Contact State

[[Client.Address.StateCode]]

The state for your address.

Contact Zip

[[Client.Address.ZipCode]]

The zip for your address.

Contact Country

[[Client.Address.CountryCode]]

The country for your address.

Contact Phone

[[Client.Contact.Phone1]]

Your main phone number.

Contact Alt Phone

[[Client.Contact.Phone2]]

Your alternate phone number.

Contact Email

[[Client.Contact.EMail]]

Your main email address

Contact Alt Email

[[Client.AlternameEmail]]

Your alternate email address

Contact Fax

[[Client.Contact.Fax]]

Your company fax.

WebSite

[[Client.Contact.WebSite]]

Your company website.

Swipe Terms of Sale

[[ClientPaymentOptions.SwipeTermsOfSale]]

The Terms of Sale you configured for swiped credit card transactions. It is included by default on the Card Present Credit Card Payment and Card Present Credit Card Refund receipts.

 

 

Customer Email Merge Fields

Merge Field Name

Merge Code

Description

Customer ID

[[Customer.Id]]

The Customer ID

Customer enter date

[[Customer.MasterData.CreatedOn]]

The date the Customer was added to your system.

First Name

[[Customer.Contact.Name.FirstName]]

Customer First Name

Last Name

[[Customer.Contact.Name.LastName]]

Customer Last Name

Phone

[[Customer.Contact.Phone1]]

Customer main phone.

Alt Phone

[[Customer.Contact.Phone2]]

Customer alt. phone.

Email

[[Customer.Contact.EMail]]

Customer main email.

Alt Email

[[Customer.Contact.AlterEMail]]

Customer alt. email.

Company

[[Customer.Contact.CompanyName]]

Customer company name.

Website

[[Customer.Contact.WebSite]]

Customer website address.

Account #

[[Customer.CustomerAccount]]

The Account # you assign to the customer.

Billing Address 1

[[Customer.BillingAddress.AddressLine1]]

First line of the billing address.

Billing Address 2

[[Customer.BillingAddress.AddressLine2]]

Second line of the billing address.

Billing City

[[Customer.BillingAddress.City]]

Billing city.

Billing State/Province

[[Customer.BillingAddress.StateCode]]

Billing state or province.

Billing Zip/Postal Code

[[Customer.BillingAddress.ZipCode]]

Billing zip or postal code.

Billing Country

[[Customer.BillingAddress.CountryCode]]

Billing country.

Shipping Address 1

[[Customer.ShippingAddress.AddressLine1]]

First line of the shipping address.

Shipping Address 2

[[Customer.ShippingAddress.AddressLine2]]

Second line of the shipping address.

Shipping City

[[Customer.ShippingAddress.City]]

Shipping city.

Shipping State/Province

[[Customer.ShippingAddress.StateCode]]

Shipping state or province.

Shipping Zip/Postal Code

[[Customer.ShippingAddress.ZipCode]]

Shipping zip or postal code.

Shipping Country

[[Customer.ShippingAddress.CountryCode]]

Shipping country.

Shipping Contact First Name

[[PaymentInfo.ShippingContact.Name.FirstName]]

First name of the shipping contact.

Shipping Contact Last Name

[[PaymentInfo.ShippingContact.Name.LastName]]

Last name of the shipping contact.

Shipping Company Name

[[Customer.ShipppingContact.CompanyName]]

Company name for the shipping contact.

Shipping Phone

[[PaymentInfo.ShippingContact.Phone1]]

Shipping phone.

Shipping Email

[[PaymentInfo.ShippingContact.EMail]]

Shipping email.

User ID

[[Customer.UserName]]

The customer’s User ID.

Notes

[[Customer.Notes]]

Any text you enter in the Notes field on the Customer Record.

Sales Rep First Name

[[Customer.ClientUser.Name.FirstName]]

The first name of the User who added the Customer Record.  

NOTE: The Sales Rep fields are useful if you want receipts and notifications to contain contact information for a specific sales rep.

Sales Rep Last Name

[[Customer.ClientUser.Name.LastName]]

The last name of the User who added the Customer Record.

Sales Rep Phone

[[Customer.ClientUser.PhoneNo]]

The phone number of the User who added the Customer Record.

Sales Rep Email

[[Customer.ClientUser.Email]]

The email address of the User who added the Customer Record.

Customer Custom Field Format

[[CustomField.Customer.FieldName]]

Each custom field attached to the Customer Record can be included in emails, using the format shown.

 

Replace “FieldName” with the name of your field. For example, if you have a custom field called “Email List” the merge code would be “[[CustomField.Customer.Email List]]”

 

Payment Email Merge Fields

Merge Field Name

Merge Code

Description

Transaction ID

[[PaymentInfo.Id]]

The Transaction ID

Amount

[[PaymentInfo.Amount]]

The amount of the transaction.

Payment Date

[[PaymentInfo.PaymentDate]]

The transaction date.

Authorization Code

[[PaymentInfo.ProviderAuthCode]]

The authorization code received from the processor.

Batch ID

[[PaymentInfo.BatchId]]

For payments imported via batches, the Batch ID for the import batch.

Schedule ID

[[PaymentInfo.RecurringPaymentId]]

For payments generated by recurring payment schedules, the Schedule ID.

Payment Type

[[PaymentInfo.PaymentType.Code]]

The payment type. This will be either Credit Card or ACH.

Payment Sub-Type

[[PaymentInfo.PaymentSubType.Code]]

The payment sub-type.

For credit card payments this will be MOTO

For ACH payments this will be the ACH Type (TEL, WEB, PPD, CCD)

Bank Name

[[PaymentInfo.BankName]]

The bank name for the payment account.

Bank Account Number

[[PaymentInfo.AccountNo]]

The truncated bank account number for the payment account.

Bank Routing Number

[[PaymentInfo.RoutingNo]]

The bank routing number for the payment account.

Bank Account Type

[[PaymentInfo.IsChecking]]

The bank account type (checking or savings) for the payment account.

Credit Card Type

[[PaymentInfo.CCType]]

The credit card type for the payment account.

Credit Card Number

[[PaymentInfo.CCNumber]]

The truncated credit card number for the payment account.

Credit Card Expiration Date

[[PaymentInfo.CCExpiry]]

The credit card expiration date for the payment account.

Invoice #

[[PaymentInfo.InvoiceNo]]

The invoice number attached to the payment.

PO #

[[PaymentInfo.PONO]]

The purchase order number attached to the payment.

Payment Details

[[PaymentInfo.Narration]]

Any text you enter in the Payment Description field.

Settle Date

[[PaymentInfo.SettledDate]]

The actual or estimated settle date for the transaction.

Status

[[PaymentInfo.Status]]

The transaction status.

Linked Payment ID

[[PaymentInfo.RefPaymentId]]

For refunds pairs, the Linked transaction ID identifies the refunded transaction on the refund receipt or the refund transaction on the original transaction details email.

Payment Custom Field Format

[[CustomField.Payment.FieldName]]

Each custom field attached to the Payment Record can be included in emails, using the format shown.

 

Replace “FieldName” with the name of your field. For example, if you have a custom field called “Color” the merge code would be:

[[CustomField.Payment.Color]]

 

Recurring Payment Email Merge Fields

Merge Field Name

Merge Code

Description

Schedule ID

[[RecurringPayment.Id]]

Recurring payment schedule ID.

Schedule Status

[[RecurringPayment.ScheduleStatus]]

Status of the payment schedule—Active, Expired, Suspended or Paused.

Schedule Type

[[RecurringPayment.ScheduleType]]

Type of schedule—Recurring Billing or Payment Plan.

Schedule Authorization Date

[[RecurringPayment.AuthorizationDate]]

The date the schedule was entered into the ReceivablesPro system.

ACH Schedule Type

[[ACHAuthTypeLine]]

A line indicating how an ACH schedule was authorized-- writing (PPD), telephone (TEL), online (WEB), or as a B2B schedule (CCD).
NOTE: This line will not appear on credit card receipts and notifications, even if it is included in the template.

Payment Amount

[[RecurringPayment.PaymentAmount]]

Scheduled payment amount.

Schedule Start Date

[[RecurringPayment.StartDate]]

Schedule start date.

Schedule End Date

[[RecurringPayment.EndDate]]

Schedule end date—for Recurring Billing only.

Custom First Payment Amount

[[RecurringPayment.FirstPaymentAmount]]

Amount of the custom first payment.

Custom First Payment Date

[[RecurringPayment.FirstPaymentDate]]

Date of the custom first payment.

Schedule Frequency

[[RecurringPayment.BillingFrequency]]

The schedule frequency. (i.e. Weekly—Monday, or Daily)

Next Payment Date

[[RecurringPayment.NextPaymentDate]]

The date of the next scheduled payment.

Payment Type

[[PrimaryAccount.PaymentType]]

The type of payment being used for the schedule—Credit card or ACH.

Payment Sub Type

[[PrimaryAccount.PaymentSubType]]

The payment sub-type for the schedule.

For credit card payments this will be MOTO

For ACH payments this will be the ACH Type (WEB, PPD, CCD)

Bank Account Number

[[PrimaryAccount.AccountNo]]

The bank name for the payment account.

Bank Name

[[PrimaryAccount.BankName]]

The truncated bank account number for the payment account.

Bank Routing Number

[[PrimaryAccount.RoutingNo]]

The bank routing number for the payment account.

Bank Account Type

[[PrimaryAccount.AccountType]]

The bank account type (checking or savings) for the payment account.

Credit Card Type

[[PrimaryAccount.CCType]]

The credit card type for the payment account.

Credit Card Number

[[PrimaryAccount.CreditCardNo]]

The truncated credit card number for the payment account.

Credit Card Expiration Date

[[PrimaryAccount.CCExpiry]]

The credit card expiration date for the payment account.

Invoice #

[[RecurringPayment.InvoiceNo]]

The invoice number attached to the schedule.

PO #

[[RecurringPayment.PO]]

The purchase order number attached to the schedule.

Payment Description

[[RecurringPayment.Description]]

Any text you enter in the Payment Description field.

Plan Amount Left

[[RecurringPayment.TotalAmountRemaining]]

For Payment Plans Only—The total outstanding on the schedule.

Plan Total Due

[[RecurringPayment.TotalDueAmount]]

For Payment Plans Only—The Total Due on the schedule.

Plan Next Payment Amount

[[RecurringPayment.NextPaymentAmount]]

For Payment Plans Only—The amount of the next scheduled payment.

Last Payment Date

[[RecurringPayment.DateOfLastPaymentMade]]

The date of the last payment made on the schedule.

Plan Total Paid

[[RecurringPayment.TotalAmountPaid]]

For Payment Plans Only—The total amount already paid via the schedule.

Plan Number of Payments Made

[[RecurringPayment.NumberOfPaymentMade]]

For Payment Plans Only—The total number of payments already made on the schedule.

Plan Number of Payments Left

[[RecurringPayment.NumberOfPaymentsRemaining]]

For Payment Plans Only—The total number of payments left on the schedule.

Plan Total Number of Payments

[[RecurringPayment.TotalNumberOfPayments]]

For Payment Plans Only—The total number of payments configured for the schedule.

 

 

Invoice Email Merge Fields

Merge Field Name

Merge Code

Description

Invoice Number

[[Invoice.InvoiceNo]]

The invoice number.

Invoice Amount

[[Invoice.InvoiceAmount]]

The invoice total.  
NOTE: This is the “Total Due” for the invoice. It does not take into account any partial payments.

Invoice Due Date

[[Invoice.DueDate]]

The date the invoice is due.

Invoice P.O. Number

[[Invoice.PONo]]

The Purchase Order number entered for the invoice.

Invoice PDF Link

[[Constants.InvoicePdfUrl]]

Adds a link to the invoice that when clicked will open the log-in screen for your Customer Portal.
NOTE: Once you insert this field into the invoice template, you can change the default “click here” text. Do not change the code in the “<a>” tags, or your email will be corrupted.

Invoice Days Overdue

[[Invoice.DaysOverdue]]

The number of days that have passed since the invoice Due Date.