v1

latestOpenAPI 3.0.32026-07-24398641.3 MB
Órdenes de compra

Retorna la lista de órdenes de compra

Endpoitn para obtener una lista de ordenes de compra

get/purchase-orders

Query parameters

startinteger

Desde cual órden de compra se quiere consultar. Por ejemplo para consultar desde la órden de compra 20, se envía start=20.

limitinteger

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

order_direction'DESC' | 'ASC'

Orden ascendente o descendente en el cual se quieren retornar las órdenes de compra.

order_field'id' | 'date' | 'dueDate' | 'name (contacto)' | 'deliveryDate' | 'status'

Campo por el cual se desea ordenar.

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 las órdenes de compra que tiene registrada la empresa.

client_idstring

Filtra las órdenes de compra por id del cliente.

idinteger

Identificador único que representa una órden de compra específica. La aplicación lo asigna automáticamente.

datestring yyyy-mm-dd

Fecha de la órden de compra.

status'open' | 'close' | 'void'

Notas de la órden de compra.

item_idinteger

Filtra las órdenes de compra por el id del item asociado.

provider_namestring

Filtra las órdenes de compra por el nombre del cliente asociado.

numberstring

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

delivery_datestring

Fecha de entrega de la órden de compra la cual se desea filtrar.

Response

Se obtiene un arreglo de las órdenes de compra encontradas