API – Escrow Adjustments

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 https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55).

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

{
  "EscrowAdjustments": {
    "results": [
      {
        "date": "2015-11-23",
        "amount": "94.83",
        "subset": 2,
        "period": 23
      }
    ]
  }
}
  • 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 a loan with ID 55, send a PUT request to https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55).

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

{
  "EscrowAdjustments": {
    "results": [
      {
        "date": "2015-11-23",
        "amount": "94.83",
        "subset": 2,
        "period": 23,
"__id":23,
"__update":true
      }
    ]
  }
}
  • __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. For example, to delete an escrow adjustment for a loan with ID 55, send a PUT request to https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(55).

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

{
"EscrowAdjustments": {
"results": [
{
"__id": 23,
"__destroy": true
}
]
}
}
  • __destroy – Set to “true” to delete the escrow transaction


How did we do?


Powered by HelpDocs (opens in a new tab)