Debt Settlement Letters
A debt settlement letter is a formal written communication between a debtor (the person or entity that owes money) and a creditor (the person or entity to whom money is owed) in which the debtor proposes a negotiated settlement to resolve an outstanding debt for less than the full amount owed.
API Upload
The
type
parameter isndr
for the upload endpoint.
Field Descriptions:
The model automatically detects data such as:
Session Name | Field Name | Data Type | Description |
---|---|---|---|
Basic Information | Customer Name | String | Name of the customer. |
Basic Information | Current Balance | Number | Current balance of the account. |
Basic Information | Settlement Amount | Number | Settlement amount for the account. |
Account Number | Original Account Number | String | Original account number. |
Account Number | Reference Number | String | Reference number associated with the account. |
Account Number | DS ID Number | String | DS ID number for the account. |
Creditor | Original Creditor Name | String | Original creditor's name. |
Creditor | Current Creditor | String | Current creditor's name. |
Creditor | Collection Agency | String | Name of the collection agency. |
Creditor | Phone Number | String | Phone number of the creditor or collection agency. |
Creditor | Online Payment URL | String | URL for online payments to the creditor. |
Creditor Payment Address | Address | String | Payment address of the creditor or collection agency. |
Creditor Payment Address | Address_Line_1 | String | Address line 1 of the payment address. |
Creditor Payment Address | Address_Line_2 | String | Address line 2 of the payment address. |
Creditor Payment Address | City | String | City of the payment address. |
Creditor Payment Address | State | String | State of the payment address. |
Creditor Payment Address | ZipCode | String | Zip code of the payment address. |
Payment Detail | First Payment Due Date | Date | Due date for the first payment. |
Payment Detail | Final Payment Due Date | Date | Due date for the final payment. |
Payment Detail | Total Payments Term | Number | Total number of payment terms. |
Error | Error Message | String | Error message, if any. |
Payment Table | Line Item | Table | Table of payment line items |
Date | Date | Date of the payment. | |
Amount | Number | Amount of the payment. | |
No of Terms | Number | Number of terms for the payment. | |
From Date | Date | Starting date for the payment term. | |
To Date | Date | Ending date for the payment term. |
Version
- 2.0.0
Sample
Sample JSON Output
{
"data": {
"Basic Information": {
"Customer Name": {
"value": "",
"position": [],
"confidence": 1.0,
"review_required": false
},
"Current Balance": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Settlement Amount": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
},
"Account Number": {
"Original Account Number": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Reference Number": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"DS ID Number": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
},
"Creditor": {
"Original Creditor Name": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Current Creditor": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Collection Agency": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Phone Number": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Online Payment URL": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
},
"Creditor Payment Address": {
"Address": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Address_Line_1": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Address_Line_2": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"City": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"State": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"ZipCode": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
},
"Payment Detail": {
"First Payment Due Date": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Final Payment Due Date": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Total Payments Term": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
},
"Error": {
"Error Message": {
"value": "",
"position": [],
"confidence": 1.0,
"review_required": false
}
},
"Payment Table": {
"Line Item": [
{
"Date": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"Amount": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"No of Terms": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"From Date": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
},
"To Date": {
"value": "",
"position": [],
"confidence": 0,
"review_required": true
}
}
]
}
}
}
Updated about 1 year ago