{"_id":"5d77c5e58cacc70041361194","project":"56abd2434e4b730d009eb10a","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":28,"createdAt":"2016-01-29T20:57:39.712Z","releaseDate":"2016-01-29T20:57:39.712Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"5d76e2018e0ce7006c82dbe1","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-09-09T23:36:33.957Z","from_sync":false,"order":21,"slug":"remisiones","title":"Remisiones"},"user":"56abd213d4432d1900eed227","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-10T15:48:53.224Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"   curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET    https://app.alegra.com/api/v1/remissions/ -u 'usuario:::at:::alegra.co:mitoken'","language":"curl"}]},"results":{"codes":[{"status":200,"language":"json","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\": \"usuario@alegra.com\",\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\": \"usuario@alegra.com\",\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]","name":"Ejemplo consulta exitosa"},{"status":400,"language":"json","code":"{ \n  \"error\": \"El límite de remisiones para retornar debe ser menor o igual a 30\",\n  \"code\" : 903\n}","name":"Bad Request - Límite sobrepasa máximo permitido"},{"name":"Consulta exitosa con metadatos","status":200,"language":"json","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\": \"usuario@alegra.com\",\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\": \"usuario@alegra.com\",\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}"}]},"settings":"","auth":"required","params":[{"_id":"5d77c5e58cacc70041361199","ref":"","in":"query","required":false,"desc":"Desde cual remisión se quiere consultar. Por ejemplo para consultar desde la remisión 20, se envía start=20.","default":"0","type":"int","name":"start"},{"_id":"5d77c5e58cacc70041361198","ref":"","in":"query","required":false,"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.","default":"30","type":"int","name":"limit"},{"_id":"5d77c5e58cacc70041361197","ref":"","in":"query","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar las remisiones.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","default":"ASC","type":"string","name":"order_direction"},{"_id":"5d77c5e58cacc70041361196","ref":"","in":"query","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate.","default":"date","type":"string","name":"order_field"},{"_id":"5d77c5e58cacc70041361195","ref":"","in":"query","required":false,"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.","default":"","type":"boolean","name":"metadata"}],"url":"/remissions/"},"isReference":false,"order":1,"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]","excerpt":"Endpoint que permite consultar todas las remisiones registradas en la aplicación","slug":"lista-de-remisiones","type":"endpoint","title":"Lista de remisiones"}

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.

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