Contract merge fields let you pull enrollment contract data, such as tuition amounts, deposit details, and payment plan selections, into email templates and other content in Finalsite Enrollment.
💡Quick Answers
- What key contract merge fields are available? Common fields include {{contact.tuition}} (base tuition), {{contact.balance_due}} (total due with fees), {{contact.deposit_amount_paid}}, and {{contact.deposit_payment_method}}; see Merge Fields / Tokens for the full list.
- How do I format a tuition merge field with a currency sign? Add |format_currency after the field name, for example {{contact.tuition|format_currency}} outputs $18,500.00.
- When do contract merge fields start populating? Fields like {{contact.balance_due}} populate after the contract is generated; fields like {{contact.contract_amount_remaining}} and deposit fields only populate after the contract is submitted.
- Do merge fields update if the contract is regenerated? Yes, regenerating the contract is required to update fields that captured values at generation time.
- Where are billing-specific merge fields documented? Billing merge fields are covered in the Billing Merge Fields article.
How-To: Use Contract Merge Fields
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 contract-related merge fields available to you:
Base Tuition
Displays the base tuition amount, formatted without the currency sign. The base tuition amount is the tuition without any required fees, discounts, scholarships, or aid.
- Merge Field: {{contact.tuition}}
- Example: 18500.00
To format it with the currency sign, use: {{contact.tuition|format_currency}}
With that, the field will populate an amount that looks like this example: $18,500.00
Balance Due
Displays the total tuition amount due with fees, formatted with the currency sign. Please note: This token captures the amount due at the time the contract is generated. If changes are made to the total tuition amount after generating the contract, it will need to be re-generated for this merge field to update accordingly.
- Merge Field: {{contact.balance_due}}
- Example: $6,600.00
Contract Amount Remaining
Displays the total tuition amount due with fees, formatted without the currency sign. Please note: This information will only populate after the contract has been submitted.
- Merge Field: {{contact.contract_amount_remaining}}
- Example: 6600.00
Deposit Amount Paid
Displays amount of the deposit that was paid. This information will only populate after the contract has been submitted with a deposit, OR the deposit checklist item is manually checked off. Formatted with decimal points but no currency sign.
- Merge Field: {{contact.deposit_amount_paid}}
- Example: 1000.00
Deposit Payment Method
- Merge Field: {{contact.deposit_payment_method}}
- Example: Credit Card
Signer 1 Payment Plan / Signer 2 Payment Plan
Displays the canonical name of the payment plan that was selected by each signer. If you are not using the dual signature feature on your contract, you can still use the Signer 1 token. This information will only populate after the contract has been submitted with a payment plan selected.
- Merge Field for Signer 1: {{contact.contract_signer1_payment_plan}}
- Merge Field for Signer 2: {{contact.contract_signer2_payment_plan}}
- Example: 2_payment_plan
Net Tuition
Displays the tuition amount including custom discounts/scholarships but does not include discounts applied through the financial_aid_amount and scholarship_amount fields.
Please note: This token captures the tuition amount at the time the contract is generated. If changes are made to the tuition amount after generating the contract, it will need to be re-generated for this merge field to update accordingly.
- Merge Field: {{contact.net_tuition}}
- Example: $11,000.00
Net Tuition With Aid
Displays the tuition amount after financial aid/ scholarships (including anything discounted from the financial_aid_amount and scholarship_amount fields.)
Please note: This token captures the discounted tuition amount at the time the contract is generated. If changes are made to the tuition amount or financial aid/scholarship amounts after generating the contract, it will need to be re-generated for this merge field to update accordingly.
- Merge Field: {{contact.net_tuition_with_aid}}
- Example: $7,500.00
Contract Submit Date
Displays the date the contract was submitted for the student's current enrollment year. Formatted as MM/DD/YYYY or DD/MM/YYYY, depending on localization settings. This information will only populate after the contract has been submitted.
- Merge Field: {{contact.contract_submit_date}}
- Example: 05/05/2020
Financial Aid Amount
Displays the amount in the term-based field Financial Aid Amount (financial_aid_amount). Formatted with decimal points but no currency sign.
- Merge Field: {{contact.financial_aid_amount}}
- Example: 1000.00
Scholarship Amount
Displays the amount in the term-based field Scholarship Amount (scholarship_amount). Formatted with decimal points but no currency sign.
- Merge Field: {{contact.scholarship_amount}}
- Example: 2500.00
Any custom scholarship amounts can be pulled in using the format of {{contact.[Canonical Name of Field]}}. For example, if your scholarship field has a canonical name of academic_scholarship, you would use the merge field {{contact.academic_scholarship}}.
Comments
0 comments
Article is closed for comments.