Factuarea APIDevelopers

Llistar tots els albarans

Llista els teus albarans amb paginació per cursor.

GET
/delivery_notes
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 públic de l'albarà: draft, sent, signed, invoiced, cancelled (els mateixos valors que retorna el camp status del recurs). sent i signed filtren per l'estat intern lliurat (amb/sense signatura); fes servir també el filtre signed per distingir-los amb precisió. Coincidència exacta en status.

status[in]?string

Estat públic de l'albarà: draft, sent, signed, invoiced, cancelled (els mateixos valors que retorna el camp status del recurs). sent i signed filtren per l'estat intern lliurat (amb/sense signatura); fes servir també el filtre signed per distingir-los amb precisió. Llista separada per comes. Coincideix qualsevol dels valors.

client_id?string

Client ID (UUID v7). Coincidència exacta amb client_id.

Formatuuid
client_id[in]?string

Client ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.

series_id?string

Series ID (UUID v7). Coincidència exacta amb series_id.

Formatuuid
series_id[in]?string

Series ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.

created[gte]?string

Data de creació (ISO 8601). Major o igual que el valor donat.

Formatdate-time
created[lte]?string

Data de creació (ISO 8601). Menor o igual que el valor donat.

Formatdate-time
created[gt]?string

Data de creació (ISO 8601). Estrictament major que el valor donat.

Formatdate-time
created[lt]?string

Data de creació (ISO 8601). Estrictament menor que el valor donat.

Formatdate-time
delivery_date[gte]?string

Data de lliurament. Major o igual que el valor donat.

Formatdate
delivery_date[lte]?string

Data de lliurament. Menor o igual que el valor donat.

Formatdate
delivery_date[gt]?string

Data de lliurament. Estrictament major que el valor donat.

Formatdate
delivery_date[lt]?string

Data de lliurament. Estrictament menor que el valor donat.

Formatdate
signed?boolean

Filtra per albarans signats (true) o sense signatura registrada (false). Coincidència exacta en signed.

number?string

Número d'albarà. Coincidència exacta sobre number.

number[contains]?string

Número d'albarà. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre number.

vehicle_plate?string

Matrícula del vehicle de repartiment. Coincidència exacta sobre vehicle_plate.

vehicle_plate[contains]?string

Matrícula del vehicle de repartiment. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre vehicle_plate.

carrier_company?string

Empresa de transport / missatgeria. Coincidència exacta sobre carrier_company.

carrier_company[contains]?string

Empresa de transport / missatgeria. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre carrier_company.

delivery_city?string

Població de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_city=Alcoy), mai la del client — per filtrar per client fes servir client_id. Coincidència exacta sobre delivery_city.

delivery_city[in]?string

Població de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_city=Alcoy), mai la del client — per filtrar per client fes servir client_id. Llista separada per comes. Coincideix qualsevol dels valors.

delivery_city[contains]?string

Població de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_city=Alcoy), mai la del client — per filtrar per client fes servir client_id. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre delivery_city.

delivery_province?string

Província de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_province[in]=Alicante,Valencia), mai la del client — per filtrar per client fes servir client_id. Coincidència exacta sobre delivery_province.

delivery_province[in]?string

Província de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_province[in]=Alicante,Valencia), mai la del client — per filtrar per client fes servir client_id. Llista separada per comes. Coincideix qualsevol dels valors.

delivery_province[contains]?string

Província de l'adreça de lliurament registrada a l'albarà (p. ex. delivery_province[in]=Alicante,Valencia), mai la del client — per filtrar per client fes servir client_id. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre delivery_province.

delivery_postal_code?string

Codi postal de l'adreça de lliurament registrada a l'albarà, mai el del client. Les dues primeres xifres identifiquen la província, així que delivery_postal_code[contains]=03 acota el llistat a una sola província. Coincidència exacta sobre delivery_postal_code.

delivery_postal_code[in]?string

Codi postal de l'adreça de lliurament registrada a l'albarà, mai el del client. Les dues primeres xifres identifiquen la província, així que delivery_postal_code[contains]=03 acota el llistat a una sola província. Llista separada per comes. Coincideix qualsevol dels valors.

delivery_postal_code[contains]?string

Codi postal de l'adreça de lliurament registrada a l'albarà, mai el del client. Les dues primeres xifres identifiquen la província, així que delivery_postal_code[contains]=03 acota el llistat a una sola província. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre delivery_postal_code.

tags?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb els albarans que porten QUALSEVOL dels tags). Coincidència exacta sobre tags.

tags[in]?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb els albarans que porten QUALSEVOL dels tags). Llista separada per comes. Coincideix qualsevol dels valors.

sort?string

Ordre dels resultats. Fes servir un camp per a ascendent o un prefix - per a descendent (p. ex. -created). Camps permesos: created, number, delivery_date. Combinat amb el cursor, l'ordre es manté determinista (un ordre secundari estable per l'id del cursor, a l'estil Stripe). Si s'omet, els resultats segueixen l'ordre de cursor per defecte (created descendent).

Valor a"created" | "-created" | "number" | "-number" | "delivery_date" | "-delivery_date"
search?string

Cerca de text lliure. LIKE %term% escapat (sense distingir majúscules, màx. 80 caràcters) sobre les columnes de text clau del recurs, combinat amb la resta de filtres (AND) i compatible amb el cursor.

Longitudlength <= 80
metadata?

Filtra per parells clau/valor de metadata usant la sintaxi deepObject metadata[key]=value. Diversos parells es combinen amb AND. Cada clau ha de complir [A-Za-z0-9_.-]{1,64}; es permeten un màxim de 50 parells (més → 422).

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