Add New Schedule Line

This request allows you to add a Schedule RollSchedule Roll - A customized payment schedule where payment periods, or groups of payment periods, can have different payment accounts and interest rates. to 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 activatedactivated - Activating an account will cause the calculations on the loan to take into account actual dates and payment history. An account that hasn’t been activated exists in an abstract piece of time with no sense of past or future..
  • The loan will likely not be at the exact principal balance you enter, but it will be close. This is due, in part, to the necessity of dealing with dollars and cents (2 decimal places) for final calculated numbers.

For an example of how schedule rolls work within the UI, take a look at our Create a Schedule Roll article.

Database

For information on schedule roll database tables, see the following articles:

{
    "ScheduleRolls": {
        "results": [
            {
                "term": 3,
                "rate": "5",
                "solveUsing": "loan.rollScheduleSolve.dollar",
                "amount": "150.00",
                "percent": 0,
                "advancedTerms": 0,
                "solveFor": "loan.rollScheduleSolveFor.payment",
                "balance": 0,
                "forceBalloon": 0
            }
        ]
    }
}

📘

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. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.

Language
Authentication
Click Try It! to start a request and see the response here!