Llistar totes les factures recurrents
Llista les teves plantilles de factures recurrents amb paginació per cursor.
A: header
Paràmetres de consulta
Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.
251 <= value <= 100Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.
uuidCursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.
uuidEstat del pla recurrent. Coincidència exacta a status.
Estat del pla recurrent. Llista separada per comes. Coincideix qualsevol dels valors.
Client ID (UUID v7). Coincidència exacta amb client_id.
uuidClient ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.
Freqüència d'emissió (p. ex. mensual, anual). Coincidència exacta amb frequency.
Freqüència d'emissió (p. ex. mensual, anual). Llista separada per comes. Coincideix qualsevol dels valors.
Data de propera execució. Major o igual que el valor indicat.
date-timeData de propera execució. Menor o igual que el valor indicat.
date-timeData de propera execució. Estrictament major que el valor indicat.
date-timeData de propera execució. Estrictament menor que el valor indicat.
date-timeNom del pla recurrent. Coincidència exacta sobre name.
Nom del pla recurrent. Coincidència parcial sense distingir majúscules (LIKE %term%) sobre name.
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 recurrents que porten QUALSEVOL dels tags). Coincidència exacta sobre tags.
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 recurrents que porten QUALSEVOL dels tags). Llista separada per comes. Coincideix qualsevol dels valors.
Ordre dels resultats. Fes servir un camp per a ascendent o un prefix - per a descendent (p. ex. -created). Camps permesos: created, next_run_at. 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).
"created" | "-created" | "next_run_at" | "-next_run_at"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.
length <= 80Filtra 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
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.
dateOpera 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.
uuidCos de la resposta
application/json
application/json
application/json
application/json
application/json
application/json