API – Creating Notes

Introduction

This article explains how to use the API to create notes for both loans and customers. To do so with the API, you will need to send a PUT request to the URL of the desired loan/customer.

For example, creating a note for the loan with the id 515 would use the following URL:

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

You can also try this request yourself on our ReadMe page—an interactive API documentation page which lists each of our requests.

To create a note for a customer, use this endpoint:

PUT https://loanpro.simnang.com/api/public/api/1/odata.svc/Customers(1137)

You can also try this request yourself on our ReadMe page—an interactive API documentation page which lists each of our requests.

Request Body

{
"Notes": {
"results": [
{
"body": "This is a sample note.",
"categoryId": 27,
"subject": "Testing",
"authorId": 10,
"type": "NOTICE",
"expirationDate:" "2022-01-01"
}
]
}
}

Here's a breakdown of each field:

  • body – The HTML for the note content.
  • categoryId – The ID of the note category.
  • subject – The subject line of the note.
  • type – This can be either STANDARD or NOTICE. STANDARD just logs a note on the loan; NOTICE becomes a notice that pops up when the loan is opened and must be clicked through.
  • authorId – This is the ID of the agent user. However, this isn't required.
  • expirationDate – This is only used for NOTICE type notes. This is the date that the notice will no longer appear on the loan. If you plan on using this value, you will need to use the type value as well.
The categoryId must be a valid one. See Create New Loan Note Category for help regarding note categories.


How did we do?


Powered by HelpDocs (opens in a new tab)