v1

latestOpenAPI 3.0.32026-07-24398641.3 MB
Remisiones

Lista de remisiones

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"}

get/remissions

Query parameters

startinteger

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

limitinteger

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_directionstring

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

order_fieldstring

Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate.

metadataboolean

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_idstring

Filtra las remisiones por id del cliente.

attachmentboolean

Retornar los archivos adjuntos de la órden de compra.

item_idstring

Filtra las remisiones por id del item.

numberstring

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

client_namestring

Nombre del cliente el cual se desea filtrar las remisiones.

datestring date

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

dueDatestring date

Fecha de vencimiento la cual se desea filtrar las remisiones.

statusstring

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

Response

Retorna un arreglo con las remisiones encontradas