{"_id":"56b24e322d96461700599266","parentDoc":null,"version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":18,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"editedParams":true,"user":"56abd213d4432d1900eed227","category":{"_id":"56b4b3eb7bccae0d00e9a12e","version":"56abd2434e4b730d009eb10d","pages":[],"project":"56abd2434e4b730d009eb10a","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:38:35.098Z","from_sync":false,"order":8,"slug":"empresa","title":"Empresa"},"editedParams2":true,"project":"56abd2434e4b730d009eb10a","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T19:00:02.993Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://app.alegra.com/api/v1/items/ -u 'usuario:::at:::alegra.co:mitoken'","language":"curl"}]},"results":{"codes":[{"name":"Ejemplo consulta exitosa","language":"json","code":"[\n            {\n                \"id\": 1,\n                \"name\": \"Billetera\",\n                \"description\": \"Billetera de cuero negro\",\n                \"reference\": \"REF-005\",\n                \"inventory\": {\n                        \"unit\" : \"piece\",\n                        \"availableQunatity\" : 150,\n                        \"unitCost\" : 560,\n                        \"initialQuantity\" : 320\n                        },\n                \"tax\" : [\n                            {\n                                \"id\" : 6,\n                                \"name\" : \"IVA\",\n                                \"percentage\" : 16,\n                                \"description\" : \"Impuesto de valor agregado\"\n                            }\n                        ],\n                \"category\" : {\n                        \"id\": 54,\n                        \"name\" : \"Ventas\"\n                        },\n                \"price\" : [\n                            {\n                             \"idPriceList\" : 1,\n                            \"name\" : \"General\",\n                            \"price\" : 1200\n                            },\n                            {\n                                \"idPriceList\" : 2,\n                                \"name\" : \"Distribuidor\",\n                                \"price\" : 1050\n                            }\n                        ]\n                \n            },\n            {\n                \"id\": 2,\n                \"name\": \"Cartera\",\n                \"description\": \"Cartera de cuero color café\",\n                \"reference\": \"CAR-195\",\n                \"inventory\": {\n                        \"unit\" : \"piece\",\n                        \"availableQunatity\" : 160,\n                        \"unitCost\" : 2560,\n                        \"initialQuantity\" : 120\n                        },\n                \"tax\" : [\n                            {\n                                \"id\" : 6,\n                                \"name\" : \"IVA\",\n                                \"percentage\" : 16,\n                                \"description\" : \"Impuesto de valor agregado\"\n                            }\n                        ],\n                \"category\" : {\n                        \"id\": 54,\n                        \"name\" : \"Ventas\"\n                        },\n                \"price\" : [\n                    {\n                        \"idPriceList\" : 1,\n                        \"name\" : \"General\",\n                        \"price\" : 1200\n                    },\n                    {\n                        \"idPriceList\" : 2,\n                        \"name\" : \"Distribuidor\",\n                        \"price\" : 3900\n                    },\n                    {\n                        \"name\" : \"Mayorista\",\n                        \"idPriceList\" : 6,\n                        \"price\" : 3700\n                    }\n                ]\n                \n            },\n\t\t\t\t\t{\n                \"id\": 3,\n                \"name\": \"Diseño de monedero \",\n                \"description\": \"Diseño de monedero en cuero.\",\n                \"reference\": \"\",\n                \"tax\" : [\n                            {\n                                \"id\" : 6,\n                                \"name\" : \"IVA\",\n                                \"percentage\" : 16,\n                                \"description\" : \"Impuesto de valor agregado\"\n                            }\n                        ],\n                \"category\" : {\n                        \"id\": 54,\n                        \"name\" : \"Ventas\"\n                        },\n                \"price\" : [\n                    {\n                        \"idPriceList\" : 1,\n                        \"name\" : \"General\",\n                        \"price\" : 1200\n                    }\n                ]\n            }\n]","status":200},{"language":"json","status":404,"code":"{ \n\t\"error\": \"No se encontró en la aplicación el item que se está buscando\" ,\n  \"code\" : 404\n}"}]},"settings":"","auth":"required","params":[{"_id":"56afd9393c70b01700facf25","ref":"","in":"body","required":false,"desc":"desde cual item se quiere consultar. Por ejemplo para consultar desde el ítem 20, se envía start=20","default":"0","type":"int","name":"start"},{"_id":"56b0b7da36d2580d002477d7","ref":"","in":"body","required":false,"desc":"Cantidad de items a partir del inicio que se desea retornar.  Por defecto retorna 30 items. Si este valor es mayor que 30, la aplicación retorna error","default":"30","type":"int","name":"limit"},{"_id":"56b0b7da36d2580d002477d6","ref":"","in":"body","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar los ítems.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente)","default":"ASC","type":"string","name":"order_direction"},{"_id":"56b0b7da36d2580d002477d5","ref":"","in":"body","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son name, id, reference, description","default":"name","type":"string","name":"order_field"},{"_id":"56b0b7da36d2580d002477d4","ref":"","in":"body","required":false,"desc":"de texto que se quiere utilizar para buscar en el nombre y referencia del ítem cuales contienen dicho texto. Por ejemplo si se desea buscar los ítems que comiencen con a , se envía query=a","default":"","type":"string","name":"query"}],"url":"/items/"},"isReference":true,"order":0,"body":"Una empresa contiene los siguientes atributos:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Nombre\",\n    \"h-1\": \"Tipo\",\n    \"h-2\": \"Descripción\",\n    \"0-0\": \"name\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Nombre de la empresa.\",\n    \"1-0\": \"identification\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Identificación de la empresa. Ej RFC, cédula, NIT, RUC, entre otros.\",\n    \"2-0\": \"phone\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Teléfono de la empresa.\",\n    \"3-0\": \"website\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Página web de la empresa.\",\n    \"4-0\": \"email\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Correo electrónico de la empresa.\",\n    \"5-0\": \"regime\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Régimen de la empresa.\",\n    \"h-3\": \"Ejemplo\",\n    \"0-3\": \"Mi empresa en Alegra\",\n    \"1-3\": \"900.123.123-8\",\n    \"2-3\": \"111 111 11 11\",\n    \"3-3\": \"www.alegra.com\",\n    \"4-3\": \"soporte@alegra.com\",\n    \"5-3\": \"Régimen común\",\n    \"6-0\": \"currency\",\n    \"7-0\": \"multicurrency\",\n    \"8-0\": \"address\",\n    \"9-0\": \"decimalPrecision\",\n    \"6-2\": \"Moneda principal de la compañía.\",\n    \"7-2\": \"Retorna true si la empresa tiene activa la funcionalidad de multimoneda. Si es así la empresa puede realizar movimientos en múltiples monedas.\",\n    \"7-1\": \"Boolean\",\n    \"8-2\": \"Objeto que contiene  la información de la dirección de la empresa.\\n\\nPara versiones diferentes a Alegra México este objeto contiene los siguientes atributos:\\n\\n* address : Indica la dirección de la empresa.\\n* city: Ciudad de la empresa.\\n\\nPara versión Alegra México:\\n* street: Indica la calle de la empresa.\\n* exteriorNumber: Indica el número de exterior.\\n* interiorNumber: Indica el número de interior.\\n* colony: Indica la colonia de la empresa.\\n* country: Indica el país de la empresa.\\n* locality: Indica la localidad.\\n* municipality. Indica el municipio.\\n* state : Indica el estado de la empresa.\\n* zipCode: Indica el código postal de la empresa.\",\n    \"9-2\": \"Indica la precisión decimal que tiene configurada la empresa para la creación de documentos. Las facturas de venta y demás documentos que se creen se aproximan teniendo en cuenta este atributo.\",\n    \"6-3\": \"{\\n\\\"code\\\" : \\\"COP\\\",\\n\\\"symbol\\\" : \\\"$\\\",\\n\\\"exchangeRate\\\" : 2950\\n}\",\n    \"7-3\": \"true\",\n    \"8-3\": \"Para versiones diferentes a Alegra México:\\n```\\n{\\n\\\"address\\\" : \\\"Calle principal #45\\\",\\n\\\"city\\\" : \\\"Barcelona\\\"\\n}\\n```\\nPara versión Alegra México:\\n\\n```\\n{\\n\\\"street\\\" : \\\"Centenario\\\",\\n\\\"exteriorNumber\\\" : 95,\\n\\\"interiorNumber\\\" : \\\"\\\",\\n\\\"colony\\\" : \\\"Coyoacán\\\",\\n\\\"country\\\" : \\\"México\\\",\\n\\\"locality\\\" : \\\"\\\",\\n\\\"municipality\\\" : \\\"\\\",\\n\\\"state\\\" : \\\"D.F\\\",\\n\\\"zipCode\\\" : \\\"12345\\\"\\n}\\n    ```\",\n    \"9-3\": \"0\",\n    \"8-1\": \"Object\",\n    \"10-0\": \"invoicePreferences\",\n    \"9-1\": \"Integer\",\n    \"10-1\": \"Object\",\n    \"10-2\": \"Objeto que contiene las preferencias de facturación de la empresa.\\nContiene los siguientes atributos:\\n* defaultAnotation : Notas por defecto que la empresa tiene configuradas en la aplicación.\\n* defaultTermsAndConditions: Términos y condiciones por defecto que tiene configuradas la empresa.\",\n    \"11-0\": \"applicationVersion\",\n    \"11-1\": \"String\",\n    \"10-3\": \"```\\n\\\"invoicePreferences\\\": {\\n    \\\"defaultAnotation\\\": \\\"Notas por defecto de mi empresa\\\",\\n   \\\"defaultTermsAndConditions\\\": \\\"Esta factura se asimila en todos sus efectos a una letra de cambio de conformidad con el Art. 774 del código de comercio. Autorizo que en caso de incumplimiento de esta obligación sea reportado a las centrales de riesgo, se cobraran intereses por mora.\\\"\\n  }\\n   ```\",\n    \"11-2\": \"Versión de la aplicación en la cual está registrada la empresa.\",\n    \"11-3\": \"colombia\",\n    \"12-0\": \"registryDate\",\n    \"12-1\": \"String\",\n    \"12-2\": \"Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss\",\n    \"12-3\": \"2016-03-07 17:00:07\",\n    \"6-1\": \"Object\",\n    \"13-0\": \"logo\",\n    \"13-1\": \"String\",\n    \"13-2\": \"URL de la imagen del logo de la empresa\",\n    \"13-3\": \"https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png\",\n    \"14-0\": \"timezone\",\n    \"14-1\": \"String\",\n    \"14-2\": \"Zona horaria que se utiliza en la aplicación\",\n    \"14-3\": \"America/Bogota\"\n  },\n  \"cols\": 4,\n  \"rows\": 15\n}\n[/block]","excerpt":"Endpoint /company","slug":"empresa","type":"basic","title":"Descripción general"}

Descripción general

Endpoint /company

Una empresa contiene los siguientes atributos: [block:parameters] { "data": { "h-0": "Nombre", "h-1": "Tipo", "h-2": "Descripción", "0-0": "name", "0-1": "String", "0-2": "Nombre de la empresa.", "1-0": "identification", "1-1": "String", "1-2": "Identificación de la empresa. Ej RFC, cédula, NIT, RUC, entre otros.", "2-0": "phone", "2-1": "String", "2-2": "Teléfono de la empresa.", "3-0": "website", "3-1": "String", "3-2": "Página web de la empresa.", "4-0": "email", "4-1": "String", "4-2": "Correo electrónico de la empresa.", "5-0": "regime", "5-1": "String", "5-2": "Régimen de la empresa.", "h-3": "Ejemplo", "0-3": "Mi empresa en Alegra", "1-3": "900.123.123-8", "2-3": "111 111 11 11", "3-3": "www.alegra.com", "4-3": "soporte@alegra.com", "5-3": "Régimen común", "6-0": "currency", "7-0": "multicurrency", "8-0": "address", "9-0": "decimalPrecision", "6-2": "Moneda principal de la compañía.", "7-2": "Retorna true si la empresa tiene activa la funcionalidad de multimoneda. Si es así la empresa puede realizar movimientos en múltiples monedas.", "7-1": "Boolean", "8-2": "Objeto que contiene la información de la dirección de la empresa.\n\nPara versiones diferentes a Alegra México este objeto contiene los siguientes atributos:\n\n* address : Indica la dirección de la empresa.\n* city: Ciudad de la empresa.\n\nPara versión Alegra México:\n* street: Indica la calle de la empresa.\n* exteriorNumber: Indica el número de exterior.\n* interiorNumber: Indica el número de interior.\n* colony: Indica la colonia de la empresa.\n* country: Indica el país de la empresa.\n* locality: Indica la localidad.\n* municipality. Indica el municipio.\n* state : Indica el estado de la empresa.\n* zipCode: Indica el código postal de la empresa.", "9-2": "Indica la precisión decimal que tiene configurada la empresa para la creación de documentos. Las facturas de venta y demás documentos que se creen se aproximan teniendo en cuenta este atributo.", "6-3": "{\n\"code\" : \"COP\",\n\"symbol\" : \"$\",\n\"exchangeRate\" : 2950\n}", "7-3": "true", "8-3": "Para versiones diferentes a Alegra México:\n```\n{\n\"address\" : \"Calle principal #45\",\n\"city\" : \"Barcelona\"\n}\n```\nPara versión Alegra México:\n\n```\n{\n\"street\" : \"Centenario\",\n\"exteriorNumber\" : 95,\n\"interiorNumber\" : \"\",\n\"colony\" : \"Coyoacán\",\n\"country\" : \"México\",\n\"locality\" : \"\",\n\"municipality\" : \"\",\n\"state\" : \"D.F\",\n\"zipCode\" : \"12345\"\n}\n ```", "9-3": "0", "8-1": "Object", "10-0": "invoicePreferences", "9-1": "Integer", "10-1": "Object", "10-2": "Objeto que contiene las preferencias de facturación de la empresa.\nContiene los siguientes atributos:\n* defaultAnotation : Notas por defecto que la empresa tiene configuradas en la aplicación.\n* defaultTermsAndConditions: Términos y condiciones por defecto que tiene configuradas la empresa.", "11-0": "applicationVersion", "11-1": "String", "10-3": "```\n\"invoicePreferences\": {\n \"defaultAnotation\": \"Notas por defecto de mi empresa\",\n \"defaultTermsAndConditions\": \"Esta factura se asimila en todos sus efectos a una letra de cambio de conformidad con el Art. 774 del código de comercio. Autorizo que en caso de incumplimiento de esta obligación sea reportado a las centrales de riesgo, se cobraran intereses por mora.\"\n }\n ```", "11-2": "Versión de la aplicación en la cual está registrada la empresa.", "11-3": "colombia", "12-0": "registryDate", "12-1": "String", "12-2": "Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss", "12-3": "2016-03-07 17:00:07", "6-1": "Object", "13-0": "logo", "13-1": "String", "13-2": "URL de la imagen del logo de la empresa", "13-3": "https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png", "14-0": "timezone", "14-1": "String", "14-2": "Zona horaria que se utiliza en la aplicación", "14-3": "America/Bogota" }, "cols": 4, "rows": 15 } [/block]