Factuarea APIDevelopers

Listar todas las facturas recurrentes

Lista tus plantillas de facturas recurrentes con paginación por cursor.

GET
/recurring_invoices
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 plan recurrente. Coincidencia exacta en status.

status[in]?string

Estado del plan recurrente. Lista separada por comas. Coincide cualquiera de los valores.

client_id?string

Client ID (UUID v7). Coincidencia exacta con client_id.

Formatouuid
client_id[in]?string

Client ID (UUID v7). Lista separada por comas. Coincide cualquiera de los valores.

frequency?string

Frecuencia de emisión (p. ej. mensual, anual). Coincidencia exacta con frequency.

frequency[in]?string

Frecuencia de emisión (p. ej. mensual, anual). Lista separada por comas. Coincide cualquiera de los valores.

next_run_at[gte]?string

Fecha de próxima ejecución. Mayor o igual que el valor indicado.

Formatodate-time
next_run_at[lte]?string

Fecha de próxima ejecución. Menor o igual que el valor indicado.

Formatodate-time
next_run_at[gt]?string

Fecha de próxima ejecución. Estrictamente mayor que el valor indicado.

Formatodate-time
next_run_at[lt]?string

Fecha de próxima ejecución. Estrictamente menor que el valor indicado.

Formatodate-time
name?string

Nombre del plan recurrente. Coincidencia exacta sobre name.

name[contains]?string

Nombre del plan recurrente. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre name.

tags?string

Filtrar por tag de clasificación (slug en minúscula). Admite múltiples valores con tags[in]=a,b (JSON_CONTAINS, semántica OR — coincide con las facturas recurrentes que llevan CUALQUIERA de los tags). Coincidencia exacta sobre tags.

tags[in]?string

Filtrar por tag de clasificación (slug en minúscula). Admite múltiples valores con tags[in]=a,b (JSON_CONTAINS, semántica OR — coincide con las facturas recurrentes que llevan CUALQUIERA de los tags). Lista separada por comas. Coincide cualquiera de los valores.

sort?string

Orden de los resultados. Usa un campo para ascendente o un prefijo - para descendente (p. ej. -created). Campos permitidos: created, next_run_at. Combinado con el cursor, el orden se mantiene determinista (un orden secundario estable por el id del cursor, al estilo Stripe). Si se omite, los resultados siguen el orden de cursor por defecto (created descendente).

Valor en"created" | "-created" | "next_run_at" | "-next_run_at"
search?string

Búsqueda de texto libre. LIKE %term% escapado (sin distinguir mayúsculas, máx. 80 caracteres) sobre las columnas de texto clave del recurso, combinado con los demás filtros (AND) y compatible con el cursor.

Longitudlength <= 80
metadata?

Filtra por pares clave/valor de metadata usando la sintaxis deepObject metadata[key]=value. Varios pares se combinan con AND. Cada clave debe cumplir [A-Za-z0-9_.-]{1,64}; se permiten un máximo de 50 pares (más → 422).

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