Factuarea APIDevelopers

Download transport document PDF

Download the stored PDF of the current version or of ?version=N, byte for byte as it was issued (never re-rendered): its sha256 matches versions[].sha256.

  • Returns the binary stream (application/pdf); pass ?download=1 for Content-Disposition: attachment.
  • A draft returns 422, a purged document 410 transport_document_file_unavailable and a version the document does not have 404 transport_document_version_not_found (error.param = version).
GET
/transport_documents/{transport_document}/pdf

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

transport_document*string

Query Parameters

version?integer

Version number of the PDF to download (1, 2, …). Omit it to get the current version.

Range1 <= value
download?string

Pass 1 (or true) to receive the PDF with Content-Disposition: attachment; otherwise it is served inline.

Value in"0" | "1" | "true" | "false"

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/pdf

application/json

application/json

application/json

application/json

application/json

application/json

application/json