{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/journals/","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/journals/ -u 'usuario:::at:::alegra.com:mitoken'"}]},"results":{"codes":[{"status":200,"language":"json","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\": \"[email protected]\",\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        \"client\": {\n          \"id\": 1,\n          \"name\": \"Coorporación Alegrate\",\n          \"identification\": \"159.549.847\",\n          \"email\": \"[email protected]\",\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      },\n      {\n        \"id\": 5,\n        \"name\": \"Ingresos financieros\",\n        \"description\": \"\",\n        \"debit\": 0,\n        \"credit\": 80.00,\n        \"client\": {\n          \"id\": 1,\n          \"name\": \"Coorporación Alegrate\",\n          \"identification\": \"159.549.847\",\n          \"email\": \"[email protected]\",\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      }\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        \"client\": {\n          \"id\": 1,\n          \"name\": \"Coorporación Alegrate\",\n          \"identification\": \"159.549.847\",\n          \"email\": \"[email protected]\",\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        \"costCenter\": {\n          \"id\": \"1\",\n          \"code\": \"CC01\",\n          \"name\": \"Centro 1\",\n          \"description\": \"Centro de costo 1\",\n          \"status\": \"active\"\n        }\n      },\n      {\n        \"id\": 5,\n        \"name\": \"Otros ingresos\",\n        \"description\": \"\",\n        \"debit\": 0,\n        \"credit\": 40.00,\n        \"client\": null\n      }\n    ]\n  }\n]","name":"Ejemplo consulta exitosa"},{"status":400,"language":"json","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}","name":"Bad Request - Límite sobrepasa máximo permitido"}]},"settings":"","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual ajuste contable se quiere consultar. Por ejemplo para consultar desde el ajuste 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a26"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de ajustes contables a partir del inicio que se desea retornar. Por defecto retorna 30 ajustes. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a25"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar los ajustes contables.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a24"},{"name":"order_field","type":"string","default":"date","desc":"Campo por el cual se desea ordenar, las opciones posibles son date, name, reference, observations.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a23"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Filtrar resultados según fecha de creación del ajuste contable. Se retornarán todos los ajustes que su fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a22"},{"name":"client_name","type":"string","default":"","desc":"Filtrar resultados según el nombre del cliente del ajuste contable. Se retornarán todos los ajustes que estén asociadas a un cliente que en su nombre contenga el valor enviado en este parámetro.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a21"},{"name":"reference","type":"string","default":"","desc":"Filtrar resultados según la referencia del ajuste contables. Se retornarán todos los ajustes que en su referencia (atributo: reference) contenga el valor enviado en este parámetro.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a20"},{"name":"observations","type":"string","default":"","desc":"Filtrar resultados según las observaciones del ajuste contable. Se retornarán todos los ajustes que en sus observaciones (atributo: observations) contenga el valor enviado en este parámetro.","required":false,"in":"query","ref":"","_id":"5c4f73492b49e600573b2a1f"},{"name":"client_id","type":"int","default":"","desc":"Filtra los resultador por id del cliente.","required":false,"in":"query","ref":"","_id":"5f0cf56cc9c07400369283aa"},{"name":"id","type":"int","default":"","desc":"Filtrar por el número del ajuste contable.","required":false,"in":"query","ref":"","_id":"5f89b7eddc052800264ea69a"}]},"next":{"description":"","pages":[]},"title":"Lista de ajustes contables","type":"endpoint","slug":"lista-de-ajustes-de-categorías","excerpt":"Endpoint que permite consultar los ajustes contables registrados en la aplicación","body":"Endpoint que retorna los ajustes contables registrados en la cuenta de Alegra.  Si no se envía límite de ajustes, 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]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c4f73492b49e600573b2a1e","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","5fc1133c51c8370081b28e2a","60807d7adc33b10010370740","60d30b1745665d00237faa55","60d30b2efa7b7200235a3c93","61006d2332a29f00801deea2"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":48,"createdAt":"2016-01-29T20:57:39.712Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Ajustes contables","slug":"ajustes-de-categorías","order":19,"from_sync":false,"reference":false,"_id":"5c4f5c0e1555130014796daa","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2019-01-28T19:46:22.091Z","__v":1},"user":"5a2184feb778240012e38415","createdAt":"2019-01-28T21:25:29.209Z","__v":14,"parentDoc":null}

getLista de ajustes contables

Endpoint que permite consultar los ajustes contables registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual ajuste contable se quiere consultar. Por ejemplo para consultar desde el ajuste 20, se envía start=20.
limit:
integer30
Cantidad de ajustes contables a partir del inicio que se desea retornar. Por defecto retorna 30 ajustes. 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 contables. 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 contable. Se retornarán todos los ajustes 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 contable. Se retornarán todos los ajustes 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 contables. Se retornarán todos los ajustes que en su referencia (atributo: reference) contenga el valor enviado en este parámetro.
observations:
string
Filtrar resultados según las observaciones del ajuste contable. Se retornarán todos los ajustes que en sus observaciones (atributo: observations) contenga el valor enviado en este parámetro.
client_id:
integer
Filtra los resultador por id del cliente.
id:
integer
Filtrar por el número del ajuste contable.

Examples


Result Format


Documentation

Endpoint que retorna los ajustes contables registrados en la cuenta de Alegra. Si no se envía límite de ajustes, 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 }}