Factuarea APIDevelopers

Emetre un document de control

Emet un document de control en esborrany.

  • Comprova les dades mínimes (nom, NIF i domicili complet del carregador; nom i NIF del transportista; almenys un enviament amb origen, destinació, mercaderia i magnitud declarada; matrícula de la tractora; data de transport), que cada origen i destinació sigui a Espanya i que cada data de transport sigui avui o posterior (Europe/Madrid).
  • En una sola operació atòmica assigna el número següent de la sèrie DC i la URL pública permanent, renderitza i desa la versió 1 del PDF amb el seu sha256, i passa el document a issued.
  • Si falten dades retorna 422 transport_document_not_issuable amb la llista a error.details.missing, amb aquest vocabulari tancat: shipper.name, shipper.tax_id, shipper.address, carrier.name, carrier.tax_id, vehicle.tractor_plate, transport_date, shipments (cap enviament) i shipments.N.origin|destination|goods|measure, amb N comptant des d'1.
  • Un PDF de més de 5 MB retorna 422 transport_document_pdf_too_large i no s'emet res.
  • Irreversible: exigeix Idempotency-Key.
  • Lliura el PDF, l'enllaç o el QR al conductor abans que comenci el transport.
POST
/transport_documents/{transport_document}/issue

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

transport_document*string

Headers

Idempotency-Key*string

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255
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/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json