API – Escrow Adjustments

Introduction

This article explains how to add, update, and delete escrow adjustments via the API. For more information on using the LMS UI to make Escrow adjustments, check out some of the other articles in our Escrow category.

Adding a New Escrow Adjustment

To add a new escrow adjustment for a loan, send a PUT request to the URL for the loan. For example, to add an escrow adjustment to a loan with ID 55, send a PUT request to

PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55)

Remember to replace "55" with the ID of your loan when trying this for yourself.

The body of the PUT request would be like the following:

{
  "EscrowAdjustments": {
    "results": [
      {
        "date": "2015-11-23",
        "amount": "94.83",
        "subset": 2,
        "period": 23
      }
    ]
  }
}

Here's a breakdown of the parameters used in the body of this request.

  • date – The date the adjustment is made, formatted YYYY-MM-DD
  • amount – The amount of the adjustment
  • subset – The ID of the escrow bucket (set in loan settings for the tenant)
  • period – The period of the escrow adjustment

Updating an Escrow Adjustment

To update an existing escrow adjustment for a loan, send a PUT request to the URL for the loan. For example, to update an escrow adjustment for our same loan example from above, send a PUT request to

 PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55)

The body of the PUT request needs to look like the following:

{
  "EscrowAdjustments": {
    "results": [
      {
        "date": "2015-11-23",
        "amount": "94.83",
        "subset": 2,
        "period": 23,
"__id":23,
"__update":true
      }
    ]
  }
}

The parameters used in the body of this request are as follows:

  • __id – The ID of the escrow adjustment
  • __update – Set to “true” to update the escrow adjustment

Deleting an Escrow Adjustment

To delete an existing escrow adjustment for a loan, send a PUT request to the URL for the loan. Using our same loan example, send a PUT request to

PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55)

The body of the PUT request needs to look like the following:

{
"EscrowAdjustments": {
"results": [
{
"__id": 23,
"__destroy": true
}
]
}
}

In the body of this request, there is a new parameter:

  • __destroy – Set to “true” to delete the escrow transaction


How did we do?


Powered by HelpDocs (opens in a new tab)