Factuarea APIDevelopers
Support
Open app

Update a draft transport document

Partially update a transport document in draft: an absent field is kept, an explicit null clears it and shipments replaces the whole list.

  • Any other status returns 422 transport_document_cannot_be_edited; an issued document is changed with POST /v1/transport_documents/{id}/modify.
  • shipments[].id only identifies a shipment of this document (any other returns 422 parameter_invalid_value on shipments.N.id); a goods line with an impossible weight returns 422 invalid_gross_weight.
  • A concurrent write that collides on an identifier returns 409 resource_conflict, retryable: nothing was saved.
PUT
/transport_documents/{transport_document}

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.

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

Previous/v1/transport_documents/{transport_document}
GET

Retrieve a transport document

Retrieve a transport document (DeCA) by its id. The resource carries the parties, vehicle, shipments with their goods and declared measure, every version with its author, reason, changes and sha256, the public URL printed on the QR, and the lifecycle dates (including reopen_deadline and retention_until). Each shipment built from a delivery note reports source_changed/source_changes when the delivery note changed after the current version, and source_missing when it was cancelled or deleted. A document of another company returns 404 transport_document_not_found.

Next/v1/transport_documents/{transport_document}
DEL

Delete a draft transport document

Delete a transport document that is still in draft, together with its shipments. It consumes no number and leaves no file. An issued document is always kept: deleting it returns 422 transport_document_cannot_be_deleted. Returns 204.