Notas

Escribe una nota en una entidad

Deja un registro en una entidad de la cuenta: por qué se rechazó un pedido, cómo va una reparación.

POST
/api/v1/notes

Ejemplos de petición

curl https://app.filmo.io/api/v1/notes \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "relatedDocumentType": "item",
  "relatedDocumentId": "itm_9f3a2b",
  "subRelatedDocumentType": "serializedItem",
  "subRelatedDocumentId": "ser_00187",
  "subRelatedDocumentCode": "FX6-01",
  "content": "Revisada la montura tras el rodaje; sin holgura."
}'
{
  "data": {
    "id": "note_9f3a2b",
    "content": "Example content",
    "relatedDocumentType": "Example related document type",
    "relatedDocumentId": "related_document_9f3a2b",
    "subRelatedDocumentType": "Example sub related document type",
    "subRelatedDocumentId": "sub_related_document_9f3a2b",
    "subRelatedDocumentCode": "Example sub related document code",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

Con subRelatedDocumentType y subRelatedDocumentId la nota va en una unidad física concreta y no en el artículo entero. mentionedUserIds notifica a esos usuarios de Filmo. Las notas de una entidad se leen con GET /api/v1/notes.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. notes:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

Cuerpo

application/json

Esquema del cuerpo: NoteCreateBody

relatedDocumentTypestringObligatorio

Tipo de la entidad a la que está adjunta la nota.

Opciones disponibles: item, contact, order, space, kit, vehicle, staff, service, collection, project, repairTicket, purchaseOrder, supplierInvoice

relatedDocumentIdstringObligatorio

Identificador de esa entidad.

Límites: longitud mín. 1

contentstringObligatorio

Texto de la nota.

Límites: longitud mín. 1

subRelatedDocumentTypestring

Cuando la nota se refiere a una unidad física concreta del artículo.

Opciones disponibles: serializedItem

subRelatedDocumentIdstring

Identificador de esa unidad física. Requiere subRelatedDocumentType.

subRelatedDocumentCodestring

Código de la unidad, para poder leerlo en la nota sin resolver el id.

mentionedUserIdsstring[]

Usuarios de Filmo a notificar. Cada uno recibe una notificación.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: NoteDto

Sobre: NoteResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Nota asociada a una entidad de la cuenta.

Mostrar atributos hijos
data.idstring

Identificador único de la nota.

data.contentstring

Texto de la nota.

data.relatedDocumentTypestring | null

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

data.relatedDocumentIdstring | null

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

data.subRelatedDocumentTypestring | null

Tipo de la subentidad; null si no aplica.

data.subRelatedDocumentIdstring | null

Identificador de la subentidad; null si no aplica.

data.subRelatedDocumentCodestring | null

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

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

data.updatedAtstring<date-time>

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

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (If-Match) retuvo el recurso durante más de cinco segundos. errors[0].code indica cuál: in_progress y lock_timeout se resuelven reintentando; invalid_state no, porque el estado del recurso prohíbe la operación.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Plataforma

    Nota

    Nota asociada a una entidad de la cuenta.