Plataforma

Nota

Nota asociada a una entidad de la cuenta.

Esquemas: 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"
}

Generado a partir del esquema

Una nota adjunta a una entidad de la cuenta. Una nota siempre se lee para una entidad: GET /api/v1/notes requiere el tipo y el identificador de la entidad, y no existe una lista de todas las notas. No se publica quién escribió la nota.

Atributos

idstring

Identificador único de la nota.

contentstring

Texto de la nota.

relatedDocumentTypestring | null

Tipo de la entidad a la que está adjunta la nota; null si no está adjunta.

relatedDocumentIdstring | null

Identificador de esa entidad; null si la nota no está asociada.

subRelatedDocumentTypestring | null

Tipo de la subentidad; null si no aplica.

subRelatedDocumentIdstring | null

Identificador de la subentidad; null si no aplica.

subRelatedDocumentCodestring | null

Código legible de la subentidad; null si no aplica.

createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

Lo devuelven

GET /api/v1/notes — Listar las notas de una entidad

Lo modifican

POST /api/v1/notes — Escribe una nota en una entidad

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Lo devuelven

Lo modifican