Listar todos los documentos de control
Lista los documentos de control (DeCA, documento electrónico de control administrativo del transporte de mercancías por carretera) de tu empresa con paginación por cursor.
- Filtros:
status(tambiénstatus[in]),transport_date[gte]/transport_date[lte](un documento coincide cuando el rango de fechas de sus envíos se solapa con el periodo),company_role(shipperocarrier),carrier_tax_id,delivery_note_id(documentos con un envío de ese albarán) yq(número, partes o matrículas). - Ordena con
sort(transport_date,number,created,updated; prefijo-para descendente; por defecto-transport_date). qadmite de 1 a 255 caracteres.- Cualquier otro parámetro de consulta devuelve 400. La herramienta MCP
search_transport_documentsacepta los mismossortyq.
En: header
Parámetros de consulta
Número de objetos a devolver. Entero entre 1 y 100. Por defecto 25.
251 <= value <= 100Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.
uuidCursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.
uuidEstado del documento de control: draft, issued, closed, cancelled o superseded. Coincidencia exacta sobre status.
"draft" | "issued" | "closed" | "cancelled" | "superseded"Estado del documento de control: draft, issued, closed, cancelled o superseded. Lista separada por comas. Coincide cualquiera de los valores.
Periodo de fechas de transporte (YYYY-MM-DD). Un documento coincide cuando el rango de fechas de sus envíos se solapa con el periodo. Mayor o igual que el valor indicado.
datePeriodo de fechas de transporte (YYYY-MM-DD). Un documento coincide cuando el rango de fechas de sus envíos se solapa con el periodo. Menor o igual que el valor indicado.
datePapel de tu empresa en el documento: shipper (cargador contractual) o carrier (transportista efectivo). Coincidencia exacta sobre company_role.
"shipper" | "carrier"NIF del transportista efectivo. Coincidencia exacta sobre carrier_tax_id.
ID del albarán (UUID v7): documentos con al menos un envío de ese albarán. Coincidencia exacta sobre delivery_note_id.
uuidBúsqueda de texto libre sobre el número, las partes (nombre y NIF) y las matrículas (de 1 a 255 caracteres). Coincidencia exacta sobre q.
Orden de clasificación. Usa un campo para orden ascendente o el prefijo - para descendente (p. ej. -created). Campos permitidos: transport_date, number, created, updated. Combinado con el cursor, el orden sigue siendo determinista (un orden secundario estable por el id del cursor, al estilo de Stripe). Si se omite, los documentos se ordenan por fecha de transporte, los más recientes primero.
"transport_date" | "-transport_date" | "number" | "-number" | "created" | "-created" | "updated" | "-updated"Headers
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.
dateOpera 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.
uuidCuerpo de la respuesta
application/json
application/json
application/json
application/json
application/json
application/json
application/json