Factuarea APIDevelopers

Publicar una revisión de plantilla de PDF

Añade una revisión inmutable con la nueva compatibilidad, el diseño base, la marca o la configuración.

  • Devuelve 201 con la nueva revisión. - Primero lee el impacto con action=publish; después envía su expected_impact_fingerprint y la expected_version de la plantilla; si el impacto ha cambiado, devuelve 409. - Los objetos de configuration se fusionan en profundidad y las listas se sustituyen; el tipo es fijo, así que document_kind se rechaza. - Las revisiones anteriores y los documentos emitidos con ellas no se modifican.
  • Requiere pdf_templates:write; admite Idempotency-Key.
POST
/companies/{company}/pdf-templates/{template}/revisions

Authorization

AuthorizationBearer <token>

Tu API key como token Bearer: fact_live_… en producción, fact_test_… en sandbox. Consulta la guía de autenticación.

En: header

Parámetros de ruta

company*string

Identificador público (UUID v7) de la empresa. Obtenlo de GET /v1/me (data.scope[].id).

Formatouuid
template*string

Identificador público (UUID v7) de la plantilla de PDF.

Formatouuid

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 422 idempotency_key_reused; los valores de los campos secretos (password, secret…) cuentan como parte del cuerpo, así que reintentar con un secreto corregido bajo la misma clave es una petición distinta, nunca la repetición de la respuesta anterior. Consulta la guía de idempotencia.

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

Cuerpo de la petición

application/json

Escritura interna reversible: la idempotencia sigue la política vigente; la repetición con una clave enviada ocurre antes del CAS. Los campos desconocidos se rechazan. Hasta que la empresa esté preparada para las plantillas con revisiones (inicialización de la empresa pendiente o generación con revisiones desactivada), toda escritura en la biblioteca devuelve 422 pdf_presentation_not_ready antes de cualquier precondición o efecto; las lecturas siguen disponibles y no se aplica ningún Retry-After.

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

application/json