Lista de facturas de venta

get

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

Endpoint que retorna las facturas 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

Desde cual factura se quiere consultar. Por ejemplo para consultar desde la factura 20, se envía start=20 (diferente a id de factura). Los resultados varian según el orden en el que se muestra la información.

limit

integer

Cantidad de facturas a partir del inicio que se desea retornar. Por defecto retorna 30 facturas. Si este valor es mayor que 30, la aplicación retorna error.

order_direction

string

Orden ascendente o descendente en el cual se quieren retornar las facturas. 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 id, name, date, dueDate, status.

metadata

boolean

Incluir en los resultados metadatos. 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. Actualmente la información que se envía en metadata incluye el total de facturas que tiene registrada la empresa.

string

Ids de las facturas de venta. Sirve para consultar facturas específicas. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 facturas al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.

date

Filtrar resultados según fecha de creación de la factura. Se retornarán todas las facturas de venta que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

dueDate

date

Filtrar resultados según fecha de vencimiento de la factura. Se retornarán todas las facturas de venta que coincidan en su fecha de vencimiento (atributo dueDate) con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

status

string

Filtrar resultados según el estado de la factura. Se retornarán todas las facturas de venta que coincidan en su estado (atributo status) con el valor enviado en este parámetro. Los valores aceptados son open, closed, draft y void, para consultar varios estados se deben separar con una coma (closed,draft).

client_id

string

Filtrar resultados según el identificador del cliente de la factura. Se retornarán todas las facturas de venta que estén asociadas a un cliente que en su identificador (campo del id) contenga el valor enviado en este parámetro.

client_name

string

Filtrar resultados según el nombre del cliente de la factura. Se retornarán todas las facturas de venta que estén asociadas a un cliente que en su nombre contenga el valor enviado en este parámetro.

client_identification

string

Filtrar resultados según la identificación del cliente de la factura. Se retornarán todas las facturas de venta que estén asociadas a un cliente que en su identificación (campo del identification) contenga el valor enviado en este parámetro.

numberTemplate_fullNumber

string

Filtrar resultados según la numeración de la factura. Se retornarán todas las facturas de venta que estén asociadas a una numeración que contenga el valor enviado en este parámetro.

item_id

string

Filtrar las facturas de venta por el id del item.

date_after

date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia siguiente en adelante. El formato para la fecha es YYYY-MM-DD.

date_afterOrNow

date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual en adelante. El formato para la fecha es YYYY-MM-DD.

date_before

date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

date_beforeOrNow

date

Fecha del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual para atras. El formato para la fecha es YYYY-MM-DD.

dueDate_after

date

Fecha de vencimiento del documento desde la cual se deben obtener los resultados. Consulta desde el dia siguiente en adelante. El formato para la fecha es YYYY-MM-DD.

dueDate_afterOrNow

date

Fecha de vencimiento del documento desde la cual se deben obtener los resultados. Consulta desde el dia actual en adelante. El formato para la fecha es YYYY-MM-DD.

dueDate_before

date

Fecha de vencimeinto del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

dueDate_beforeOrNow

date

Fecha de vencimeinto del documento desde la cual se deben obtener los resultados. Consulta desde el dia anterior para atras. El formato para la fecha es YYYY-MM-DD.

toReplace

boolean

Filtrar las facturas que necesitan ser sustituidas de un cliente. Cuando este campo se envía, es obligatorio enviar el campo client_id.

download

boolean

Al enviar este parametro solicitas unicamente la descarga del PDF de hasta 10 facturas.

downloadType

string

Las opciones pueden ser 1to1 y all. Al utilizar all solicitas unidos en un solo archivo pdf que incluya todas las facturas. Al utilizar 1to1 solicitas cada pdf por factura separado en distintos links.

Responses

200Retorna la lista de facturas

404Bad request - Límite sobrepasa máximo permitido