Factuarea APIDevelopers

Llistar les plantilles PDF

Llista les plantilles PDF de la teva empresa, paginades amb page i per_page (fins a 100) i ordenades per nom i després per id. - Filtres: q (nom), state (active per defecte, archived o all), document_kind (commercial o transport-document), document_type, purpose i format. - Un valor de filtre o de pàgina fora de rang retorna 422 en lloc de retallar-se en silenci. - Requereix pdf_templates:read; els empleats no hi tenen accés.

GET
/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

Paràmetres de consulta

q?string

Cerca pel nom. Els resultats tenen un ordre estable: nom i després id, ascendent.

Longitudlength <= 120
state?string

Filtre de cicle de vida: active (per defecte), archived o all.

Valor a"active" | "archived" | "all"
document_kind?string

Només les plantilles d'aquest tipus: commercial o transport-document. Si s'omet, llista tots els tipus.

Valor a"commercial" | "transport-document"
document_type?string

Només plantilles compatibles amb aquest tipus de document: invoice, quote, proforma o delivery-note.

Valor a"invoice" | "quote" | "proforma" | "delivery-note"
purpose?string

Només plantilles compatibles amb aquesta finalitat: complete, simplified, corrective o simplified_corrective.

Valor a"complete" | "simplified" | "corrective" | "simplified_corrective"
format?string

Només plantilles compatibles amb aquest format de paper: a4, ticket_80 o ticket_58.

Valor a"a4" | "ticket_80" | "ticket_58"
page?integer

Número de pàgina, començant a 1.

Rang1 <= value
per_page?integer

Mida de pàgina, àlies de limit (d'1 a 100, 25 per defecte).

Rang1 <= value <= 100

Headers

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 resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json