Factuarea APIDevelopers

Llistar totes les factures

Llista les teves factures de venda amb paginació per cursor.

Admet filtratge per status[in], client_id, series_id, issued_on[gte|lte] i total[gte|lte].

GET
/invoices
AuthorizationBearer <token>

A: header

Paràmetres de consulta

original_invoice_id?|
Formatuuid
verifactu_status?|
Valor a"no_verifactu" | "pending" | "accepted" | "rejected" | null
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 de la factura. Coincidència exacta amb status.

status[in]?string

Estat de la factura. 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
due_on[gte]?string

Data de venciment. Més gran o igual que el valor indicat.

Formatdate
due_on[lte]?string

Data de venciment. Més petita o igual que el valor indicat.

Formatdate
due_on[gt]?string

Data de venciment. Estrictament més gran que el valor indicat.

Formatdate
due_on[lt]?string

Data de venciment. Estrictament més petita que el valor indicat.

Formatdate
total[gte]?number

Import total. Major o igual que el valor donat.

total[lte]?number

Import total. Menor o igual que el valor donat.

total[gt]?number

Import total. Estrictament major que el valor donat.

total[lt]?number

Import total. Estrictament menor que el valor donat.

currency?string

Codi de moneda ISO 4217 (p. ex. EUR). Coincidència exacta amb currency.

currency[in]?string

Codi de moneda ISO 4217 (p. ex. EUR). Llista separada per comes. Coincideix qualsevol dels valors.

number?string

Número de factura. Coincidència exacta amb number.

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 les factures 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 les factures 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, total, number. 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" | "total" | "-total" | "number" | "-number"
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