Factuarea APIDevelopers

Publicar una revisió de plantilla PDF

Afegeix una revisió immutable amb la nova compatibilitat, el disseny base, la marca o la configuració.

  • Retorna 201 amb la nova revisió. - Primer llegeix l'impacte amb action=publish; després envia el seu expected_impact_fingerprint i l'expected_version de la plantilla; si l'impacte ha canviat, retorna 409. - Els objectes de configuration es fusionen en profunditat i les llistes se substitueixen; el tipus és fix, així que document_kind es rebutja. - Les revisions anteriors i els documents emesos amb elles no es modifiquen.
  • Requereix pdf_templates:write; admet Idempotency-Key.
POST
/companies/{company}/pdf-templates/{template}/revisions

Authorization

AuthorizationBearer <token>

La teva API key com a token Bearer: fact_live_… en producció, fact_test_… en sandbox. Consulta la guia d'autenticació.

A: header

Paràmetres de ruta

company*string

Identificador públic (UUID v7) de l'empresa. Obtén-lo de GET /v1/me (data.scope[].id).

Formatuuid
template*string

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

Formatuuid

Headers

Idempotency-Key?string

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 422 idempotency_key_reused; els valors dels camps secrets (password, secret…) compten com a part del cos, així que reintentar amb un secret corregit sota la mateixa clau és una petició diferent, mai la repetició de la resposta anterior. Consulta la guia d'idempotència.

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

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

Cos de la petició

application/json

Escriptura interna reversible: la idempotència segueix la política vigent; la reproducció amb una clau enviada es fa abans del CAS. Els camps desconeguts es rebutgen. Fins que l'empresa estigui preparada per a les plantilles amb revisions (inicialització de l'empresa pendent o generació amb revisions desactivada), tota escriptura a la biblioteca retorna 422 pdf_presentation_not_ready abans de qualsevol precondició o efecte; les lectures continuen disponibles i no s'hi aplica cap Retry-After.

Definicions de TypeScript

Usa el tipus request body a TypeScript.

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json