Breadcrumbs

API - Record Notes

Overview

The API is used to add Notes on any record in Business Central that has a Notes area:

Endpoint name

recordNotes

Source table

Record Link

Fixed view


Requests allowed

GET, POST

Primary key

N/A

Record ID

SystemId

Procedures

None


Data

Field List

Property

Type

Format

Description


systemId

string 

guid

The unique id of this entry.

Record ID

primary key

recordId

string 

Record Id

Record id is combined as:

[table name] : [the primary key]

mandatory

note

string 


The note to import into BC.

mandatory

fromUser

string 

max 50

To use when the note shall be linked to a specific user.

If left blank, the note is registered on the user of the API.

optional

createdAt

string 

datetime

Time stamp


createdBy

string 

guid

A relation to the API user.



Example Object

Expand to see the example json

An example of one object :

JSON
{
    "@odata.etag": "W/\"JzE5Ozg5MDM3OTI5MjMzOTAxMzk2MzYxOzAwOyc=\"",
    "systemId": "476af7d1-b990-f111-b039-cf528adb1015",
    "recordId": "Customer: 01121212",
    "note": "",
    "fromUser": "BJARTEY",
    "createdAt": "2026-08-05T10:38:40.12Z",
    "createdBy": "008f4691-e13b-4631-99e4-dd9f3f4a5d98"
}


Usage

Read all entries

JSON
GET
.../recordNotes

Read a specific entry

JSON
GET
.../recordNotes(476af7d1-b990-f111-b039-cf528adb1015)


Other ways to add a Note

Selected endpoints have a specific procedure to add a note:

  • Customer

    • Customers([id]).addNote

    • Customers([id]).addNoteFromUser

  • Vendor

    • Vendors([id]).addNote

    • Vendors([id]).addNoteFromUser

  • Item

    • Items([id]).addNote

    • Items([id]).addNoteFromUser

  • Sales Agreement

    • SalesAgreements([id]).addNote

    • SalesAgreements([id]).addNoteFromUser

  • Purchase Agreement

    • PurchaseAgreements([id]).addNote

    • PurchaseAgreements([id]).addNoteFromUser