Factuarea APIDevelopers

Listar las plantillas de PDF

Lista las plantillas PDF de tu empresa, paginadas con page y per_page (hasta 100) y ordenadas por nombre y después por id. - Filtros: q (nombre), state (active por defecto, archived o all), document_kind (commercial o transport-document), document_type, purpose y format. - Un valor de filtro o de página fuera de rango devuelve 422 en lugar de recortarse en silencio. - Requiere pdf_templates:read; los empleados no tienen acceso.

GET
/companies/{company}/pdf-templates

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

Parámetros de consulta

q?string

Búsqueda por nombre. Los resultados tienen un orden estable: nombre y luego id, ascendente.

Longitudlength <= 120
state?string

Filtro de ciclo de vida: active (por defecto), archived o all.

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

Solo las plantillas de este tipo: commercial o transport-document. Si se omite, lista todos los tipos.

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

Solo plantillas compatibles con este tipo de documento: invoice, quote, proforma o delivery-note.

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

Solo plantillas compatibles con esta finalidad: complete, simplified, corrective o simplified_corrective.

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

Solo plantillas compatibles con este formato de papel: a4, ticket_80 o ticket_58.

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

Número de página, empezando en 1.

Rango1 <= value
per_page?integer

Tamaño de página, alias de limit (de 1 a 100, 25 por defecto).

Rango1 <= value <= 100

Headers

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 respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json