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)

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

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

Request Body

{
  "Notes":{
    "results": [
      {
        "body":"<p>Sample Note 2</p>",
        "categoryId": 27,
        "parentId": 370,
        "parentType": "Entity.Loan",
        "subject": "Testing",
"authorId": 10
      }
    ]
  }
}

Here's a breakdown of each field:

  • body – The HTML for the note content
  • categoryId – The ID of the note category
  • parentId – The ID of the LoanPro entity that the note is attached to (loan or customer)
  • parentType – The type of the entity that the note will be attached to
    • Entity.Loan for loans
    • Entity.Customer for customers
  • 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.
  • expirationDate – This is only used for NOTICE type notes. This is the date on which the notice will no longer appear on the loan.
The categoryId must be a valid one. See Create New Loan Note Category for help regarding note categories.
What is StackBlitz?
Many of our article use StackBlitz examples like this. These examples are like a window into a REST client right here in your browser. The window is divided into two sides. Developers can use info in the editor on the left side when configuring your API integration, and the right side shows a preview of a REST client. Click 'Preview' on the bottom, and you'll only see the REST client. The entire request is set up and connected to a demo API tenant in LMS. Just scroll down and click 'send' and you should get a 200 response. If you want to get some practice with error codes, try editing the endpoint, headers, method and payload to see what responses you get.


How did we do?


Powered by HelpDocs (opens in a new tab)