Marcar un document de control com a substituït

Marca un document de control issued com a substituït pel document propi del transportista (mètode 2 de la Resolució): envia reference (d'1 a 300 caràcters; per exemple, el seu número o URL) i reason.

Desa una versió final del PDF marcada «SUSTITUIDO» i el document passa a ser terminal (superseded).
Un PDF de més de 5 MB retorna 422 transport_document_pdf_too_large i no canvia res.
Irreversible: exigeix Idempotency-Key.

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

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

reference*string

Longitudlength <= 300

reason*string

Longitud3 <= length <= 500

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/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/supersede", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-transport_documents-supersede"} },  body: JSON.stringify({  "reference": "https://transportes-ejemplo.es/deca/9F3K",  "reason": "Cambio de vehículo documentado por el transportista"}),});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": "DC-2026-042",
    "status": "superseded",
    "company_role": "shipper",
    "public_url": "https://app.factuarea.com/api/public/deca/q3VfN2mX8yPbK1rT4wZs6LcH0dGjAe9uIoRtYvBnMkE",
    "current_version": 3,
    "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": "R9876BCD",
      "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": true,
        "source_changes": [
          {
            "field": "goods.1",
            "previous": {
              "description": "Aceituna gordal aliñada",
              "additional_description": "Mantener refrigerado.",
              "quantity": "10.0000",
              "unit": "cajas",
              "gross_weight_kg": "12.5000"
            },
            "current": {
              "description": "Aceituna gordal aliñada",
              "additional_description": "Mantener refrigerado.",
              "quantity": "12.0000",
              "unit": "cajas",
              "gross_weight_kg": "12.5000"
            }
          }
        ],
        "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": [
      {
        "number": 1,
        "kind": "issue",
        "reason": null,
        "data_origin": "company",
        "created_at": "2026-10-05T16:20:00+00:00",
        "created_by": "ERP Almacén (API)",
        "changes": [],
        "sha256": "3bfadc5c0e1f2a4b6c8d9e0f1a2b3c4d5e6f708192a3b4c5d6e7f8091a2b68d5",
        "size_bytes": 73865
      },
      {
        "number": 2,
        "kind": "modification",
        "reason": "Cambio de semirremolque en ruta",
        "data_origin": "carrier_reported",
        "created_at": "2026-10-06T07:10:00+00:00",
        "created_by": "ERP Almacén (API)",
        "changes": [
          {
            "field": "vehicle.trailer_plate",
            "previous": "R1234BCD",
            "current": "R9876BCD"
          }
        ],
        "sha256": "9c1d7e2a4b6f8a0c2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a3b5c7d",
        "size_bytes": 81234
      },
      {
        "number": 3,
        "kind": "supersession",
        "reason": "Cambio de vehículo documentado por el transportista",
        "data_origin": "company",
        "created_at": "2026-10-06T08:00:00+00:00",
        "created_by": "ERP Almacén (API)",
        "changes": [],
        "sha256": "e7a90b1c3d5f7a9b1d3f5a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1a3c5e7f",
        "size_bytes": 87903
      }
    ],
    "issued_at": "2026-10-05T16:20:00+00:00",
    "last_modified_at": "2026-10-06T07:10:00+00:00",
    "closed_at": null,
    "close_mode": null,
    "reopen_deadline": "2026-10-13T22:00:00+00:00",
    "cancelled_at": null,
    "cancel_reason": null,
    "superseded_at": "2026-10-06T08:00:00+00:00",
    "superseding_reference": "DeCA TRP-2026-7781 de Transportes Pérez SL",
    "retention_until": "2027-10-06T08:00:00+00:00",
    "files_purged_at": null,
    "created_at": "2026-10-05T15:58:12+00:00",
    "updated_at": "2026-10-06T08:00: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_c1b97690f67869f1273539daad"
  }
}

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

{
  "error": {
    "type": "not_found_error",
    "code": "transport_document_not_found",
    "message": "DeCA no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#transport_document_not_found",
    "request_id": "req_9d9da505da5d3f91dee26d87e6"
  }
}

{
  "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_55e6615f9289c17c6a4396d256"
  }
}

POST /v1/transport_documents/{transport_document}/supersede · 422 transport_document_cannot_be_superseded

{
  "error": {
    "type": "invalid_request_error",
    "code": "transport_document_cannot_be_superseded",
    "message": "El DeCA DC-2026-042 no se puede marcar como sustituido: está en estado «Anulado». Solo se sustituye un DeCA emitido y en curso.",
    "doc_url": "https://docs.factuarea.com/guides/errors#transport_document_cannot_be_superseded",
    "request_id": "req_4b3226a3e9b41e793e0fdd4884"
  }
}

POST /v1/transport_documents/{transport_document}/supersede · 422 idempotency_key_required

{
  "error": {
    "type": "invalid_request_error",
    "code": "idempotency_key_required",
    "message": "La operación «public-api.v1.transport_documents.supersede» exige la cabecera Idempotency-Key desde el 2026-12-01. Envía una clave única por operación (un UUID sirve) y, si reintenta, repite exactamente la misma clave para que la operación no se ejecute dos veces.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_required",
    "request_id": "req_1f68f39bd8d40012161752ddcf"
  }
}

POST /v1/transport_documents/{transport_document}/supersede · 422 transport_document_pdf_too_large

{
  "error": {
    "type": "invalid_request_error",
    "code": "transport_document_pdf_too_large",
    "message": "El PDF del DeCA ocuparía 5,31 MB y el máximo permitido es 5 MB. No se ha guardado ningún cambio. Reduce el contenido del documento (menos envíos o líneas de mercancía, descripciones u observaciones más cortas) o reparte los envíos en varios DeCA.",
    "doc_url": "https://docs.factuarea.com/guides/errors#transport_document_pdf_too_large",
    "request_id": "req_8a713f28f337f77091b24e4484"
  }
}

{
  "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_1031887db971c0d6ef7616dda0"
  }
}

{
  "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_e9817b020ebefd6340b9b51d66"
  }
}

Marcar un document de control com a substituït

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

200application/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`