This request edits a charge on a loan.
Click here to learn more about this request
Lenders use charges to include additional amounts to a loan. Charges are most commonly used to deter borrowers from making late payments. Note the following when using this request:
A charge can only be edited one time. Once a charge has been edited, it is inactivated.
Edited charges require an editComment field. This field is used to describe why the edit was made.
Editing a charge is different from reversing a charge. You can reverse a charge with a specific payload, and we've listed that payload in the payload examples.
For an example of how charges work within the UI, take a look at our Charges Overview article on our help site.
Database
For information regarding charges database tables, see the following articles:
Database – Charges Table (charge_entity)
Database – Default Charges (defaults_charges)
Database – Recurring Charge Entity (recurring_charge_entity)
{
"Charges": {
"results": [
{
"displayId": 7332,
"info": "Change Due Date Fee",
"date": "2023-01-01",
"priorcutoff": false,
"amount": 12,
"chargeTypeId": 1,
"paidAmount": 0,
"paidPercent": 0,
"chargeApplicationType": "loan.latefeeapp.standard",
"interestBearing": 1,
"active": 1,
"__update": true,
"__id": 2674,
"editComment": "Clerical Error"
}
]
}
}
{
"Charges": {
"results": [
{
"editComment": "Fee Forgiveness Program",
"active": 0,
"isReversal": 1,
"__update": true,
"__id": 211
}
]
}
}