Edit Recurring Charges

This request updates a recurring charge on a loan.

   Click here to learn more about this request

Recurring charges are used to automatically incur charges to a loan—often in the form of fees:

• Recurring charges differ slightly from regular charges. Recurring charges are based on loan events and rules. When the criteria for a recurring charge is met, it is added to a loan.
• Recurring charges are a tenant-level setting. These apply to all loans (if desired), and they are created by navigating to Settings > Loan > Charges > Recurring Charges. Since they're a tenant-level configuration, it's not possible to create them via the API.
• This request edits how a recurring charge configuration applies to the loan in question. This request does not edit how the recurring charge configuration applies to the entire tenant.

For an example of how recurring charges work within the UI, take a look at our Recurring Charges 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)

Sample Payload

{
     "RecurrentCharges": {
          "results": [
               {
                    "fixedAmount": "10.00",
                    "status": 1,
                    "__id": 18,
                    "__update": true
               }
          ]
     }
}