API – Escrow Transaction

Adding a New Escrow Transaction

To add a new escrow transaction for a loan, send a PUT request to the url for the loan. For example, to add an escrow transaction 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 should be like the following:

{
  "EscrowTransactions": {
    "results": [
      {
        "date": "2015-11-24",
        "amount": "950.00",
        "type": "transaction.type.withdrawal",
        "category": 7,
        "description": "Testing",
        "subset": 2
      }
    ]
  }
}
  • date – The date for the transaction will apply, formatted YYYY-MM-DD
  • amount – The amount of the transaction
  • type – The transaction type (See API Transactions Collection)
  • category – The ID of the transaction category (set in loan settings for the tenant)
  • description – The description of the escrow transaction
  • subset – The ID of the escrow bucket (set in loan settings for the tenant)

Updating an Escrow Transaction

To update an existing escrow transaction for a loan, send a PUT request to the url for the loan. For example, to update an escrow transaction 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:

{
  "EscrowTransactions": {
    "results": [
      {
        "loanId": 346,
        "subset": 2,
        "category": 7,
        "description": "Testing",
        "date": "2015-11-24",
        "type": "transaction.type.withdrawal",
        "amount": "250.00",
        "_timestamp": 0,
        "__id": 31,
        "__update": true
      }
    ]
  }
}

 

  • __id – The id of the escrow transaction
  • __update – Set to “true” to update the escrow transaction

Deleting an Escrow Transaction

To delete an existing escrow transaction for a loan, send a PUT request to the url for the loan. For example, to delete an escrow transaction 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 should be like the following:

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


How did we do?


Powered by HelpDocs (opens in a new tab)