API – Amount Past Due Adjustments

Introduction

You can change the amount past due (APD) for a loan either within the UI or through the API. This article explains how to do so with the API.

How To

To change the amount past due, send a PUT request to the URL of the loan. This URL is unique to each loan and contains the loan ID. A loan with the ID of 101, for example, would look like this:

PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(101)
If you don't know a loan ID, see our article on Finding Loan and Customer IDs.

Below is the body of the request:

{
"APDAdjustments": {
"results": [
{
"date": "2015-11-28",
"type": "loan.apd.adjust.type.fixed",
"dollarAmount": "85.00"
}
]
},
"__id": 101,
"__update": true
}

The APDAdjustments object holds the following parameters:

Parameter

Description

date

The date the adjustment will apply

type

The type of the APD adjustment

  • loan.apd.adjust.type.fixed - Adjusts to a fixed amount
  • loan.apd.adjust.type.zero - Adjusts the amount past due to zero

dollarAmount

The dollar amount to be set as past due

Then, the following two parameters are required outside of the APDAdjustments object:

  • __id - this is the ID of the loan
  • __update - set this field to "true" to update the loan


How did we do?


Powered by HelpDocs (opens in a new tab)