{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/categories","auth":"required","results":{"codes":[{"status":200,"code":"[\n    {\n        \"id\": \"5050\",\n        \"idParent\": null,\n        \"name\": \"Patrimonio\",\n        \"description\": \"Bajo esta categoría se encuentra el patrimonio de la empresa\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": true,\n        \"categoryRule\": {\n            \"id\": \"17\",\n            \"name\": \"Patrimonio\",\n            \"key\": \"EQUITY\"\n        },\n        \"blocked\": \"yes\"\n    },\n    {\n        \"id\": \"5051\",\n        \"idParent\": \"5050\",\n        \"name\": \"Capital social\",\n        \"description\": \"\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": false,\n        \"categoryRule\": null,\n        \"blocked\": \"no\"\n    },\n    {\n        \"id\": \"5052\",\n        \"idParent\": \"5050\",\n        \"name\": \"Ganancias acumuladas\",\n        \"description\": \"\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": false,\n        \"categoryRule\": {\n            \"id\": \"18\",\n            \"name\": \"Utilidades\",\n            \"key\": \"UTILITIES\"\n        },\n        \"blocked\": \"no\"\n    },\n    {\n        \"id\": \"5053\",\n        \"idParent\": \"5050\",\n        \"name\": \"Ajustes por saldos iniciales\",\n        \"description\": \"\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": false,\n        \"categoryRule\": null,\n        \"blocked\": \"no\"\n    },\n    {\n        \"id\": \"5054\",\n        \"idParent\": \"5053\",\n        \"name\": \"Ajustes iniciales en bancos\",\n        \"description\": \"\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": false,\n        \"categoryRule\": {\n            \"id\": \"19\",\n            \"name\": \"Ajustes iniciales - Bancos\",\n            \"key\": \"INITIAL_ADJUSTMENTS_BANKS\"\n        },\n        \"blocked\": \"no\"\n    },\n    {\n        \"id\": \"5055\",\n        \"idParent\": \"5053\",\n        \"name\": \"Ajustes iniciales en inventario\",\n        \"description\": \"\",\n        \"type\": \"equity\",\n        \"nature\": \"credit\",\n        \"code\": null,\n        \"readOnly\": false,\n        \"categoryRule\": {\n            \"id\": \"20\",\n            \"name\": \"Ajustes iniciales - Inventario\",\n            \"key\": \"INITIAL_ADJUSTMENTS_INVENTORY\"\n        },\n        \"blocked\": \"no\"\n    }\n]","language":"json","name":"Formato plano"},{"language":"json","name":"Formato árbol","code":"[\n    {\n        \"id\": \"5050\",\n        \"type\": \"equity\",\n        \"description\": \"Bajo esta categoría se encuentra el patrimonio de la empresa\",\n        \"code\": null,\n        \"blocked\": \"yes\",\n        \"nature\": \"credit\",\n        \"categoryRule\": {\n            \"id\": \"17\",\n            \"name\": \"Patrimonio\",\n            \"key\": \"EQUITY\"\n        },\n        \"children\": [\n            {\n                \"id\": \"5051\",\n                \"type\": \"equity\",\n                \"description\": \"\",\n                \"code\": null,\n                \"blocked\": \"no\",\n                \"nature\": \"credit\",\n                \"categoryRule\": null,\n                \"children\": [],\n                \"readOnly\": false,\n                \"name\": \"Capital social\"\n            },\n            {\n                \"id\": \"5052\",\n                \"type\": \"equity\",\n                \"description\": \"\",\n                \"code\": null,\n                \"blocked\": \"no\",\n                \"nature\": \"credit\",\n                \"categoryRule\": {\n                    \"id\": \"18\",\n                    \"name\": \"Utilidades\",\n                    \"key\": \"UTILITIES\"\n                },\n                \"children\": [],\n                \"readOnly\": false,\n                \"name\": \"Ganancias acumuladas\"\n            },\n            {\n                \"id\": \"5053\",\n                \"type\": \"equity\",\n                \"description\": \"\",\n                \"code\": null,\n                \"blocked\": \"no\",\n                \"nature\": \"credit\",\n                \"categoryRule\": null,\n                \"children\": [\n                    {\n                        \"id\": \"5054\",\n                        \"type\": \"equity\",\n                        \"description\": \"\",\n                        \"code\": null,\n                        \"blocked\": \"no\",\n                        \"nature\": \"credit\",\n                        \"categoryRule\": {\n                            \"id\": \"19\",\n                            \"name\": \"Ajustes iniciales - Bancos\",\n                            \"key\": \"INITIAL_ADJUSTMENTS_BANKS\"\n                        },\n                        \"children\": [],\n                        \"readOnly\": false,\n                        \"name\": \"Ajustes iniciales en bancos\"\n                    },\n                    {\n                        \"id\": \"5055\",\n                        \"type\": \"equity\",\n                        \"description\": \"\",\n                        \"code\": null,\n                        \"blocked\": \"no\",\n                        \"nature\": \"credit\",\n                        \"categoryRule\": {\n                            \"id\": \"20\",\n                            \"name\": \"Ajustes iniciales - Inventario\",\n                            \"key\": \"INITIAL_ADJUSTMENTS_INVENTORY\"\n                        },\n                        \"children\": [],\n                        \"readOnly\": false,\n                        \"name\": \"Ajustes iniciales en inventario\"\n                    }\n                ],\n                \"readOnly\": false,\n                \"name\": \"Ajustes por saldos iniciales\"\n            }\n        ],\n        \"readOnly\": true,\n        \"name\": \"Patrimonio\"\n    }\n]"}]},"settings":"","examples":{"codes":[{"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.com:mitoken'","language":"curl"}]},"method":"get","params":[{"name":"format","type":"string","default":"tree","desc":"Formato de las cuentas contables. Las opciones posibles son 'plain' para que se retornen en un arreglo (sin relacionar cuentas padres con cuentas hijas) o 'tree' para que se envíen las cuentas como un árbol, en este caso se omite el atributo idParent. El formato por defecto es 'tree'.","required":false,"in":"query","ref":"","_id":"56b269c2a5a1020d00cf4ce1"},{"name":"type","type":"string","default":"","desc":"Retornar las cuentas contables clasificadas en el tipo indicado. Las opciones posibles son income, expense, equity, asset, liability.","required":false,"in":"query","ref":"","_id":"56b269c2a5a1020d00cf4ce0"},{"name":"categoryRule_key","type":"string","default":"","desc":"Filtrar por la regla de cuenta contable asociada. Ejemplo: 'LIABILITIES', 'NO_OPERATIONAL_INCOME', 'ASSETS'.","required":false,"in":"query","ref":"","_id":"5d76e0f73451d7042c52a013"}]},"next":{"description":"","pages":[]},"title":"Lista de cuentas contables","type":"endpoint","slug":"lista-de-categorías","excerpt":"Endpoint que permite consultar las cuentas contables registrados en la aplicación","body":"","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b269c2a5a1020d00cf4cdf","editedParams2":true,"parentDoc":null,"createdAt":"2016-02-03T20:57:38.658Z","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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":47,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":10,"editedParams":true,"githubsync":"","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cuentas contables","slug":"categorías","order":12,"from_sync":false,"reference":true,"_id":"56b4b4085997532100bc6b61","version":"56abd2434e4b730d009eb10d","createdAt":"2016-02-05T14:39:04.628Z","project":"56abd2434e4b730d009eb10a","__v":0}}

getLista de cuentas contables

Endpoint que permite consultar las cuentas contables registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

format:
stringtree
Formato de las cuentas contables. Las opciones posibles son 'plain' para que se retornen en un arreglo (sin relacionar cuentas padres con cuentas hijas) o 'tree' para que se envíen las cuentas como un árbol, en este caso se omite el atributo idParent. El formato por defecto es 'tree'.
type:
string
Retornar las cuentas contables clasificadas en el tipo indicado. Las opciones posibles son income, expense, equity, asset, liability.
categoryRule_key:
string
Filtrar por la regla de cuenta contable 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 }}