Factuarea APIDevelopers

Descarregar el PDF d'un document de control

Descarrega el PDF desat de la versió vigent o de ?version=N, byte a byte tal com es va emetre (mai no es torna a renderitzar): el seu sha256 coincideix amb versions[].sha256.

  • Retorna el flux binari (application/pdf); passa ?download=1 per a Content-Disposition: attachment.
  • Un esborrany retorna 422; un document purgat, 410 transport_document_file_unavailable, i una version que el document no té, 404 transport_document_version_not_found (error.param = version).
GET
/transport_documents/{transport_document}/pdf

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

transport_document*string

Paràmetres de consulta

version?integer

Número de versió del PDF que es descarrega (1, 2, …). Omet-lo per obtenir la versió vigent.

Rang1 <= value
download?string

Passa 1 (o true) per rebre el PDF amb Content-Disposition: attachment; si no, se serveix inline.

Valor a"0" | "1" | "true" | "false"

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
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/pdf

application/json

application/json

application/json

application/json

application/json

application/json

application/json