Factuarea APIDevelopers

Llistar tots els documents de control

Llista els documents de control (DeCA, document electrònic de control administratiu del transport de mercaderies per carretera) de la teva empresa amb paginació per cursor.

  • Filtres: status (també status[in]), transport_date[gte]/transport_date[lte] (un document coincideix quan el rang de dates dels seus enviaments se solapa amb el període), company_role (shipper o carrier), carrier_tax_id, delivery_note_id (documents amb un enviament d'aquest albarà) i q (número, parts o matrícules).
  • Ordena amb sort (transport_date, number, created, updated; prefix - per a descendent; per defecte -transport_date).
  • q admet d'1 a 255 caràcters.
  • Qualsevol altre paràmetre de consulta retorna 400. L'eina MCP search_transport_documents accepta els mateixos sort i q.
GET
/transport_documents

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
status?string

Estat del document de control: draft, issued, closed, cancelled o superseded. Coincidència exacta sobre status.

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

Estat del document de control: draft, issued, closed, cancelled o superseded. Llista separada per comes. Coincideix qualsevol dels valors.

transport_date[gte]?string

Període de dates de transport (YYYY-MM-DD). Un document coincideix quan el rang de dates dels seus enviaments se solapa amb el període. Més gran o igual que el valor indicat.

Formatdate
transport_date[lte]?string

Període de dates de transport (YYYY-MM-DD). Un document coincideix quan el rang de dates dels seus enviaments se solapa amb el període. Menor o igual que el valor indicat.

Formatdate
company_role?string

Paper de la teva empresa al document: shipper (carregador contractual) o carrier (transportista efectiu). Coincidència exacta sobre company_role.

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

NIF del transportista efectiu. Coincidència exacta sobre carrier_tax_id.

delivery_note_id?string

ID de l'albarà (UUID v7): documents amb almenys un enviament d'aquest albarà. Coincidència exacta sobre delivery_note_id.

Formatuuid
q?string

Cerca de text lliure sobre el número, les parts (nom i NIF) i les matrícules (d'1 a 255 caràcters). Coincidència exacta sobre q.

sort?string

Ordre de classificació. Fes servir un camp per a ordre ascendent o el prefix - per a descendent (p. ex. -created). Camps permesos: transport_date, number, created, updated. Combinat amb el cursor, l'ordre continua sent determinista (un ordre secundari estable per l'id del cursor, a l'estil de Stripe). Si s'omet, els documents s'ordenen per data de transport, els més recents primer.

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

Headers

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 resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json