Lista de remisiones

get

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

Endpoint que permite consultar una remisión registrada en la aplicación. Si no se envía límite de remisiones, por defecto se envían 30 remisiones.

Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error: {"code":903, "message": "El límite debe ser menor o igual a 30"}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

Desde cual remisión se quiere consultar. Por ejemplo para consultar desde la remisión 20, se envía start=20.

limit

integer

Cantidad de remisiones a partir del inicio que se desea retornar. Por defecto retorna 30 remisiones. 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 remisiones. 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.

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

client_id

string

Filtra las remisiones por id del cliente.

attachment

boolean

Retornar los archivos adjuntos de la órden de compra.

item_id

string

Filtra las remisiones por id del item.

number

string

Numeración de la remisión por la cual se desea filtrar, se puede especificar el prefijo y el numero.

client_name

string

Nombre del cliente el cual se desea filtrar las remisiones.

date

Fecha de la remisión la cual se desea filtrar.

dueDate

date

Fecha de vencimiento la cual se desea filtrar las remisiones.

status

string

Estado de la remisión el cual se desea filtrar, las opciones disponibles son: open, void y closed.

Responses

200Retorna un arreglo con las remisiones encontradas

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