{"_id":"56b24e322d96461700599266","parentDoc":null,"version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":22,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"editedParams":true,"githubsync":"","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":5,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T19:00:02.993Z","link_external":false,"link_url":"","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    \"3-0\": \"phone\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Teléfono de la empresa.\",\n    \"4-0\": \"website\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Página web de la empresa.\",\n    \"5-0\": \"email\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Correo electrónico de la empresa.\",\n    \"6-0\": \"regime\",\n    \"6-1\": \"String\",\n    \"6-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    \"3-3\": \"111 111 11 11\",\n    \"4-3\": \"www.alegra.com\",\n    \"5-3\": \"soporte@alegra.com\",\n    \"6-3\": \"Régimen común\",\n    \"7-0\": \"currency\",\n    \"8-0\": \"multicurrency\",\n    \"9-0\": \"address\",\n    \"12-0\": \"decimalPrecision\",\n    \"7-2\": \"Moneda principal de la compañía.\",\n    \"8-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    \"8-1\": \"Boolean\",\n    \"9-2\": \"Objeto que contiene  la información de la dirección de la empresa.\\n\\nContiene los siguientes atributos:\\n\\n* address : Indica la dirección de la empresa.\\n* city: Ciudad de la empresa.\",\n    \"12-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    \"7-3\": \"{\\n\\\"code\\\" : \\\"COP\\\",\\n\\\"symbol\\\" : \\\"$\\\",\\n\\\"exchangeRate\\\" : 2950\\n}\",\n    \"8-3\": \"true\",\n    \"9-3\": \"{\\n\\\"address\\\" : \\\"Calle principal #45\\\",\\n\\\"city\\\" : \\\"Barcelona\\\"\\n}\",\n    \"12-3\": \"0\",\n    \"9-1\": \"Object\",\n    \"13-0\": \"invoicePreferences\",\n    \"12-1\": \"Integer\",\n    \"13-1\": \"Object\",\n    \"13-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    \"14-0\": \"applicationVersion\",\n    \"14-1\": \"String\",\n    \"13-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    \"14-2\": \"Versión de la aplicación en la cual está registrada la empresa.\",\n    \"14-3\": \"colombia\",\n    \"15-0\": \"registryDate\",\n    \"15-1\": \"String\",\n    \"15-2\": \"Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss\",\n    \"15-3\": \"2016-03-07 17:00:07\",\n    \"7-1\": \"Object\",\n    \"16-0\": \"logo\",\n    \"16-1\": \"String\",\n    \"16-2\": \"URL de la imagen del logo de la empresa\",\n    \"16-3\": \"https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png\",\n    \"17-0\": \"timezone\",\n    \"17-1\": \"String\",\n    \"17-2\": \"Zona horaria que se utiliza en la aplicación\",\n    \"17-3\": \"America/Bogota\",\n    \"2-0\": \"identificationObject\",\n    \"2-1\": \"Object\",\n    \"2-2\": \"**Solo para versión Alegra Costa Rica y Alegra Colombia**.\\n\\nObjeto que indica la identificación de la compañía.\\n\\nContiene los siguientes atributos:\\n\\n* type: India el tipo de identificación, se debe enviar el id correspondiente al tipo de identificación. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).\\n\\n* number: Indica el número de identificación.\\n\\n**Solo para Alegra Colombia**\\n\\n* dv: Indica el dígito de verificación de identificación, se hace visible únicamente cuando el tipo de identificación es NIT. El dígito de verificación se calcula automaticamente a partir de la identificación.\",\n    \"2-3\": \"{\\n\\\"identification\\\": {\\n\\\"type\\\": \\\"CC\\\",\\n\\\"number\\\": \\\"111111111\\\"\\n }\\n}\",\n    \"10-0\": \"address (México)\",\n    \"10-2\": \"**Solo para versión Alegra México.\\n**\\n\\nObjeto que contiene  la información de la dirección de la empresa.\\n\\nContiene los siguientes atributos:\\n\\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    \"10-3\": \"{\\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    \"10-1\": \"Object\",\n    \"11-0\": \"address (Costa rica)\",\n    \"11-1\": \"Object\",\n    \"11-2\": \"**Solo para versión Alegra Costa Rica.\\n**\\n\\nObjeto que contiene  la información de la dirección de la empresa.\\n\\nContiene los siguientes atributos:\\n\\n* address:  Indica otras señas de la ubicación.\\n* department: Indica el nombre de la provincia.\\n* city: Indica el nombre del cantón. (El cantón debe pertenecer a la provincia)\\n* district: Indica el nombre del distrito. (El distrito debe pertenecer al cantón)\\n* neighborhood: Indica el nombre del barrio. (El barrio debe pertenecer al distrito)\",\n    \"11-3\": \"{\\n\\\"address\\\" : \\\"Calle 3\\\",\\n\\\"department\\\" : \\\"Limón\\\",\\n\\\"city\\\" : \\\"Pococí\\\",\\n\\\"district\\\" : \\\"Colorado\\\",\\n\\\"neighborhood\\\" : \\\"Verdades\\\"\\n}\",\n    \"18-0\": \"kindOfPerson (Colombia)\",\n    \"18-1\": \"String\",\n    \"18-2\": \"**Solo para versión Alegra Colombia.** \\n\\nIndica el tipo de persona, se debe enviar el id correspondiente al tipo de persona.\\nConsulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).\",\n    \"18-3\": \"LEGAL_ENTITY\",\n    \"19-0\": \"settings\",\n    \"19-1\": \"Object\",\n    \"19-2\": \"Indica algunas de las configuraciones que tiene la compañía en Alegra.\\n\\nContiene los siguientes atributos:\\n\\n* electronicInvoicing (bool): Indica si la compañía tiene facturación electrónica activa\",\n    \"19-3\": \"{\\n  \\\"electronicInvoicing\\\": true\\n}\"\n  },\n  \"cols\": 4,\n  \"rows\": 20\n}\n[/block]","excerpt":"Endpoint /company","slug":"empresa","type":"basic","title":"Descripción general"}

Documentación

Productos o servicios

Contactos

Facturas de venta

Cotizaciones

Numeración de facturación

Impuestos

Cuentas de banco

Empresa

Pagos

Retenciones

Categorías

Vendedores

Listas de precios

Bodegas

Usuarios

Facturas globales

Catálogo de parámetros por país

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.", "3-0": "phone", "3-1": "String", "3-2": "Teléfono de la empresa.", "4-0": "website", "4-1": "String", "4-2": "Página web de la empresa.", "5-0": "email", "5-1": "String", "5-2": "Correo electrónico de la empresa.", "6-0": "regime", "6-1": "String", "6-2": "Régimen de la empresa.", "h-3": "Ejemplo", "0-3": "Mi empresa en Alegra", "1-3": "900.123.123-8", "3-3": "111 111 11 11", "4-3": "www.alegra.com", "5-3": "soporte@alegra.com", "6-3": "Régimen común", "7-0": "currency", "8-0": "multicurrency", "9-0": "address", "12-0": "decimalPrecision", "7-2": "Moneda principal de la compañía.", "8-2": "Retorna true si la empresa tiene activa la funcionalidad de multimoneda. Si es así la empresa puede realizar movimientos en múltiples monedas.", "8-1": "Boolean", "9-2": "Objeto que contiene la información de la dirección de la empresa.\n\nContiene los siguientes atributos:\n\n* address : Indica la dirección de la empresa.\n* city: Ciudad de la empresa.", "12-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.", "7-3": "{\n\"code\" : \"COP\",\n\"symbol\" : \"$\",\n\"exchangeRate\" : 2950\n}", "8-3": "true", "9-3": "{\n\"address\" : \"Calle principal #45\",\n\"city\" : \"Barcelona\"\n}", "12-3": "0", "9-1": "Object", "13-0": "invoicePreferences", "12-1": "Integer", "13-1": "Object", "13-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.", "14-0": "applicationVersion", "14-1": "String", "13-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 ```", "14-2": "Versión de la aplicación en la cual está registrada la empresa.", "14-3": "colombia", "15-0": "registryDate", "15-1": "String", "15-2": "Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss", "15-3": "2016-03-07 17:00:07", "7-1": "Object", "16-0": "logo", "16-1": "String", "16-2": "URL de la imagen del logo de la empresa", "16-3": "https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png", "17-0": "timezone", "17-1": "String", "17-2": "Zona horaria que se utiliza en la aplicación", "17-3": "America/Bogota", "2-0": "identificationObject", "2-1": "Object", "2-2": "**Solo para versión Alegra Costa Rica y Alegra Colombia**.\n\nObjeto que indica la identificación de la compañía.\n\nContiene los siguientes atributos:\n\n* type: India el tipo de identificación, se debe enviar el id correspondiente al tipo de identificación. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).\n\n* number: Indica el número de identificación.\n\n**Solo para Alegra Colombia**\n\n* dv: Indica el dígito de verificación de identificación, se hace visible únicamente cuando el tipo de identificación es NIT. El dígito de verificación se calcula automaticamente a partir de la identificación.", "2-3": "{\n\"identification\": {\n\"type\": \"CC\",\n\"number\": \"111111111\"\n }\n}", "10-0": "address (México)", "10-2": "**Solo para versión Alegra México.\n**\n\nObjeto que contiene la información de la dirección de la empresa.\n\nContiene los siguientes atributos:\n\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.", "10-3": "{\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}", "10-1": "Object", "11-0": "address (Costa rica)", "11-1": "Object", "11-2": "**Solo para versión Alegra Costa Rica.\n**\n\nObjeto que contiene la información de la dirección de la empresa.\n\nContiene los siguientes atributos:\n\n* address: Indica otras señas de la ubicación.\n* department: Indica el nombre de la provincia.\n* city: Indica el nombre del cantón. (El cantón debe pertenecer a la provincia)\n* district: Indica el nombre del distrito. (El distrito debe pertenecer al cantón)\n* neighborhood: Indica el nombre del barrio. (El barrio debe pertenecer al distrito)", "11-3": "{\n\"address\" : \"Calle 3\",\n\"department\" : \"Limón\",\n\"city\" : \"Pococí\",\n\"district\" : \"Colorado\",\n\"neighborhood\" : \"Verdades\"\n}", "18-0": "kindOfPerson (Colombia)", "18-1": "String", "18-2": "**Solo para versión Alegra Colombia.** \n\nIndica el tipo de persona, se debe enviar el id correspondiente al tipo de persona.\nConsulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).", "18-3": "LEGAL_ENTITY", "19-0": "settings", "19-1": "Object", "19-2": "Indica algunas de las configuraciones que tiene la compañía en Alegra.\n\nContiene los siguientes atributos:\n\n* electronicInvoicing (bool): Indica si la compañía tiene facturación electrónica activa", "19-3": "{\n \"electronicInvoicing\": true\n}" }, "cols": 4, "rows": 20 } [/block]