{"_id":"5c4f73492b49e600573b2a1e","project":"56abd2434e4b730d009eb10a","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":26,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"5c4f5c0e1555130014796daa","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-01-28T19:46:22.091Z","from_sync":false,"order":18,"slug":"ajustes-de-categorías","title":"Ajustes de Categorías"},"user":"5a2184feb778240012e38415","__v":7,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-28T21:25:29.209Z","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/journals/ -u 'usuario:::at:::alegra.co:mitoken'","language":"curl"}]},"results":{"codes":[{"name":"Ejemplo consulta exitosa","code":"[\n  {\n    \"id\": 2,\n    \"date\": \"2019-01-28\",\n    \"reference\": \"\",\n    \"observations\": \"Observaciones del ajuste\",\n    \"total\": 80.00,\n    \"client\": {\n      \"id\": 1,\n      \"name\": \"Coorporación Alegrate\",\n      \"identification\": \"159.549.847\",\n      \"email\": \"prueba@alegra.com\",\n      \"phonePrimary\": \"999-99-99\",\n      \"phoneSecondary\": \"\",\n      \"fax\": \"\",\n      \"mobile\": \"(333) 555-55-55\",\n      \"address\": {\n        \"address\": \"Calle principal #45\",\n        \"city\": \"Barcelona\"\n      }\n    },\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Caja General\",\n        \"description\": \"\",\n        \"debit\": 80.00,\n        \"credit\": 0\n      },\n      {\n        \"id\": 5,\n        \"name\": \"Ingresos financieros\",\n        \"description\": \"\",\n        \"debit\": 0,\n        \"credit\": 80.00\n      }\n    ]\n  },\n  {\n    \"id\": 1,\n    \"date\": \"2019-01-26\",\n    \"reference\": \"\",\n    \"observations\": null,\n    \"total\": 40.00,\n    \"client\": null,\n    \"entries\": [\n      {\n        \"id\": 1,\n        \"name\": \"Caja General\",\n        \"description\": \"\",\n        \"debit\": 40.00,\n        \"credit\": 0\n      },\n      {\n        \"id\": 5,\n        \"name\": \"Otros ingresos\",\n        \"description\": \"\",\n        \"debit\": 0,\n        \"credit\": 40.00\n      }\n    ]\n  }\n]","language":"json","status":200},{"name":"Bad Request - Límite sobrepasa máximo permitido","code":"{ \n\t\"error\": \"El límite de ajustes de categorías para retornar debe estar entre 0 y 30\",\n\t\"code\" : 903\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5c4f73492b49e600573b2a26","ref":"","in":"query","required":false,"desc":"Desde cual ajuste de categoría se quiere consultar. Por ejemplo para consultar desde el ajuste de categoría 20, se envía start=20.","default":"0","type":"int","name":"start"},{"_id":"5c4f73492b49e600573b2a25","ref":"","in":"query","required":false,"desc":"Cantidad de ajustes de categorías a partir del inicio que se desea retornar.  Por defecto retorna 30 ajustes de categorías. Si este valor es mayor que 30, la aplicación retorna error.","default":"30","type":"int","name":"limit"},{"_id":"5c4f73492b49e600573b2a24","ref":"","in":"query","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar los ajustes de categorías.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","default":"ASC","type":"string","name":"order_direction"},{"_id":"5c4f73492b49e600573b2a23","ref":"","in":"query","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son date, name, reference, observations.","default":"date","type":"string","name":"order_field"},{"_id":"5c4f73492b49e600573b2a22","ref":"","in":"query","required":false,"desc":"Filtrar resultados según fecha de creación del ajuste de categorías. Se retornarán todos los ajustes de categorías que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.","default":"","type":"yyyy-mm-dd","name":"date"},{"_id":"5c4f73492b49e600573b2a21","ref":"","in":"query","required":false,"desc":"Filtrar resultados según el nombre del cliente del ajuste de categorías. Se retornarán todos los ajustes de categorías que estén asociadas a un cliente que en su nombre contenga el valor enviado en este parámetro.","default":"","type":"string","name":"client_name"},{"_id":"5c4f73492b49e600573b2a20","ref":"","in":"query","required":false,"desc":"Filtrar resultados según la referencia del ajuste de categorías. Se retornarán todos los ajustes de categorías que en su referencia (atributo: reference) contenga el valor enviado en este parámetro.","default":"","type":"string","name":"reference"},{"_id":"5c4f73492b49e600573b2a1f","ref":"","in":"query","required":false,"desc":"Filtrar resultados según las observaciones del ajuste de categorías. Se retornarán todos los ajustes de categorías que en sus observaciones (atributo: observations) contenga el valor enviado en este parámetro.","default":"","type":"string","name":"observations"}],"url":"/journals/"},"isReference":false,"order":1,"body":"Endpoint que retorna los ajustes de categorías registrados en la cuenta de Alegra.  Si no se envía límite de ajustes de categorías, por defecto se envían 30 ajustes de categorías.\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 los ajustes de categorías registrados en la aplicación","slug":"lista-de-ajustes-de-categorías","type":"endpoint","title":"Lista de ajustes de categorías"}

getLista de ajustes de categorías

Endpoint que permite consultar los ajustes de categorías registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual ajuste de categoría se quiere consultar. Por ejemplo para consultar desde el ajuste de categoría 20, se envía start=20.
limit:
integer30
Cantidad de ajustes de categorías a partir del inicio que se desea retornar. Por defecto retorna 30 ajustes de categorías. 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 los ajustes de categorías. 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 date, name, reference, observations.
date:
yyyy-mm-dd
Filtrar resultados según fecha de creación del ajuste de categorías. Se retornarán todos los ajustes de categorías que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.
client_name:
string
Filtrar resultados según el nombre del cliente del ajuste de categorías. Se retornarán todos los ajustes de categorías que estén asociadas a un cliente que en su nombre contenga el valor enviado en este parámetro.
reference:
string
Filtrar resultados según la referencia del ajuste de categorías. Se retornarán todos los ajustes de categorías que en su referencia (atributo: reference) contenga el valor enviado en este parámetro.
observations:
string
Filtrar resultados según las observaciones del ajuste de categorías. Se retornarán todos los ajustes de categorías que en sus observaciones (atributo: observations) contenga el valor enviado en este parámetro.

Examples


Result Format


Documentation

Endpoint que retorna los ajustes de categorías registrados en la cuenta de Alegra. Si no se envía límite de ajustes de categorías, por defecto se envían 30 ajustes de categorías. [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 }}