Doc. Number | Article Title | Effective Date | Version |
FHC-XX | Tags (Debt Settlement) | October 20, 2023 | 0.3 |
This article was developed to describe the use of Tags for Debt Settlement in the Forth system. The following tags are available for the Debt Settlement File Type
ForthPay Tags (Tags used in conjunction with Forth Gateway Processing) | |
{DebtPayGateway} | Debt Settlement Authorization Document Template |
{DPGAUTH_DEBITS} | Debt Settlement Authorization Document Template with the Debit Schedule Included |
{DPG_STULOAN} | Student Loan Authorization Document Template |
{DPG_ONETIME} | One-Time Fee Authorization Document Template |
{DPG_ONETIME_DYN} | One-Time Authorization Document Template that has Dynamic Tags |
{DPG_ONETIME_NEXT} | One-Time Fee Authorization Document Template using Next Payment Tags |
{DPG_RISKRETURN} | Risk Return Letter Document Template |
{DPG_AMENDED} | Amended Document Template |
{DPG_BANKCHANGE} | Bank Change Notice Document Template |
{DPG_ACR} | Account Closure and Balance Refund/Transfer Request |
{DPG_AWR} | Account Withdrawal Request Document Template |
{DPGFEE} | Amount of DPG Fee |
{DPGCOST} | The total amount for DPG fees over the length of the program. |
{DPG_HOLD_REASON} | Populates DPG Hold Reason |
{DPG_HOLD_STATUS} | Populates DPG Hold Status |
{DPG_AMTX} | Amount of DPG payment number "X" |
{DPG_DATEX} | Date of DPG payment number "X" |
{BALANCE} | Displays the Client Balance (Enrollment Details Page) |
Debt Settlement Information | |
{EstPayout} | The estimated total savings required to settle all debts |
{EstSettlement} | The estimated percentage saved per enrolled debt (EX: 40.00%) |
{EstSavings} | The estimated dollar value a client should expect to save on their debt settlement program. |
{MonthlySavings} | The average amount going to savings every month |
{MonthlyDeduction} | The average amount being deducted every month |
{EnrollPeriod} | The time period that enrollment is effective. |
{EnrollPercent} | |
{STATE_ATTORNEY} | Assigned Attorney |
{DEBT_SETTLE_FEE} | Settlement Fee of the Debt chosen when generating a document. |
{CreditorList} | List of Creditors from the Contact's Debts |
{CreditorListEnc} | Same as {CreditorList} but account numbers will be encrypted |
{CreditorListString} | Will populate a string of the creditor names |
{DEBT_VERIFIED_AMOUNT} | Verified dollar amount of the Debt |
{DEBT_VERIFIED_DATE} | Date the Debt was Verified |
{DEBT_ENC_ACCOUNTNUM} | An encrypted debt account number. |
(NUM_ACCOUNTS_SETTLED} | Returns the number of settled debts a contact has. |
{SettlementDollars} | Amount going towards settlement |
{SETTLEMENT_COMMITMENT} | Amount displayed in Sett Commit |
{SETTLEMENT_OFFER_INDIVIDUAL} | * Can be used when generating a document for a specific debt. |
{SETTLEMENT_REPORT} | Displays a table of debts and information regarding the status of a their settlements |
{SETTLEMENT_REPORT_FINAL} | |
{SETTLEMENT_SUMMARY} | * Will work in email templates, and it will display all settlements for that contact. To have it display a single settlement, generate a document, selecting the specific debt, with the tag. |
{TBL_DEBITS_CLEARED} | Displays a table of cleared debits into the account. |
{TBL_FEES_CLEARED} | Displays a table of cleared fees that have left the account. |
{TBL_SETTLEMENTS_CLEARED} | Displays a table of cleared settlement payments that have left the account. |
* To display information a settlement offer's Creditor, Original Debt Amount, Balance at Settlement, Settlement Amount, Debt Reduction %, and Total Savings, use the {SETTLEMENT_SUMMARY} tag. To display the payment schedule for a settlement, use the {SETTLEMENT_OFFER_INDIVIDUAL} tag. To display both sets of information, simply add both tags in the same document. | |
Settlement Offer Tags | |
Replace 'X' with Settlement Offer number, in order as listed under the Debts tab on the Client Dashboard. Ex: {C1_SETTLEMENT_ID} | |
{CX_SETTLEMENT_ID} | Settlement ID |
{CX_SETTLED_DATE} | Settlement Date |
{CX_SETTLED_AMOUNT} | Settlement Amount |
{CX_SETTLEMENT_OFFER_STATUS} | Settlement Offer Status |
Custom Debt Field Tags (NOTE: Your account will have unique Custom Debt Fields that are not listed here. Use the instructions below to find the correct tag format.) | |
The formatting for Custom Debt Fields tags is {DEBTCF_XXX_XXX}. Letters should be capitalized, spaces are replaced with an underscore and special characters are removed. Examples below: | |
{DEBTCF_MONTHLY_SETTLEMENT_PAYMENT} | Monthly Settlement Payment |
{DEBTCF_SETTLEMENT_NOTES} | Settlement Notes |
{DEBTCF_CASE} | Case # |
{DEBTCF_HARDSHIP} | Hardship? |
Article Version History:
Version | Date: | Description |
Basic | 10/03/2018 | Initial Release |
0.1 | 06/01/2022 | Minor Updates only |
0.2 | 04/20/2023 | Added header and version control footer; added definitions to two missing definition rows. |
0.3 | 10/20/2023 | Added one tag and definition for {NUM_ACCOUNTS_SETTLED} |