Abonos

Anular una nota de crédito

Anula una nota de crédito VALIDADA con un motivo, que es obligatorio y se conserva.

POST

/api/v1/credit-notes/{creditNoteId}/void

curl https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c/void \
  --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 '{
  "reason": "Importe rectificado incorrecto; se emite una nueva"
}'

Node.jsfetch('https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c/void', { method: 'POST', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ reason: 'Importe rectificado incorrecto; se emite una nueva' }) })Pythonimport uuid import requests requests.post( "https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c/void", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "reason": "Importe rectificado incorrecto; se emite una nueva" } )

{
  "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"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "invoices:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generado a partir del esquema

No reversible

Anular lleva el documento a voided y ninguna operación lo deshace.

Conserva su número y pasa a voided. Solo desde validated: un borrador se elimina desde la aplicación, no se anula. No toca la factura que corregía. Devuelve la nota de crédito completa, 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

Cuerpo

application/json

Esquema del cuerpo: CreditNoteVoidBody

reasonstringObligatorio

Motivo de la anulación. Se guarda en la nota de crédito y en su historial.

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

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.

meta.warnings.linkstring

Dónde está documentada la deprecación (el changelog).

Errores

Estado	Códigos	Significado
400	`validation_error`	Consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable.
404	`not_found`	No existe o queda fuera del alcance de la clave de API.
409	`conflict`	El 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.
412	`precondition_failed`	La etiqueta de entidad `If-Match` no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422	`idempotency_key_reused`	La 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

Finanzas
Nota de crédito
Nota de crédito: lo que se reembolsa al cliente.

¿Te ha resultado útil esta página?

Ejemplos de petición

Autorizaciones

Cabeceras

Parámetros de ruta

Cuerpo

Respuesta

Errores

Obsolescencia

Relacionado

Páginas relacionadas

Nota de crédito