API – Promises

General

Creating a promise is done through the API by sending a PUT request to the loan for which you wish to create the promise.

To create a promise for a loan, you will need to send a PUT request to the URL of the desired loan. For example, to create a promise for the loan with the id 515, the url would be https://loanpro.simnang.com/api/public/api/1/odata.svc/Loans(515).

Request Body

{
  "Promises": {
    "results": [
      {
        "dueDate": "2015-11-17",
        "fulfilled": 0,
        "amount": 0,
        "fulfillmentDate": null,
        "subject": "test",
        "type": "loanpromise.type.other",
        "note": "<p>test</p>"
      }
    ]
  }
}
  • dueDate – The date the promise is due, format is YYYY-MM-DD
  • fulfilled – Whether or not the promise has been fulfilled
  • amount – The promised payment amount; used only for payment promises
  • fulfillmentDate – The date the promise was fulfilled, format is YYYY-MM-DD
  • subject – Subject line of the promise
  • type – Type of the promise. See Promise Collection.
  • note – Promises description


How did we do?


Powered by HelpDocs (opens in a new tab)