This request allows you to remove a Schedule Roll configuration on a loan.
General
A schedule roll allows lenders to change payment schedules in separate payment periods. For example, a lender may want to offer 5% interest on the first three periods of a loan, but then 15% for the remainder of the loan. Here's what you need to know about this request:
- Schedule rolls can only be made on accounts that are not activated.
- This request removes a schedule roll configuration entirely and resets a loan to its original loan terms.
For an example of how schedule roll templates work within the UI, take a look at our Roll Schedule Templates article.
Database
- Database – Loan Schedule Roll Entity (loan_schedule_roll_entity)
- Database – Schedule Roll Template (schedule_roll_template_entity)
{
"ScheduleRolls": {
"results": [
{
"__destroy": true,
"__id": 897
}
]
}
}
Try It Instructions
Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. Since this is a request that removes something, this one is a bit different. We can't provide sample information that will work for multiple users. But if you'd like to see a sample of a 200 response, click the response examples located under the Try It button.
To receive a 200 response from the Try It button, you will have to try this request with your own tenant credentials. If you plan on doing so, make sure to change the headers to match your own authentication information.