Factuarea APIDevelopers

Crear un documento de control

Crea un documento de control (DeCA) en draft.

  • company_role indica si tu empresa actúa como cargador contractual (shipper) o como transportista efectivo (carrier); tu parte se rellena con los datos de tu empresa y la otra sale de contact_id o de los campos que envíes.
  • Pasa delivery_note_ids (de 1 a 50 de tus albaranes) para prerrellenar un envío por albarán con su destino, fecha y mercancía (sin servicios, con los pesos congelados); un albarán anulado se rechaza con 422 delivery_note_cancelled.
  • Un envío que omite origin toma tu lugar de carga por defecto o, si no tienes ninguno, tu domicilio fiscal (un origin: null explícito lo deja sin origen).
  • El id lo genera el servidor; shipments[].id es opcional y un identificador que ya está en uso devuelve 422 en shipments.N.id.
  • Una línea de mercancía cuyo quantity × gross_weight_kg supera 9.999.999.999,9999 kg o redondea a 0 devuelve 422 invalid_gross_weight en shipments.N.goods.M.gross_weight_kg.
  • Un borrador admite datos incompletos; los datos mínimos solo se exigen para emitir.
  • Una escritura simultánea que choca en un identificador devuelve 409 resource_conflict: no se guardó nada y la petición se puede reintentar.
  • Devuelve 201 con el recurso y una cabecera Location.
POST
/transport_documents

Authorization

AuthorizationBearer <token>

En: header

Headers

Idempotency-Key?string

Clave opaca generada por el cliente (hasta 255 caracteres; se recomienda UUID v7) que hace seguros los reintentos: la primera respuesta se cachea y se reproduce en las repeticiones sin volver a ejecutar la mutación. Reutilizar una clave con un cuerpo distinto devuelve 409 idempotency_key_reused. Consulta la guía de Idempotency.

Longitud1 <= length <= 255
Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json