v1

latestOpenAPI 3.0.32026-07-24398641.3 MB
Facturas recurrentes

Lista de facturas recurrentes

Endpoint que retorna las facturas recurrentes registradas en la cuenta de Alegra. Si no se envía límite de facturas, por defecto se envían 30 facturas.

get/recurring-invoices

Query parameters

startinteger

Índice a partir del cuál se devolverán las facturas recurrentes. Los resultados varian según el orden en el que se muestra la información.

limitinteger

Cantidad de facturas recurrentes a partir del inicio que se desea retornar. Por defecto retorna 30 facturas recurrentes. Si este valor es mayor que 30, se límita a 30 facturas recurrentes.

order_directionstring

Orden ascendente o descendente en el cual se quieren retornar las facturas recurrentes. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_fieldstring

Campo por el cual se desea ordenar, las opciones posibles son name, startDate, endDate, repeatEvery y term.

metadataboolean

La cantidad total de facturas recurrentes se incluye en el resultado. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían las facturas recurrentes.

startDatestring

Filtrar resultados según la fecha de inico de la factura recurrente.

endDatestring

Filtrar resultados según la fecha de fin de la factura recurrente.

repeatEveryinteger

Filtrar resultados según el intervalo de la factura recurrente.

terminteger

Filtrar resultados según el término de pago de la factura recurrente.

client_idstring

Filtrar resultados según el id del cliente de la factura recurrente.

namestring

Filtrar resultados según el nombre del cliente de la factura recurrente.

Response

Retorna la lista de facturas recurrentes