Factuarea APIDevelopers

Crear una plantilla PDF

Crea una plantilla amb la seva primera revisió; només name és obligatori (id i revision_id opcionals, UUID v7).

Retorna 201. - document_kind és commercial per defecte o transport-document per a una plantilla de document de control de transport (DeCA); mai canvia, i una plantilla de DeCA només accepta branding, typography i colors. - Un logo o una imatge de marca necessita una marca efectiva; es rebutgen HTML, CSS, scripts, URLs i dades legals o bancàries. - Només administradors de l'empresa, amb pdf_templates:write; admet Idempotency-Key.

POST
/companies/{company}/pdf-templates

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

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