{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/purchase-orders","auth":"required","settings":"","results":{"codes":[{"name":"","code":"[\n    {\n        \"id\": \"1\",\n        \"date\": \"2020-07-14\",\n        \"deliveryDate\": \"2020-08-13\",\n        \"observations\": \"\",\n        \"anotation\": \"notas de la órdenes de compra\",\n        \"termsConditions\": \"Terminos y condiciones de la órden de compra\",\n        \"status\": \"open\",\n        \"provider\": {\n            \"id\": \"1\",\n            \"name\": \"Cliente 1\",\n            \"identification\": \"\",\n            \"phonePrimary\": \"\",\n            \"phoneSecondary\": \"\",\n            \"fax\": \"\",\n            \"mobile\": \"\",\n            \"email\": \"\"\n        },\n        \"warehouse\": {\n            \"name\": \"Principal\",\n            \"observations\": null,\n            \"isDefault\": true,\n            \"address\": null,\n            \"status\": \"active\",\n            \"id\": \"1\",\n            \"costCenter\": null\n        },\n        \"subTotal\": 100,\n        \"total\": 100,\n        \"decimalPrecision\": \"0\",\n        \"numberTemplate\": {\n            \"number\": \"1\",\n            \"prefix\": null,\n            \"id\": \"7\"\n        },\n        \"purchases\": {\n            \"items\": [\n                {\n                    \"id\": 2,\n                    \"name\": \"Item 2\",\n                    \"reference\": null,\n                    \"description\": null,\n                    \"price\": 100,\n                    \"discount\": \"0.00\",\n                    \"quantity\": \"1.00\",\n                    \"tax\": [],\n                    \"total\": 100\n                }\n            ]\n        }\n    }\n]","language":"json","status":200}]},"params":[{"name":"start","type":"int","default":"","desc":"Desde cual órden de compra se quiere consultar. Por ejemplo para consultar desde la órden de compra 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b908000"},{"name":"limit","type":"int","default":"","desc":"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.","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b907fff"},{"name":"order_direction","type":"string","default":"","desc":"Orden ascendente o descendente en el cual se quieren retornar las órdenes de compra.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b907ffe"},{"name":"order_field","type":"string","default":"","desc":"Campo por el cual se desea ordenar, las opciones posibles son `id`, `date`, `dueDate`, `name (contacto)`, `deliveryDate`y `status`.","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b907ffd"},{"name":"metadata","type":"boolean","default":"","desc":"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.","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b907ffc"},{"name":"client_id","type":"int","default":"","desc":"Filtra las órdenes de compra por id del cliente.","required":false,"in":"query","ref":"","_id":"5f0e083fa0d9b6018b907ffb"},{"name":"id","type":"int","default":"","desc":"Filtra las órdenes de compra por el id de la órden de compra.","required":false,"in":"query","ref":"","_id":"5f622726acab420051032e31"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Filtra las órdenes de compra por la fecha.","required":false,"in":"query","ref":"","_id":"5f6227cb2d1876005ee2741d"},{"name":"status","type":"string","default":"","desc":"Filtra las órdenes de compra por el estado, las opciones disponibles son `open`, `closed` y `void`.","required":false,"in":"query","ref":"","_id":"5f6227cb2d1876005ee2741c"},{"name":"item_id","type":"int","default":"","desc":"Filtra las órdenes de compra por el id del item asociado.","required":false,"in":"query","ref":"","_id":"5f62288c4f66fe006b83205d"},{"name":"provider_name","type":"string","default":"","desc":"Filtra las órdenes de compra por el nombre del cliente asociado.","required":false,"in":"query","ref":"","_id":"5f62288c4f66fe006b83205c"},{"name":"number","type":"string","default":"","desc":"Numeración de la órden de compra por la cual se desea filtrar, se puede especificar el prefijo y el numero.","required":false,"in":"query","ref":"","_id":"5f6cad060c64e3002c5587c2"},{"name":"delivery_date","type":"yyyy-mm-dd","default":"","desc":"Fecha de entrega de la órden de compra la cual se desea filtrar.","required":false,"in":"query","ref":"","_id":"5f6cad060c64e3002c5587c1"},{"name":"status","type":"string","default":"","desc":"Estado de la órden de compra el cual se desea filtrar, las opciones disponibles son: `open`, `void` y `closed`.","required":false,"in":"query","ref":"","_id":"5f6cad060c64e3002c5587c0"}],"examples":{"codes":[{"code":"   curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET    https://api.alegra.com/api/v1/purchase-orders/ -u 'usuario:::at:::alegra.com:mitoken'","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Lista de Órdenes de compra","type":"endpoint","slug":"lista-de-órdenes-de-compra","excerpt":"Endpoint que permite consultar todas las órdenes de compra registradas en la aplicación","body":"Endpoint que retorna las órdenenes de compra registradas en la cuenta de Alegra. Si no se envía límite, por defecto se envían 30 órdenes de compra.","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f0e05a3f5187a01ead5b46b","createdAt":"2020-07-14T19:21:07.670Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Órdenes de Compra","slug":"órdenes-de-compra","order":26,"from_sync":false,"reference":false,"_id":"5e9f0d4c720ad8006c6c7dc1","createdAt":"2020-04-21T15:12:12.508Z","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":0},"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22","5fc1133c51c8370081b28e2a"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":44,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":7,"parentDoc":null}