Skip to content

Record Notes

GETPOSTPATCHDELETETable: Record Link

eOne/core/v1.0/notes

Attach a free-text note to almost any record. It writes to Business Central's standard Record Link table as a note (Type = Note), so the note shows up in the Notes factbox on the record and flows to posted documents like any manually added note.

Identify the parent record

Send a parentType (the kind of record) plus one of two keys:

  • integrationId (the eOne external key already stamped on the record)
  • parentNumber (the Business Central number). The integrationId takes precedence if you send both.
For open sales/purchase documents, parentType also carries the document type (e.g. salesOrder vs salesInvoice) so it lands on the right document.

Staged ledger documents and expenses can be noted as well, under stagedLedgerDocument and stagedExpense. Note them by integrationId: these documents have no Business Central number, so parentNumber is their entry no., and the entry no. changes when the document is processed while the integrationId does not.

Write the note

Put the text in note. That plus parentType and a key is all a create needs.

POST/notes

{
  "parentType": "salesOrder",
  "integrationId": "SHOPIFY-1001",
  "note": "Customer asked to hold shipment until 5 Jul."
}

Editable: PATCH the text in place

Unlike attachments (which are immutable), a note is editable. PATCH /notes(<id>) with a new note value overwrites the text of that note in place.

Notes on a staged document follow it into history

Processing a staged document replaces it with a processed document. Its notes move across with its attachments, keeping their own id, so GET /notes(<id>) still returns the text afterwards and reports parentType processedLedgerDocument or processedExpense against the same integrationId. Discarding a staged document deletes its notes, and deleting a processed document, or ageing one out under a retention policy, deletes the notes that came to rest on it.

Reading notes back

GET returns the note text plus the resolved parentType, integrationId, and parentNumber, and the audit fields createdDateTime / createdBy.

Notes are not exposed as an $expand child of the parent record. Business Central stores a note's parent as an internal record reference with no external column to link on, so there is no per-parent server-side filter. parentType / integrationId are resolved per row for display, not queryable with $filter. Fetch a single note by id. This endpoint is primarily for writing notes onto records; to see them, open the record's Notes factbox in Business Central.