Template Variables
Template variables allow you to personalize communications by automatically inserting account, debtor, and company information into your messages. Variables are replaced with actual data when the communication is sent.
Using Variables
Variables are inserted using double curly braces: {{variable_name}}
Example: "Dear {{debtor_first_name}}," becomes "Dear John,"
Variable Syntax
- Variables use double curly braces:
{{variable_name}} - Variables are case-sensitive
- Use exact variable names as documented below
- Missing data results in blank replacement
- Array notation is supported for multiple items:
{{debtor_phones[0]_number}}
Account Variables
| Variable | Description |
|---|---|
{{account_file_number}} | Internal file number |
{{account_number}} | Original account number |
{{account_creditor}} | Creditor name |
{{account_current_balance}} | Current balance owed |
{{account_original_balance}} | Original debt amount |
{{account_principal}} | Principal amount |
{{account_charged_off_principal}} | Charged off principal |
{{account_accrued_interest}} | Accumulated interest |
{{account_interest_percentage}} | Interest rate percentage |
{{account_imported_balance}} | Balance at import |
{{account_paid_to_date}} | Total payments received |
{{account_last_payment_amount}} | Amount of last payment |
{{account_last_payment_date}} | Date of last payment |
{{account_date_opened}} | Date account opened |
{{account_date_charged_off}} | Date account charged off |
{{account_type_of_debt}} | Type of account/debt |
{{account_uuid}} | Account unique identifier |
Debtor Variables
Basic Information
| Variable | Description |
|---|---|
{{debtor_full_name}} | Full debtor name |
{{debtor_first_name}} | First name |
{{debtor_middle_name}} | Middle name |
{{debtor_last_name}} | Last name |
{{debtor_title}} | Title (Mr., Mrs., etc.) |
{{debtor_birth_date}} | Date of birth |
{{debtor_email}} | Email address |
{{debtor_primary_phone}} | Primary phone number |
{{debtor_job_title}} | Job title |
{{debtor_social_security_number}} | Full SSN |
{{debtor_social_security_number_masked}} | Masked SSN (last 4 visible) |
Address Information
| Variable | Description |
|---|---|
{{debtor_address}} | Street address |
{{debtor_address2}} | Address line 2 |
{{debtor_city}} | City |
{{debtor_state}} | State |
{{debtor_zip}} | ZIP code |
Additional Addresses (Array)
For accounts with multiple addresses, use array notation with index [0], [1], etc.:
| Variable | Description |
|---|---|
{{debtor_addresses[0]_address}} | Street address |
{{debtor_addresses[0]_address2}} | Address line 2 |
{{debtor_addresses[0]_city}} | City |
{{debtor_addresses[0]_state}} | State |
{{debtor_addresses[0]_zip}} | ZIP code |
{{debtor_addresses[0]_type}} | Address type |
{{debtor_addresses[0]_source}} | Address source |
Phone Numbers (Array)
| Variable | Description |
|---|---|
{{debtor_phones[0]_number}} | Phone number |
{{debtor_phones[0]_type}} | Phone type (home, mobile, work) |
{{debtor_phones[0]_description}} | Description |
{{debtor_phones[0]_source}} | Phone source |
Employer Information
| Variable | Description |
|---|---|
{{debtor_employer_name}} | Employer name |
{{debtor_employer_address}} | Employer street address |
{{debtor_employer_address2}} | Employer address line 2 |
{{debtor_employer_city}} | Employer city |
{{debtor_employer_state}} | Employer state |
{{debtor_employer_zip}} | Employer ZIP code |
{{debtor_employer_primary_phone}} | Employer phone |
{{debtor_employer_secondary_phone}} | Employer secondary phone |
{{debtor_employer_email}} | Employer email |
References (Array)
| Variable | Description |
|---|---|
{{debtor_references[0]_full_name}} | Reference full name |
{{debtor_references[0]_first_name}} | Reference first name |
{{debtor_references[0]_middle_name}} | Reference middle name |
{{debtor_references[0]_last_name}} | Reference last name |
{{debtor_references[0]_title}} | Reference title |
{{debtor_references[0]_phone}} | Reference phone |
{{debtor_references[0]_type}} | Reference type |
{{debtor_references[0]_source}} | Reference source |
Bankruptcy Information
| Variable | Description |
|---|---|
{{debtor_is_bankrupt}} | Bankruptcy status (true/false) |
{{debtor_bankruptcy_case_number}} | Case number |
{{debtor_bankruptcy_chapter}} | Bankruptcy chapter |
{{debtor_bankruptcy_filing_date}} | Filing date |
{{debtor_bankruptcy_hearing_date}} | Hearing date |
{{debtor_bankruptcy_discharged_date}} | Discharge date |
{{debtor_bankruptcy_dismissed_date}} | Dismissal date |
{{debtor_bankruptcy_closed_date}} | Case closed date |
{{debtor_bankruptcy_disposition}} | Disposition |
{{debtor_bankruptcy_proof_of_claim_date}} | Proof of claim date |
{{debtor_bankruptcy_judge_name}} | Judge name |
{{debtor_bankruptcy_judge_initials}} | Judge initials |
Deceased Information
| Variable | Description |
|---|---|
{{debtor_is_deceased}} | Deceased status (true/false) |
{{debtor_deceased_date}} | Date of death |
Co-Debtor Variables
Use array notation for co-debtors. Replace [0] with the co-debtor index:
| Variable | Description |
|---|---|
{{co_debtor[0]_full_name}} | Co-debtor full name |
{{co_debtor[0]_first_name}} | Co-debtor first name |
{{co_debtor[0]_middle_name}} | Co-debtor middle name |
{{co_debtor[0]_last_name}} | Co-debtor last name |
{{co_debtor[0]_title}} | Co-debtor title |
{{co_debtor[0]_primary_phone}} | Co-debtor phone |
{{co_debtor[0]_social_security_number}} | Co-debtor SSN |
{{co_debtor[0]_social_security_number_masked}} | Co-debtor masked SSN |
Company Variables
| Variable | Description |
|---|---|
{{company_name}} | Company name |
{{company_address}} | Company street address |
{{company_address2}} | Company address line 2 |
{{company_city}} | Company city |
{{company_state}} | Company state |
{{company_zip}} | Company ZIP code |
{{company_phone_number}} | Company phone |
{{company_email}} | Company email |
{{company_website}} | Company website |
{{company_working_days}} | Business days |
{{company_working_hours}} | Business hours |
{{company_working_hours_from}} | Hours start time |
{{company_working_hours_to}} | Hours end time |
Collector Variables
| Variable | Description |
|---|---|
{{collector_name}} | Assigned collector name |
{{collector_email}} | Collector email |
Payment Variables
Last Posted Payment
| Variable | Description |
|---|---|
{{last_posted_payment_amount}} | Amount of last posted payment |
{{last_posted_payment_date}} | Date of last posted payment |
{{last_posted_payment_authorization_code}} | Authorization code |
Last Declined Payment
| Variable | Description |
|---|---|
{{last_declined_payment_amount}} | Amount of declined payment |
{{last_declined_payment_date}} | Date of declined payment |
Next Scheduled Payment
| Variable | Description |
|---|---|
{{next_scheduled_payment_amount}} | Next payment amount |
{{next_scheduled_payment_date}} | Next payment date |
{{next_scheduled_payment_authorization_code}} | Authorization code |
Payment Method Variables
| Variable | Description |
|---|---|
{{payment_method_card_last4}} | Last 4 digits of card |
{{payment_method_card_expiration}} | Card expiration date |
{{payment_method_billing_address}} | Billing address |
{{payment_method_billing_city}} | Billing city |
{{payment_method_billing_state}} | Billing state |
{{payment_method_billing_zip}} | Billing ZIP code |
Payment Plan Variables
| Variable | Description |
|---|---|
{{payment_plan_total_amount}} | Total plan amount |
{{payment_plan_start_date}} | Plan start date |
{{payment_plan_end_date}} | Expected completion date |
{{payment_plan_first_installment_date}} | First payment date |
{{payment_plan_first_payment_amount}} | First payment amount |
{{payment_plan_installment_amount}} | Regular installment amount |
{{payment_plan_final_payment_amount}} | Final payment amount |
{{payment_plan_frequency}} | Payment frequency code |
{{payment_plan_frequency_text}} | Payment frequency (e.g., "Monthly") |
{{payment_plan_number_of_payments}} | Total number of payments |
{{payment_plan_number_of_installments}} | Total installments |
{{payment_plan_number_of_payments_remaining}} | Remaining payments |
{{payment_plan_payments}} | Formatted payment schedule |
Settlement Variables
| Variable | Description |
|---|---|
{{settlement_amount}} | Settlement offer amount |
{{settlement_date_due}} | Settlement due date |
Other Variables
| Variable | Description |
|---|---|
{{current_date}} | Today's date |
{{payment_portal_url}} | Payment portal link |
Best Practices
Testing Variables
- Preview Mode: Always preview templates before sending
- Test Data: Use sample accounts with complete data
- Edge Cases: Test with accounts missing optional data
Variable Selection
- Use Specific Variables: Choose the most specific variable available
- Check Data Availability: Ensure required data fields are populated
- Array Indices: Remember arrays are zero-indexed (
[0]is the first item)
Compliance Considerations
- PII Protection: Limit use of sensitive data like SSN
- Accuracy: Only use variables with verified data
- Required Fields: Ensure compliance language is static, not variable-based
Troubleshooting
Variable Not Replacing
Symptoms: Variable name appears in sent communication
Solutions:
- Verify exact variable name spelling
- Check that data exists for the account
- Confirm proper double-brace syntax
- Ensure variable name matches exactly (case-sensitive)
Blank Output
Symptoms: Variable replaced with nothing
Causes:
- Data field is empty for the account
- Variable references non-existent field
- Array index out of bounds
Solutions:
- Populate required data fields
- Verify the variable name is correct
- Check array indices (start at 0)
Related Documentation
- Email Templates - Creating and managing email templates
- Text Templates - SMS template management
- Document Templates - Document template management