Abonos

Validar una nota de crédito

Cierra una nota de crédito en borrador: comprueba el cumplimiento, le asigna un número contra su serie, la firma y la bloquea como inmutable.

POST
/api/v1/credit-notes/{creditNoteId}/validate

Ejemplos de petición

curl https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c/validate \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)"
{
  "data": {
    "id": "credit_note_9f3a2b",
    "creditNoteNumber": "2026-0001",
    "status": "draft",
    "issueDate": "2026-09-01T08:00:00.000Z",
    "currency": "EUR",
    "contactId": "contact_9f3a2b",
    "invoiceId": "invoice_9f3a2b",
    "subTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

Documento fiscal

Esta operación numera el documento contra la serie fiscal, lo firma y lo bloquea. Anular conserva el número.

No reversible

Esta operación no se puede deshacer.

Solo desde draft; desde cualquier otro estado rechaza la petición sin tocar nada. Una nota de crédito validada ya no se edita: se anula. No lleva cuerpo. Comparte scope con las facturas, igual que su lectura. Devuelve la nota de crédito completa, con la misma proyección que su GET.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. invoices: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"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

creditNoteIdstringObligatorio

Identificador de la nota de crédito.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: CreditNoteDto

Sobre: CreditNoteResponse. 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 de crédito: lo que se reembolsa al cliente. El documento fiscal firmado, el desglose de impuestos y las líneas no se publican.

Mostrar atributos hijos
data.idstring

Identificador de la nota de crédito.

data.creditNoteNumberstring | null

Número de la nota de crédito; null mientras es un borrador.

data.statusstring

Estado del ciclo de vida del documento: draft, validated o voided (los mismos valores que admite el filtro status).

Opciones disponibles: draft, validated, voided

data.issueDatestring<date-time> | null

Fecha de emisión en ISO 8601 UTC; null si no consta.

data.currencystring

Moneda, como código ISO 4217.

data.contactIdstring | null

Contacto al que se emite la nota de crédito; null si no consta.

data.invoiceIdstring | null

Factura que rectifica esta nota de crédito; null si no está asociada a ninguna.

data.subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.taxesPricestring

Total de impuestos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.netPricestring

Base imponible, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

data.grossPricestring

Total con impuestos, como cadena decimal.

Límites: patrón ^-?\d+\.\d{2}$

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
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.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
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