Platform

Note

Note attached to an entity of the account.

Schemas: NoteDto

{
  "id": "id_8f2a1c",
  "content": "string",
  "relatedDocumentType": "string",
  "relatedDocumentId": "string",
  "subRelatedDocumentType": "string",
  "subRelatedDocumentId": "string",
  "subRelatedDocumentCode": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A note attached to an entity of the account. A note is always read for one entity: GET /api/v1/notes requires the type and the identifier of the entity, and there is no list of all notes. Who wrote the note is not published.

Attributes

idstring

Unique identifier of the note.

contentstring

Note text.

relatedDocumentTypestring | null

Type of the entity the note is attached to; null if it is not attached.

relatedDocumentIdstring | null

Identifier of that entity; null if the note is not attached.

subRelatedDocumentTypestring | null

Type of the sub-entity; null if not applicable.

subRelatedDocumentIdstring | null

Identifier of the sub-entity; null if not applicable.

subRelatedDocumentCodestring | null

Human-readable code of the sub-entity; null if not applicable.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

Returned by

GET /api/v1/notes — List the notes of an entity

Modified by

POST /api/v1/notes — Write a note on an entity

Was this page helpful?

Example

Attributes

Returned by

Modified by