Lista de facturas de proveedor

get

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

Endpoint que permite consultar las facturas de proveedor registradas en la aplicación

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

metadata

boolean

Defaults to false

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.

start

integer

≥ 0

Desde cuál factura de proveedor se quiere consultar. Por ejemplo para consultar desde la factura de proveedor 20, se envía start=20.

limit

integer

≤ 30

Defaults to 30

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

order_direction

string

enum

Defaults to ASC

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

Allowed:

order_field

string

enum

Campo por el cual se desea ordenar.

Allowed:

billNumber

string

Filtrar resultados según el número de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo número coincida total o parcialmente con el valor enviado en este parámetro.

client_name

string

Filtrar resultados según según el nombre del cliente de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo nombre de cliente coincida total o parcialmente con el valor enviado en este parámetro.

date

Filtrar resultados según la fecha de creación de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya 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 la fecha de vencimiento de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya de vencimiento (atributo dueDate) coincida exactamente con el valor enviado en este parámetro. El formato para la fecha es YYYY-MM-DD.

status

string

Filtra resultados según el estado de la factura de proveedor. Las opciones disponibles son open, closed y void.

item_id

integer

Filtrar las facturas de proveedor por el id del item.

client_id

integer

Filtra las facturas por id del cliente (proveedor).

provider_name

string

Filtrar resultados según el nombre del proveedor de la factura. Se retornarán todas las facturas de proveedor cuyo nombre de proveedor coincida total o parcialmente con el valor enviado en este parámetro.

uuid

string

Para Mexico se pueden filtrar los resultados segun el parámetro uuid de la factura de proveedor.

purchaseOrder_id

integer

Filtras las facturas de proveedor por id de la orden de compra.

type

string

enum

Defaults to bill

Para el caso donde se cuente con diferentes tipos de factura de proveedor, permite obtener el tipo deseado. Colombia permite el valor supportDocument para listar documentos soporte, bill para facturas de proveedor y all para listar ambos tipos.

Allowed:

Responses

200Se obtiene una lista que contiene facturas de proveedor

400El parámetro "límite" supero el valor de 30