API – Change Due Date
Introduction
LoanPro offers users the ability to change the day of the month that a loan's payments come due. This article will explain how to do so using the API. If you'd like to learn more about changing due dates in the UI, read our article on Changing Due Dates.
How To
To change a due date for a loan, send a PUT request to the URL of the loan. This URL is unique to each loan because it contains a specific loan ID. For example, to create a loan funding request for the loan with the ID 702, the URL would be as follows:
PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(702)
Below is the body of the request:
{
"DueDateChanges": {
"results": [
{
"newDate": "2019-12-15",
"changedDate": "2019-12-01"
}
]
}
}
The payload above is all that is required to change a due date. Below is an explanation of the fields:
- DueDateChanges – This is a list of the due date change(s) to be made
- newDate – The date the due date was changed to (YYYY-MM-DD)
- changedDate – The original due date (YYYY-MM-DD)
You can also add a "Charges" section to the payload to add a due date change fee; however, this is not required. Here is what the payload looks like with a charge:
{
"Charges":{
"results":[
{
"chargeTypeId":3,
"chargeApplicationType":"loan.latefeeapp.standard",
"amount":30,
"date":"2015-11-27",
"info":"CTEST FEE"
}
]
},
"DueDateChanges":{
"results":[
{
"originalDate":"2016-12-08",
"newDate":"2016-12-29",
"changedDate":"2016-12-15"
}
]
}
}
- Charges – This object relates to applying a charge(s) for changing the due date
- chargeTypeId – The ID of the charge type (found in tenant settings)
- chargeApplicationType – The type of the charge (see Charge Collection)
- amount – The amount of the charge
- applyDate – The application date of the charge (YYYY-MM-DD)
- info – The info for the charge