{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/remissions/","auth":"required","method":"get","examples":{"codes":[{"language":"curl","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'"}]},"results":{"codes":[{"name":"Ejemplo consulta exitosa","code":"[\n    {\n        \"id\": \"1\",\n        \"number\": \"1\",\n        \"documentName\": \"remission\",\n        \"date\": \"2019-08-30\",\n        \"dueDate\": \"2019-08-30\",\n        \"observations\": \"\",\n        \"anotation\": \"\",\n        \"status\": \"open\",\n        \"client\": {\n            \"id\": \"1\",\n            \"name\": \"Usuario Alegra\",\n            \"identification\": \"1234567890\",\n            \"phonePrimary\": \"123456789\",\n            \"fax\": \"\",\n            \"mobile\": \"\",\n            \"email\": \"[email protected]\",\n            \"address\": {\n                \"address\": null,\n                \"city\": \"Bogota\"\n            }\n        },\n        \"total\": 110000,\n        \"seller\": null,\n        \"priceList\": {\n            \"id\": \"1\",\n            \"name\": \"General\"\n        },\n        \"warehouse\": {\n            \"id\": \"1\",\n            \"name\": \"Principal\"\n        },\n        \"items\": [\n            {\n                \"id\": 1,\n                \"name\": \"Item 1\",\n                \"description\": \"\",\n                \"price\": 100000,\n                \"discount\": \"0.00\",\n                \"reference\": \"\",\n                \"quantity\": \"1.00\",\n                \"tax\": [],\n                \"total\": 100000\n            },\n            {\n                \"id\": 2,\n                \"name\": \"Item 2\",\n                \"description\": \"\",\n                \"price\": 2000,\n                \"discount\": \"0.00\",\n                \"reference\": \"\",\n                \"quantity\": \"1.00\",\n                \"tax\": [],\n                \"total\": 2000\n            }\n        ]\n    },\n    {\n        \"id\": \"2\",\n        \"number\": \"2\",\n        \"documentName\": \"serviceOrder\",\n        \"date\": \"2019-08-30\",\n        \"dueDate\": \"2019-08-30\",\n        \"observations\": \"\",\n        \"anotation\": \"\",\n        \"status\": \"open\",\n        \"client\": {\n            \"id\": \"1\",\n            \"name\": \"Usuario Alegra\",\n            \"identification\": \"1234567890\",\n            \"phonePrimary\": \"123456789\",\n            \"fax\": \"\",\n            \"mobile\": \"\",\n            \"email\": \"[email protected]\",\n            \"address\": {\n                \"address\": null,\n                \"city\": \"Bogota\"\n            }\n        },\n        \"total\": 110000,\n        \"seller\": null,\n        \"priceList\": {\n            \"id\": \"1\",\n            \"name\": \"General\"\n        },\n        \"warehouse\": {\n            \"id\": \"1\",\n            \"name\": \"Principal\"\n        },\n        \"items\": [\n            {\n                \"id\": 1,\n                \"name\": \"Item 1\",\n                \"description\": \"\",\n                \"price\": 100000,\n                \"discount\": \"0.00\",\n                \"reference\": \"\",\n                \"quantity\": \"1.00\",\n                \"tax\": [],\n                \"total\": 100000\n            },\n            {\n                \"id\": 2,\n                \"name\": \"Item 2\",\n                \"description\": \"\",\n                \"price\": 2000,\n                \"discount\": \"0.00\",\n                \"reference\": \"\",\n                \"quantity\": \"1.00\",\n                \"tax\": [],\n                \"total\": 2000\n            }\n        ]\n    }\n]","language":"json","status":200},{"name":"Bad Request - Límite sobrepasa máximo permitido","code":"{ \n  \"error\": \"El límite de remisiones para retornar debe ser menor o igual a 30\",\n  \"code\" : 903\n}","language":"json","status":400},{"code":"{\n  \"metadata\" : {\n    \"total\" : 15\n  },\n  \"data\" : [\n      [\n        {\n            \"id\": \"1\",\n            \"number\": \"1\",\n            \"documentName\": \"remission\",\n            \"date\": \"2019-08-30\",\n            \"dueDate\": \"2019-08-30\",\n            \"observations\": \"\",\n            \"anotation\": \"\",\n            \"status\": \"open\",\n            \"client\": {\n                \"id\": \"1\",\n                \"name\": \"Usuario Alegra\",\n                \"identification\": \"1234567890\",\n                \"phonePrimary\": \"123456789\",\n                \"fax\": \"\",\n                \"mobile\": \"\",\n                \"email\": \"[email protected]\",\n                \"address\": {\n                    \"address\": null,\n                    \"city\": \"Bogota\"\n                }\n            },\n            \"total\": 110000,\n            \"seller\": null,\n            \"priceList\": {\n                \"id\": \"1\",\n                \"name\": \"General\"\n            },\n            \"warehouse\": {\n                \"id\": \"1\",\n                \"name\": \"Principal\"\n            },\n            \"items\": [\n                {\n                    \"id\": 1,\n                    \"name\": \"Item 1\",\n                    \"description\": \"\",\n                    \"price\": 100000,\n                    \"discount\": \"0.00\",\n                    \"reference\": \"\",\n                    \"quantity\": \"1.00\",\n                    \"tax\": [],\n                    \"total\": 100000\n                },\n                {\n                    \"id\": 2,\n                    \"name\": \"Item 2\",\n                    \"description\": \"\",\n                    \"price\": 2000,\n                    \"discount\": \"0.00\",\n                    \"reference\": \"\",\n                    \"quantity\": \"1.00\",\n                    \"tax\": [],\n                    \"total\": 2000\n                }\n            ]\n         },\n         {\n              \"id\": \"2\",\n              \"number\": \"2\",\n              \"documentName\": \"serviceOrder\",\n              \"date\": \"2019-08-30\",\n              \"dueDate\": \"2019-08-30\",\n              \"observations\": \"\",\n              \"anotation\": \"\",\n              \"status\": \"open\",\n              \"client\": {\n                  \"id\": \"1\",\n                  \"name\": \"Usuario Alegra\",\n                  \"identification\": \"1234567890\",\n                  \"phonePrimary\": \"123456789\",\n                  \"fax\": \"\",\n                  \"mobile\": \"\",\n                  \"email\": \"[email protected]\",\n                  \"address\": {\n                      \"address\": null,\n                      \"city\": \"Bogota\"\n                  }\n              },\n              \"total\": 110000,\n              \"seller\": null,\n              \"priceList\": {\n                  \"id\": \"1\",\n                  \"name\": \"General\"\n              },\n              \"warehouse\": {\n                  \"id\": \"1\",\n                  \"name\": \"Principal\"\n              },\n              \"items\": [\n                  {\n                      \"id\": 1,\n                      \"name\": \"Item 1\",\n                      \"description\": \"\",\n                      \"price\": 100000,\n                      \"discount\": \"0.00\",\n                      \"reference\": \"\",\n                      \"quantity\": \"1.00\",\n                      \"tax\": [],\n                      \"total\": 100000\n                  },\n                  {\n                      \"id\": 2,\n                      \"name\": \"Item 2\",\n                      \"description\": \"\",\n                      \"price\": 2000,\n                      \"discount\": \"0.00\",\n                      \"reference\": \"\",\n                      \"quantity\": \"1.00\",\n                      \"tax\": [],\n                      \"total\": 2000\n                  }\n              ]\n          }\n    \t ]\n    ]\n}","language":"json","status":200,"name":"Consulta exitosa con metadatos"}]},"settings":"","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual remisión se quiere consultar. Por ejemplo para consultar desde la remisión 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5d77c5e58cacc70041361199"},{"name":"limit","type":"int","default":"30","desc":"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.","required":false,"in":"query","ref":"","_id":"5d77c5e58cacc70041361198"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar las remisiones.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"5d77c5e58cacc70041361197"},{"name":"order_field","type":"string","default":"date","desc":"Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate.","required":false,"in":"query","ref":"","_id":"5d77c5e58cacc70041361196"},{"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 remisiones que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"5d77c5e58cacc70041361195"},{"name":"client_id","type":"int","default":"","desc":"Filtra las remisiones por id del cliente.","required":false,"in":"query","ref":"","_id":"5f0cf570a0b6ba00537f579c"},{"name":"attachment","type":"boolean","default":"","desc":"Retornar los archivos adjuntos de la órden de compra.","required":false,"in":"query","ref":"","_id":"5f0e07d94a93f8005f43c137"},{"name":"item_id","type":"string","default":"","desc":"Filtra las remisiones por id del item.","required":false,"in":"query","ref":"","_id":"5f2047f11f7362024294845f"},{"name":"number","type":"string","default":"","desc":"Numeración de la remisión por la cual se desea filtrar, se puede especificar el prefijo y el numero.","required":false,"in":"query","ref":"","_id":"5f6cac6ae7cee9005213dc3a"},{"name":"client_name","type":"string","default":"","desc":"Nombre del cliente el cual se desea filtrar las remisiones.","required":false,"in":"query","ref":"","_id":"5f6cac6ae7cee9005213dc39"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la remisión la cual se desea filtrar.","required":false,"in":"query","ref":"","_id":"5f6cac6ae7cee9005213dc38"},{"name":"due_date","type":"yyyy-mm-dd","default":"","desc":"Fecha de vencimiento la cual se desea filtrar las remisiones.","required":false,"in":"query","ref":"","_id":"5f6cac6ae7cee9005213dc37"},{"name":"status","type":"string","default":"","desc":"Estado de la remisión el cual se desea filtrar, las opciones disponibles son: `open`, `void` y `closed`.","required":false,"in":"query","ref":"","_id":"5f6cac6ae7cee9005213dc36"}]},"next":{"description":"","pages":[]},"title":"Lista de remisiones","type":"endpoint","slug":"lista-de-remisiones","excerpt":"Endpoint que permite consultar todas las remisiones registradas en la aplicación","body":"Endpoint que retorna las remisiones registradas en la cuenta de Alegra. Si no se envía límite de remisiones, por defecto se envían 30 remisiones.  \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"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:\\n```\\n{\\n  \\\"code\\\": 903,\\n  \\\"message\\\" : \\\"El límite debe ser menor o igual a 30\\\"\\n}\\n```\"\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d77c5e58cacc70041361194","project":"56abd2434e4b730d009eb10a","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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Remisiones","slug":"remisiones","order":24,"from_sync":false,"reference":false,"_id":"5d76e2018e0ce7006c82dbe1","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2019-09-09T23:36:33.957Z","__v":0},"user":"56abd213d4432d1900eed227","createdAt":"2019-09-10T15:48:53.224Z","__v":11,"parentDoc":null}

getLista de remisiones

Endpoint que permite consultar todas las remisiones registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual remisión se quiere consultar. Por ejemplo para consultar desde la remisión 20, se envía start=20.
limit:
integer30
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:
stringASC
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:
stringdate
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:
integer
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:
yyyy-mm-dd
Fecha de la remisión la cual se desea filtrar.
due_date:
yyyy-mm-dd
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`.

Examples


Result Format


Documentation

Endpoint que retorna las remisiones registradas en la cuenta de Alegra. Si no se envía límite de remisiones, por defecto se envían 30 remisiones. [block:callout] { "type": "warning", "title": "Atención", "body": "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:\n```\n{\n \"code\": 903,\n \"message\" : \"El límite debe ser menor o igual a 30\"\n}\n```" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}