Factuarea APIDevelopers

Actualizar una serie

Actualiza parcialmente una serie: solo cambian los campos que envías (name, code, counter_reset, number_format, initial_number, invoice_kind; year_reset es el alias deprecado de counter_reset).

  • Se aplican las mismas guardas fiscales que en la aplicación web, cada una como un 422 business_rule_violation con su propio subcode y sin cambiar nada: code y number_format solo mientras la serie no tiene documentos (series_code_immutable_with_documents, series_format_immutable_with_documents); cuando la AEAT ha aceptado un registro de alguna de sus facturas, code, number_format y initial_number quedan bloqueados (series_locked_by_verifactu); initial_number no puede abrir un hueco (series_initial_number_creates_gap); invoice_kind queda fijo con la primera factura (series_invoice_kind_locked) y la serie predeterminada de un propósito no puede cambiar de propósito (series_default_kind_change).
  • Un code ya usado por otra serie del mismo tipo de documento devuelve 422 con param=code; document_type no se puede cambiar.
  • Devuelve 200 con la serie actualizada, y 404 series_not_found si no pertenece a tu empresa.
PUT
/series/{series}
AuthorizationBearer <token>

En: header

Parámetros de ruta

series*string

Headers

Idempotency-Key?string

Clave opaca generada por el cliente (hasta 255 caracteres; se recomienda UUID v7) que hace seguros los reintentos: la primera respuesta se cachea y se reproduce en las repeticiones sin volver a ejecutar la mutación. Reutilizar una clave con un cuerpo distinto devuelve 409 idempotency_key_reused. Consulta la guía de Idempotency.

Longitud1 <= length <= 255
Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json