{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/items/","auth":"required","examples":{"codes":[{"language":"curl","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'"}]},"params":[{"name":"start","type":"int","default":"0","desc":"desde cual item se quiere consultar. Por ejemplo para consultar desde el ítem 20, se envía start=20","required":false,"in":"body","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"limit","type":"int","default":"30","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","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d7"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar los ítems.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente)","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d6"},{"name":"order_field","type":"string","default":"name","desc":"Campo por el cual se desea ordenar, las opciones posibles son name, id, reference, description","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d5"},{"name":"query","type":"string","default":"","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","required":false,"in":"body","ref":"","_id":"56b0b7da36d2580d002477d4"}],"results":{"codes":[{"status":200,"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]","language":"json","name":"Ejemplo consulta exitosa"},{"code":"{ \n\t\"error\": \"No se encontró en la aplicación el item que se está buscando\" ,\n  \"code\" : 404\n}","status":404,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Descripción general","type":"basic","slug":"empresa","excerpt":"Endpoint /company","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    \"4-0\": \"phone\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Teléfono de la empresa.\",\n    \"5-0\": \"website\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Página web de la empresa.\",\n    \"6-0\": \"email\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Correo electrónico de la empresa.\",\n    \"7-0\": \"regime\",\n    \"7-1\": \"String\",\n    \"7-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    \"4-3\": \"111 111 11 11\",\n    \"5-3\": \"www.alegra.com\",\n    \"6-3\": \"[email protected]\",\n    \"7-3\": \"COMMON_REGIME\",\n    \"8-0\": \"currency\",\n    \"9-0\": \"multicurrency\",\n    \"10-0\": \"address\",\n    \"15-0\": \"decimalPrecision\",\n    \"8-2\": \"Moneda principal de la compañía.\",\n    \"9-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    \"9-1\": \"Boolean\",\n    \"10-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    \"15-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    \"8-3\": \"{\\n\\\"code\\\" : \\\"COP\\\",\\n\\\"symbol\\\" : \\\"$\\\",\\n\\\"exchangeRate\\\" : 2950\\n}\",\n    \"9-3\": \"true\",\n    \"10-3\": \"{\\n\\\"address\\\" : \\\"Calle principal #45\\\",\\n\\\"city\\\" : \\\"Barcelona\\\"\\n}\",\n    \"15-3\": \"0\",\n    \"10-1\": \"Object\",\n    \"16-0\": \"invoicePreferences\",\n    \"15-1\": \"Integer\",\n    \"16-1\": \"Object\",\n    \"16-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    \"17-0\": \"applicationVersion\",\n    \"17-1\": \"String\",\n    \"16-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    \"17-2\": \"Versión de la aplicación en la cual está registrada la empresa.\",\n    \"17-3\": \"colombia\",\n    \"18-0\": \"registryDate\",\n    \"18-1\": \"String\",\n    \"18-2\": \"Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss\",\n    \"18-3\": \"2016-03-07 17:00:07\",\n    \"8-1\": \"Object\",\n    \"19-0\": \"logo\",\n    \"19-1\": \"String\",\n    \"19-2\": \"URL de la imagen del logo de la empresa\",\n    \"19-3\": \"https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png\",\n    \"20-0\": \"timezone\",\n    \"20-1\": \"String\",\n    \"20-2\": \"Zona horaria que se utiliza en la aplicación\",\n    \"20-3\": \"America/Bogota\",\n    \"3-0\": \"identificationObject\",\n    \"3-1\": \"Object\",\n    \"3-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: Indica 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/argentina).\\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    \"3-3\": \"{\\n\\\"identificationObject\\\": {\\n\\\"type\\\": \\\"CC\\\",\\n\\\"number\\\": \\\"123456789\\\"\\n }\\n}\",\n    \"11-0\": \"address (México)\",\n    \"11-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    \"11-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    \"11-1\": \"Object\",\n    \"12-0\": \"address (Costa rica)\",\n    \"12-1\": \"Object\",\n    \"12-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    \"12-3\": \"{\\n\\\"address\\\" : \\\"Calle 3\\\",\\n\\\"department\\\" : \\\"Limón\\\",\\n\\\"city\\\" : \\\"Pococí\\\",\\n\\\"district\\\" : \\\"Colorado\\\",\\n\\\"neighborhood\\\" : \\\"Verdades\\\"\\n}\",\n    \"21-0\": \"kindOfPerson (Colombia)\",\n    \"21-1\": \"String\",\n    \"21-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    \"21-3\": \"LEGAL_ENTITY\",\n    \"22-0\": \"settings\",\n    \"22-1\": \"Object\",\n    \"22-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* electronicInvoicingVersion (string): Para Colombia, indica la versión de facturación electrónica de la compañía.\",\n    \"22-3\": \"{\\n  \\\"electronicInvoicing\\\": true,\\n\\\"electronicInvoicingVersion\\\": \\\"2.1\\\"\\n}\",\n    \"13-0\": \"address (Argentina)\",\n    \"13-1\": \"Object\",\n    \"13-2\": \"**Solo para versión Alegra Argentina.\\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* province: Indica el nombre de la provincia.\\n* city: Indica el nombre de la ciudad. (La ciudad debe pertenecer a la provincia).\\n* postalCode: Indica el numero del código postal de la empresa.\",\n    \"13-3\": \"{\\n\\\"province\\\": \\\"Buenos Aires\\\",\\n\\\"city\\\": \\\"La plata\\\",\\n\\\"address\\\": \\\"Diagonal 38 # 13-87\\\",\\n\\\"postalCode\\\": \\\"2221\\\"\\n }\",\n    \"23-0\": \"activityStartDate (Argentina)\",\n    \"23-1\": \"Date\",\n    \"23-2\": \"Fecha del inicio de las actividades de la empresa.\",\n    \"23-3\": \"2019-11-20\",\n    \"24-0\": \"numberIibb (**Argentina**)\",\n    \"24-1\": \"String\",\n    \"24-2\": \"Numero de ingresos brutos de la empresa.\",\n    \"24-3\": \"123456789\",\n    \"25-0\": \"ivaCondition (Argentina)\",\n    \"25-1\": \"String\",\n    \"25-2\": \"Condición de Iva de la empresa.\",\n    \"26-0\": \"conditionIibb (Argentina)\",\n    \"26-1\": \"String\",\n    \"26-2\": \"Condición del numero interno bruto.\",\n    \"25-3\": \"IVA_RESPONSABLE (IVA responsable inscripto)\",\n    \"26-3\": \"SIMPLIFIED_REGIME (Régimen simplificado)\",\n    \"27-0\": \"setTest (Colombia)\",\n    \"27-1\": \"Object\",\n    \"27-2\": \"**Solo para versión Alegra Colombia.**\\nObjeto que contiene la información del set de pruebas cuando la versión de facturación electrónica es la 2.1\\n\\nContiene los siguientes atributos:\\n* id : Identificador del set de pruebas\\n* status: Estado del envío del set de pruebas, valores: `AUTHORIZING` En proceso de autorización, `AUTHORIZED` Autorizado,  `UNAUTHORIZED` No autorizado.\",\n    \"27-3\": \"{\\n        \\\"id\\\": \\\"Rd4a4f0d-1Phy-5Z1a-98f7-P3ed2T87Ab80\\\",\\n        \\\"status\\\": \\\"AUTHORIZED\\\"\\n    }\",\n    \"28-0\": \"fiscalResponsabilities (Colombia)\",\n    \"29-0\": \"tradeName (Colombia)\",\n    \"28-1\": \"Array\",\n    \"28-2\": \"**Solo para versión Alegra Colombia.**\\nObjeto que contiene la información de las responsabilidades fiscales de la compañía cuando la versión de facturación electrónica es la 2.1.\\n\\nConsulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia).\",\n    \"29-1\": \"String\",\n    \"29-2\": \"**Solo para versión Alegra Colombia.**\\nNombre comercial de la compañía.\",\n    \"29-3\": \"Mi empresa\",\n    \"28-3\": \"[17, 2]\",\n    \"30-0\": \"giro (Chile)\",\n    \"30-1\": \"String\",\n    \"30-2\": \"**Solo para versión Alegra Chile**\\n\\nGiro de la empresa, este campo es obligatorio si se quiere facturar electrónicamente.\",\n    \"30-3\": \"Giro de negocio\",\n    \"14-0\": \"address (Chile)\",\n    \"14-1\": \"Object\",\n    \"14-2\": \"**Solo para versión Alegra Chile.\\n**\\n\\nObjeto que contiene  la información de la dirección de la empresa.\\n\\nContiene los siguientes atributos:\\n\\n* city: Indica el nombre de la ciudad. \\n* region: Indica el nombre de la región.\\n* commune: Indica el nombre de la comuna. (La comuna debe pertenecer a la región).\\n* description:  Indica otras señas de la ubicación.\",\n    \"14-3\": \"{\\n\\\"city\\\": \\\"Santiago\\\",\\n\\\"region\\\": \\\"Metropolitana\\\",\\n\\\"commune\\\": \\\"Santiago\\\",\\n\\\"description\\\": \\\"Av. Grecia 1853-1951\\\"\\n},\",\n    \"31-0\": \"economicActivities (Chile)\",\n    \"31-1\": \"Array\",\n    \"31-2\": \"**Solo para versión Alegra Chile.\\n**\\n\\nArray donde se indica las actividades económicas asociadas a la compañía, cada actividad económica, se debe enviar a su vez como un objeto, en el cual se envia id o value, en el caso de envíar id y value, se dará prioridad al id. Adicionalmente, se debe asignar un main (boolean) a una actividad.\\n\\nConsulta el listado de actividades económicas [aquí](http://www.sii.cl/ayudas/ayudas_por_servicios/1956-codigos-1959.html).\",\n    \"31-3\": \"\\\"economicActivities\\\": [\\n        {\\n            \\\"id\\\": \\\"011102\\\",\\n            \\\"main\\\": true\\n        },\\n        {\\n            \\\"value\\\": \\\"Cultivo de papas\\\",\\n        },\\n        {\\n            \\\"id\\\": \\\"011103\\\",\\n            \\\"value\\\": \\\"Cultivo de avena\\\"\\n        }\\n    ]\",\n    \"2-0\": \"identification (Chile)\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Si se quiere factura electrónicamente, el formato de la identificación debe ser el mismo que el RUT, es decir, entre 6 y 8 dígitos, un guión (\\\"-\\\") y otro dígito o una K.\",\n    \"2-3\": \"66666666-6\",\n    \"32-0\": \"economicActivity (Costa Rica)\",\n    \"32-1\": \"Int\",\n    \"32-2\": \"Actividad económica de la empresa.\",\n    \"32-3\": \"11101\",\n    \"33-0\": \"isActiveNoIvaDay (Colombia)\",\n    \"33-1\": \"Boolean\",\n    \"33-2\": \"Retorna true si la fecha corresponde a un día sin IVA y la empresa cumple con los requisitos para participar en este programa.\",\n    \"33-3\": \"...\\n\\\"isActiveNoIvaDay\\\": true,\\n...\"\n  },\n  \"cols\": 4,\n  \"rows\": 34\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b24e322d96461700599266","parentDoc":null,"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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":40,"createdAt":"2016-01-29T20:57:39.712Z"},"createdAt":"2016-02-03T19:00:02.993Z","editedParams":true,"githubsync":"","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Empresa","slug":"empresa","order":8,"from_sync":false,"reference":true,"_id":"56b4b3eb7bccae0d00e9a12e","version":"56abd2434e4b730d009eb10d","createdAt":"2016-02-05T14:38:35.098Z","project":"56abd2434e4b730d009eb10a","__v":0},"editedParams2":true,"project":"56abd2434e4b730d009eb10a","__v":22}