Overview

Merge fields, also known as tokens, can be used to pull dynamic information from contacts in SchoolAdmin into various parts of the system. To learn more about the various uses for merge fields, click here.

The merge fields described in this article are specifically for clients using the SchoolAdmin Billing module. For information about Contract Merge Fields that can be used with the Enrollment module, click here.

--

How-To

Merge fields can be added to a template through the Merge Field Picker or by typing/copying them directly into the body of the template. Learn more in our 'How to Pull in Dynamic Information' section here. Below are some of the key billing-related merge fields available to you.

Please note: Some of these merge fields use the Contact category, while others use the Recipient category. These are specified below.

Billing Autopay Enabled

Displays a value of true (yes) or false (no) depending on if autopay is enabled for the parent/guardian's billing account. You will need to use the Recipient category for this merge token, since Autopay is set per billing account, not per student.

  • Merge Field: {{recipient.billing_autopay_enabled}}
  • Example: false

Student Overdue

Displays a value of true (yes) or false (no) depending on if the student (contact) is currently overdue.

  • Merge Field: {{contact.billing_contact_overdue}}
  • Example: true

Account Overdue

Displays a value of true (yes) or false (no) depending on if the billing account is currently overdue.

  • Merge Field: {{recipient.billing_overdue}}
  • Example: true

Account Overdue Date

Displays the date as of which the billing account is overdue. Formatted as MM/DD/YYYY or DD/MM/YYYY, depending on localization settings.

  • Merge Field: {{recipient.billing_overdue_at}}
  • Example: 05/01/2020

Billing Payment Method

Displays the billing payment method on file (for autopay only).

  • Merge Field: {{recipient.billing_payment_method}}
  • Example: Credit Card

Current Account Balance

Displays the current remaining balance for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.current_account_balance}}
  • Example: 8100.00

Current Student Balance

Displays the current remaining balance for the student (contact). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.current_contact_balance}}
  • Example: 8100.00

Next Account Balance

Displays the next balance due for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.next_account_balance}}
  • Example: 8100.00

Next Student Balance

Displays the next balance due for the student (contact). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.next_contact_balance}}
  • Example: 8100.00

Next Account Billing Date

Displays the next billing date for the billing account. Formatted as MM/DD/YYYY or DD/MM/YYYY, depending on localization settings.

  • Merge Field: {{recipient.next_account_billing_date}}
  • Example: 06/01/2020

Total Account Balance

Displays the total balance due for the billing account. Formatted with decimal points but no currency sign.

  • Merge Field: {{recipient.total_account_balance}}
  • Example: 8100.00

Total Student Balance

Displays the total balance due for the contact (student). Formatted with decimal points but no currency sign.

  • Merge Field: {{contact.total_contact_balance}}
  • Example: 8100.00

--

Related Articles

Did this answer your question?