Crear un document de control

Crea un document de control (DeCA) en draft.

company_role indica si la teva empresa actua com a carregador contractual (shipper) o com a transportista efectiu (carrier); la teva part s'omple amb les dades de la teva empresa i l'altra surt de contact_id o dels camps que enviïs.
Passa delivery_note_ids (d'1 a 50 dels teus albarans) per emplenar un enviament per albarà amb la seva destinació, data i mercaderia (sense serveis, amb els pesos congelats); un albarà anul·lat es rebutja amb 422 delivery_note_cancelled.
Un enviament que omet origin pren el teu lloc de càrrega per defecte o, si no en tens cap, el teu domicili fiscal (un origin: null explícit el deixa sense origen).
L'id el genera el servidor; shipments[].id és opcional i un identificador que ja està en ús retorna 422 a shipments.N.id.
Una línia de mercaderia amb un quantity × gross_weight_kg que supera 9.999.999.999,9999 kg o arrodoneix a 0 retorna 422 invalid_gross_weight a shipments.N.goods.M.gross_weight_kg.
Un esborrany admet dades incompletes; les dades mínimes només s'exigeixen per emetre.
Una escriptura simultània que xoca en un identificador retorna 409 resource_conflict: no s'ha desat res i la petició es pot reintentar.
Retorna 201 amb el recurs i una capçalera Location.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que fa segurs els reintents: la primera resposta es cacheja i es reprodueix a les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'Idempotency.

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 petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

company_role*string

Valor a"shipper" | "carrier"

special_authorization?|

Longitudlength <= 100

transport_date?|

Formatdate

observations?|

Longitudlength <= 5000

vehicle?

shipments?array<>|

Elementsitems <= 50

shipper?

carrier?

delivery_note_ids?array<>

Elements1 <= items <= 50

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/transport_documents", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-transport_documents-create"} },  body: JSON.stringify({  "company_role": "shipper",  "carrier": {    "contact_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a10"  },  "vehicle": {    "tractor_plate": "1234BCD",    "trailer_plate": "R1234BCD"  },  "transport_date": "2026-10-06",  "observations": "Carga en muelle 3.",  "delivery_note_ids": [    "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a11",    "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a12"  ]}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a01",
    "object": "transport_document",
    "number": null,
    "status": "draft",
    "company_role": "shipper",
    "public_url": null,
    "current_version": null,
    "shipper": {
      "name": "Distribuciones Olivar SL",
      "tax_id": "A58818501",
      "tax_id_country": "ES",
      "address": {
        "line": "Calle Industria 5",
        "postal_code": "28901",
        "city": "Getafe",
        "province": "Madrid",
        "country": "ES",
        "name": null
      },
      "contact_id": null
    },
    "carrier": {
      "name": "Transportes Pérez SL",
      "tax_id": "B12345674",
      "tax_id_country": "ES",
      "address": null,
      "contact_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01"
    },
    "vehicle": {
      "tractor_plate": "1234BCD",
      "tractor_plate_country": "ES",
      "trailer_plate": "R1234BCD",
      "trailer_plate_country": "ES"
    },
    "special_authorization": null,
    "transport_date": "2026-10-06",
    "observations": "Entrega en horario de mañana.",
    "shipments": [
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a11",
        "origin": {
          "line": "Calle Industria 5",
          "postal_code": "28901",
          "city": "Getafe",
          "province": "Madrid",
          "country": "ES",
          "name": "Nave Getafe"
        },
        "destination": {
          "line": "Avenida de Europa 20",
          "postal_code": "45005",
          "city": "Toledo",
          "province": "Toledo",
          "country": "ES",
          "name": "Ultramarinos Toledo"
        },
        "transport_date": "2026-10-06",
        "goods": [
          {
            "description": "Aceituna gordal aliñada",
            "additional_description": "Mantener refrigerado.",
            "quantity": "10.0000",
            "unit": "cajas",
            "gross_weight_kg": "12.5000"
          }
        ],
        "declared_measure": {
          "type": "weight",
          "weight_kg": "125.0000",
          "value": null,
          "unit": null
        },
        "delivery_note_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a06",
        "source_changed": false,
        "source_changes": [],
        "source_missing": false,
        "observations": "Albarán ALB-2026-00231"
      },
      {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f9a12",
        "origin": {
          "line": "Calle Industria 5",
          "postal_code": "28901",
          "city": "Getafe",
          "province": "Madrid",
          "country": "ES",
          "name": "Nave Getafe"
        },
        "destination": {
          "line": "Plaza Mayor 3",
          "postal_code": "45600",
          "city": "Talavera de la Reina",
          "province": "Toledo",
          "country": "ES",
          "name": null
        },
        "transport_date": null,
        "goods": [
          {
            "description": "Palés de aceite de oliva",
            "additional_description": null,
            "quantity": "2.0000",
            "unit": "palés",
            "gross_weight_kg": null
          }
        ],
        "declared_measure": {
          "type": "other",
          "weight_kg": null,
          "value": "2.0000",
          "unit": "palés"
        },
        "delivery_note_id": null,
        "source_changed": false,
        "source_changes": [],
        "source_missing": false,
        "observations": null
      }
    ],
    "versions": [],
    "issued_at": null,
    "last_modified_at": null,
    "closed_at": null,
    "close_mode": null,
    "reopen_deadline": null,
    "cancelled_at": null,
    "cancel_reason": null,
    "superseded_at": null,
    "superseding_reference": null,
    "retention_until": null,
    "files_purged_at": null,
    "created_at": "2026-10-05T15:58:12+00:00",
    "updated_at": "2026-10-06T07:10:00+00:00"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_497f8793c2d2261a089521ba79"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'transport_documents:write'. Tu API key solo tiene los scopes: transport_documents:read.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_117ef256774608bc2c58306ec1"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "delivery_note_not_found",
    "message": "Albarán no encontrado.",
    "param": "delivery_note_ids",
    "doc_url": "https://docs.factuarea.com/guides/errors#delivery_note_not_found",
    "request_id": "req_3d0683bf1d078020be1817c657"
  }
}

POST /v1/transport_documents · 409 idempotency_key_reused

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_dea73f135a6d8026a5a1cc91cc"
  }
}

POST /v1/transport_documents · 409 resource_conflict

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "Se ha detectado otra escritura concurrente sobre los mismos datos. Vuelve a intentarlo dentro de unos segundos: la operación es reintentable y no ha dejado nada a medias.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_330bfeb5147b0ef1ce78f03540"
  }
}

POST /v1/transport_documents · 422 invalid_param_value

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "Los lugares de carga no se exponen en esta superficie: indica el origen del envío con su dirección.",
    "param": "shipments.0.loading_place_id",
    "errors": [
      {
        "param": "shipments.0.loading_place_id",
        "code": "parameter_invalid_value",
        "message": "Los lugares de carga no se exponen en esta superficie: indica el origen del envío con su dirección."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_906c1b5db5b1fe12e80ae11feb"
  }
}

POST /v1/transport_documents · 422 delivery_note_cancelled

{
  "error": {
    "type": "invalid_request_error",
    "code": "delivery_note_cancelled",
    "message": "El albarán ALB-2026-00231 está anulado y no puede ser origen de un envío del DeCA.",
    "param": "delivery_note_ids",
    "doc_url": "https://docs.factuarea.com/guides/errors#delivery_note_cancelled",
    "request_id": "req_7987270f6403b8ee7a30c390a4"
  }
}

POST /v1/transport_documents · 422 invalid_transport_tax_id

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_transport_tax_id",
    "message": "La identificación fiscal 12345678A no es válida.",
    "param": "tax_id",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_transport_tax_id",
    "request_id": "req_0934e15d9ab58c670cfa148c04"
  }
}

POST /v1/transport_documents · 422 invalid_vehicle_plate

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_vehicle_plate",
    "message": "La matrícula 1234ABC no es válida: las matrículas españolas no llevan vocales. Revisa las letras o, si es extranjera, elige su país.",
    "param": "vehicle",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_vehicle_plate",
    "request_id": "req_1d8d0baa2ddcf8deec0ea9d9a3"
  }
}

POST /v1/transport_documents · 422 invalid_cargo_measure

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_cargo_measure",
    "message": "El tipo de magnitud «volume» no es válido: usa weight (peso en kg) u other (otra magnitud con su unidad).",
    "param": "declared_measure",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_cargo_measure",
    "request_id": "req_1cd1c08aae483f33bf41255dd6"
  }
}

POST /v1/transport_documents · 422 invalid_gross_weight

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_gross_weight",
    "message": "El peso de la línea 1 del envío 1 no es válido: 2000000 unidades de 5000000 kg dan un peso de línea que debe ser mayor que 0 kg y no superar 9999999999.9999 kg. Revisa la cantidad o el peso por unidad.",
    "param": "shipments.0.goods.0.gross_weight_kg",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_gross_weight",
    "request_id": "req_13bb61fd4a50a88be21c8661fc"
  }
}

POST /v1/transport_documents · 422 invalid_param_value

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "Este identificador de envío ya está en uso.",
    "param": "shipments.0.id",
    "errors": [
      {
        "param": "shipments.0.id",
        "code": "parameter_invalid_value",
        "message": "Este identificador de envío ya está en uso."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_d3a5f0a9d3f2d56cdf4f7833b6"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_33b639ba7f4c25224e20120e90"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_49bcca7b66b382b49580ae8801"
  }
}

Crear un document de control

Authorization

Headers

Cos de la petició

Cos de la resposta

201application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`