Add System Note

General

The system logs notes on the actions taken by your users. Here's what you need to know about this system notes:

• System notes are used to view changes to settings and entities within your account. This part of the software tracks creations, updates, and deletions made to the settings, loans, customers, source companies, and defaults of your company.
• This request will manually create a system note. It does not complete the action that the note is describing, however. As such, caution should be taken when manually adding system notes since it could create confusion when auditing the actions taken on loans.
• System notes cannot be manually made within the UI—only the API.
• When manually logging a system note, System will be logged as the user and 0.0.0.0 will be logged as the IP address.

For an example of how system notes work within the UI, take a look at our Global System Notes and System Notes History Changes articles.

Database

For information on system note database tables, see the following article:

• Database – System Notes Entity (system_note_entity)

{
     "entityType": "Entity.Loan",
     "entityId": 9118,
     "referenceType": "Entity.Collateral",
     "referenceId": 897,
     "operationType": "UPDATE",
     "operationSubType": "systemNote.operationSubtype.crud",
     "noteTitle": "This global system note was made via the API.",
     "noteData": "{\"d\":{\"newValue\":\"Sport\",\"oldValue\":\"Base\"}}"
}

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—hit Try It to send the request.

However, if you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.