v1
latestOpenAPI 3.0.32026-07-24398641.3 MBLista de facturas de venta
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 parameters
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.
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.
Orden ascendente o descendente en el cual se quieren retornar las facturas. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate, status.
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.
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.
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.
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.
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).
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.
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.
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.
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.
Filtrar las facturas de venta por el id del item.
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.
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.
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.
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.
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.
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.
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.
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.
Filtrar las facturas que necesitan ser sustituidas de un cliente. Cuando este campo se envía, es obligatorio enviar el campo client_id.
Al enviar este parametro solicitas unicamente la descarga del PDF de hasta 10 facturas.
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.
Response
Retorna la lista de facturas