Lista de facturas recurrentes

get

https://api.alegra.com/api/v1/recurring-invoices

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.

Query Params

start

integer

Í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.

limit

integer

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_direction

string

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_field

string

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

metadata

boolean

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.

startDate

string

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

endDate

string

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

repeatEvery

integer

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

term

integer

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

client_id

string

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

name

string

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

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retorna la lista de facturas recurrentes