API – Schedule Roll
This article explains how to add, remove, or otherwise change a schedule roll. For information about Schedule Rolls and what the options do, see Roll Schedule Templates.
Adding New Schedule Line
To add a new schedule line, send a PUT request to the URL of the target loan. This endpoint is unique to each loan, and uses the loan ID. For instance, the URL for loan 667 would look like this:
The body will be formatted as follows:
The term for the new schedule line
The interest rate for the new schedule line
The target of the payment amount to solve for (See API Schedule Roll Collections)
The target payment amount
The target percentage
The payment calculation terms
What to solve for (See API Schedule Roll Collections)
The target balance of the loan
Set to “1” to force a balloon at the end of the term, set to “0” to let the schedule extend until the loan is paid off
Remove Schedule Line
To remove a schedule line, send a PUT request with to the URL of the target loan with a body formatted as follows:
Make sure that “__id” matches the ID of the schedule line to delete.
Please note that only deleting the last schedule line that’s applied is officially supported, the behavior of deleting preceding schedule lines is not guaranteed nor supported.
To perform a schedule round, send a PUT request to the URL of the loan with a body formatted as follows:
Set to “true”
The ID of the Loan Setup entity for the loan
The amount rounded off of the schedule
How do I know what my line or entity ID is?
Just replace the loan ID '667' with your own loan ID.
Reset Schedule Roll
To reset a schedule roll for a loan, send a GET request to the URL formatted below:
Remember to replace the loan ID '667' with the id of your loan.
To use a template, send a PUT request to a URL formatted as follows
Keep in mind that you'll need to replace the loan ID '667' and the template ID '2' with you own loan and template ID's. The template ID options are as follows:
Prorate 1st Payment Long Only
Prorate 1st Payment Short Only
Prorate 1st Payment All
Smooth Payment Advanced
Smooth Payment Basic
Smooth Payment Advanced - No Round
The rest of the options are determined by your tenant settings.