Abonos
Obtener una nota de crédito
Devuelve una nota de crédito por su identificador: qué se reembolsa al cliente y contra qué factura, la misma ficha que GET /api.
Ejemplos de petición
curl https://app.filmo.io/api/v1/credit-notes/cred_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generado a partir del esquema
El documento fiscal firmado, el desglose de impuestos, las líneas y el motivo de la corrección no se publican.
Autorizaciones
Clave de API como Bearer, con el permiso de abajo. invoices:read
Cabeceras
Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.
Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Parámetros de ruta
Identificador de la nota de crédito.
Límites: longitud mín. 1
Respuesta
Respuesta correcta.
Esquema de la respuesta: CreditNoteDto
Sobre: CreditNoteResponse. meta. solo aparece cuando la operación está obsoleta.
Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
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 hijosOcultar atributos hijos
Identificador de la nota de crédito.
Número de la nota de crédito; null mientras es un borrador.
Estado del ciclo de vida del documento: draft, validated o voided (los mismos valores que admite el filtro status).
Opciones disponibles: draft, validated, voided
Fecha de emisión en ISO 8601 UTC; null si no consta.
Moneda, como código ISO 4217.
Contacto al que se emite la nota de crédito; null si no consta.
Factura que rectifica esta nota de crédito; null si no está asociada a ninguna.
Subtotal antes de descuentos e impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total de impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Base imponible, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Total con impuestos, como cadena decimal.
Límites: patrón ^-?\d+\.\d{2}$
Fecha de creación en ISO 8601 UTC.
Fecha de la última modificación en ISO 8601 UTC.
Información adicional sobre la respuesta.
Mostrar atributos hijosOcultar atributos hijos
Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.
Mostrar atributos hijosOcultar atributos hijos
Código de aviso estable.
Opciones disponibles: deprecated
Para personas: qué está obsoleto, hasta cuándo y qué usar.
Día (YYYY-MM-DD) en que la operación deja de estar disponible.
operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.
Dónde está documentada la deprecación (el changelog).
No modificado: el If-None-Match enviado coincide con el ETag actual. Sin cuerpo; la copia que tienes está al día.
Cabeceras: ETag
Sin cuerpo.
Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Cabeceras: X-Request-Id · Content-Language
No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en requiredScope; forbidden: el propietario de la clave carece del permiso que exige la operación). insufficient_scope se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras RateLimit-*; forbidden sí.
Cabeceras: X-Request-Id · Content-Language
Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Límite de peticiones superado (rate_limited): reintenta tras Retry-After segundos; RateLimit-* indica qué cuota se ha agotado.
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Error interno (internal_error).
Cabeceras: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
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
Relacionado
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasFinanzas
Nota de crédito
Nota de crédito: lo que se reembolsa al cliente.
¿Te ha resultado útil esta página?