Factuarea APIDevelopers

Send a transport document by email

Email the stored PDF of the current version, with the public link, to up to 5 recipients in total across to, cc and bcc, with optional subject and message.

  • Without to, the email of the carrier contact is used; if there is none, 422 transport_document_not_sendable.
  • Only issued or closed documents can be sent; the delivery is recorded in the issuance evidence with its recipients.
  • Irreversible: requires Idempotency-Key.
  • Returns 410 transport_document_file_unavailable once the files were purged, and 500 send_failed if the mail provider rejects or cannot take the message (nothing is recorded in the evidence; retry with a new Idempotency-Key).
POST
/transport_documents/{transport_document}/send

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

transport_document*string

Headers

Idempotency-Key*string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Length1 <= length <= 255
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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json