Factuarea APIDevelopers

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én status[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 (shipper o carrier), carrier_tax_id, delivery_note_id (documentos con un envío de ese albarán) y q (número, partes o matrículas).
  • Ordena con sort (transport_date, number, created, updated; prefijo - para descendente; por defecto -transport_date).
  • q admite de 1 a 255 caracteres.
  • Cualquier otro parámetro de consulta devuelve 400. La herramienta MCP search_transport_documents acepta los mismos sort y q.
GET
/transport_documents

Authorization

AuthorizationBearer <token>

En: header

Parámetros de consulta

limit?integer

Número de objetos a devolver. Entero entre 1 y 100. Por defecto 25.

Predeterminado25
Rango1 <= value <= 100
starting_after?string

Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.

Formatouuid
ending_before?string

Cursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.

Formatouuid
status?string

Estado del documento de control: draft, issued, closed, cancelled o superseded. Coincidencia exacta sobre status.

Valor en"draft" | "issued" | "closed" | "cancelled" | "superseded"
status[in]?string

Estado del documento de control: draft, issued, closed, cancelled o superseded. Lista separada por comas. Coincide cualquiera de los valores.

transport_date[gte]?string

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.

Formatodate
transport_date[lte]?string

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. Menor o igual que el valor indicado.

Formatodate
company_role?string

Papel de tu empresa en el documento: shipper (cargador contractual) o carrier (transportista efectivo). Coincidencia exacta sobre company_role.

Valor en"shipper" | "carrier"
carrier_tax_id?string

NIF del transportista efectivo. Coincidencia exacta sobre carrier_tax_id.

delivery_note_id?string

ID del albarán (UUID v7): documentos con al menos un envío de ese albarán. Coincidencia exacta sobre delivery_note_id.

Formatouuid
q?string

Bú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.

sort?string

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.

Valor en"transport_date" | "-transport_date" | "number" | "-number" | "created" | "-created" | "updated" | "-updated"

Headers

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 respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json