{"_id":"56b269c2a5a1020d00cf4cdf","editedParams2":true,"parentDoc":null,"version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":30,"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","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"56abd2434e4b730d009eb10a","__v":5,"editedParams":true,"githubsync":"","user":"56abd213d4432d1900eed227","category":{"_id":"56b4b4085997532100bc6b61","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:39:04.628Z","from_sync":false,"order":11,"slug":"categorías","title":"Categorías"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T20:57:38.658Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"Formato plano","language":"json","code":"[\n  { \n    \"id\" : \"3\",\n    \"idParent\" : \"1\",\n    \"name\" : \"Ventas\",\n    \"description\" : \"Bajo Esta categoría se encuentran todos los ingresos principales.\",\n    \"type\" : \"income\",\n    \"readOnly\" : false,\n    \"categoryRule\": {\n    \t\t\"id\": \"1\",\n        \"name\": \"Activos\",\n        \"key\": \"ASSETS\"\n    }\n   },\n   {\n     \"id\" : \"15\",\n     \"idParent\" : \"3\",\n     \"name\" : \"Computadores\",\n     \"description\" : \"Categoría de venta de computadores\",\n     \"type\" : \"income\",\n     \"readOnly\" : false,\n     \"categoryRule\": {\n        \"id\": \"5\",\n        \"name\": \"Cuentas por cobrar\",\n        \"key\": \"RECEIVABLE_ACCOUNTS\"\n     }\n    },\n    {\n    \"id\" : \"25\",\n    \"idParent\" : \"\",\n    \"name\" : \"Compras inventariables\",\n    \"description\" : \"\",\n    \"type\" : \"expense\",,\n    \"readOnly\" : true\n    }\n]","status":200},{"code":"[\n  {\n    \"id\": \"1\",\n    \"type\": \"income\",\n    \"description\": \"Bajo esta categoría se encuentran todos los tipos de ingresos.\",\n    \"readOnly\": false,\n    \"name\": \"Ingresos no operacionales\",\n    \"categoryRule\": {\n    \t\t\"id\": \"1\",\n        \"name\": \"Activos\",\n        \"key\": \"ASSETS\"\n    },\n    \"children\": [\n    {\n    \t\"id\": \"3\",\n      \"type\": \"income\",\n      \"description\": \"Bajo Esta categoría se encuentran todos los ingresos principales.\",\n      \"children\": [ ],\n      \"readOnly\": false,\n      \"name\": \"Ventas\",\n      \"categoryRule\": {\n    \t\t\"id\": \"1\",\n        \"name\": \"Activos\",\n        \"key\": \"ASSETS\"\n      }\n     },\n     {\n       \"id\": \"28\",\n       \"type\": \"income\",\n       \"description\": \"\",\n       \"children\": [\n         {\n           \"id\": \"10\",\n           \"type\": \"income\",\n           \"description\": \"Ingresos por intereses bancarios\",\n           \"children\": [ ],\n           \"readOnly\": false,\n           \"name\": \"Ingresos por Interés\"\n       }\n   \t   ],\n       },\n      {\n        \"id\": \"29\",\n        \"type\": \"income\",\n        \"description\": \"\",\n        \"children\": [ ],\n        \"readOnly\": false,\n        \"name\": \"Devoluciones en ventas\",\n        \"categoryRule\": {\n          \"id\": \"1\",\n          \"name\": \"Activos\",\n          \"key\": \"ASSETS\"\n\t\t    }\n      }\n    ]\n  }\n]","name":"Formato árbol","language":"json"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/categories/ -u 'usuario:::at:::alegra.co:mitoken'"}]},"method":"get","auth":"required","params":[{"_id":"56b269c2a5a1020d00cf4ce1","ref":"","in":"query","required":false,"desc":"Formato de las categorías. Las opciones posibles son 'plain' para que se retornen en un array (sin relacionar categorías padres con categorías hijas) o 'tree' para que se envíen las categorías como un árbol, en este caso se omite el atributo idParent. El formato por defecto es 'tree'.","default":"tree","type":"string","name":"format"},{"_id":"56b269c2a5a1020d00cf4ce0","ref":"","in":"query","required":false,"desc":"Retornar las categorías clasificadas en el tipo indicado. Las opciones posibles son income, expense, equity, asset, liability.","default":"","type":"string","name":"type"},{"_id":"5d76e0f73451d7042c52a013","ref":"","in":"query","required":false,"desc":"Filtrar por la regla de categoría asociada. Ejemplo: 'LIABILITIES', 'NO_OPERATIONAL_INCOME', 'ASSETS'.","default":"","type":"string","name":"categoryRule_key"}],"url":"/categories/"},"isReference":true,"order":2,"body":"","excerpt":"Endpoint que permite consultar los impuestos registrados en la aplicación","slug":"lista-de-categorías","type":"endpoint","title":"Lista de categorías"}

getLista de categorías

Endpoint que permite consultar los impuestos registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

format:
stringtree
Formato de las categorías. Las opciones posibles son 'plain' para que se retornen en un array (sin relacionar categorías padres con categorías hijas) o 'tree' para que se envíen las categorías como un árbol, en este caso se omite el atributo idParent. El formato por defecto es 'tree'.
type:
string
Retornar las categorías clasificadas en el tipo indicado. Las opciones posibles son income, expense, equity, asset, liability.
categoryRule_key:
string
Filtrar por la regla de categoría asociada. Ejemplo: 'LIABILITIES', 'NO_OPERATIONAL_INCOME', 'ASSETS'.

Examples


Result Format


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