{"_id":"56b0bff78f7a4f0d0029dd38","category":{"_id":"56b3b8ea9f97020d0012d936","__v":1,"pages":["56d5f18b31857e2500db0d4b"],"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-04T20:47:38.572Z","from_sync":false,"order":1,"slug":"productos-o-servicios","title":"Productos o servicios"},"parentDoc":null,"__v":1,"project":"56abd2434e4b730d009eb10a","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":20,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"editedParams":true,"editedParams2":true,"user":"56abd213d4432d1900eed227","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-02T14:40:55.925Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"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,"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}","language":"json","status":404}]},"settings":"","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"}]},"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":"Los productos o servicios representan lo que tu negocio vende y/o compra.\n\nLos productos son objetos tangibles que tu empresa tiene disponible para la venta y a los cuales les controlas el inventario. (En la aplicación se conoce como inventariables). Estos deben tener una unidad de medida (metros, cm, litros), una cantidad inicial (el número de productos disponibles inicialmente para la venta) y un costo unitario. Al realizar movimientos con estos productos la aplicación automáticamente actualiza el inventario en cuanto a costo unitario y cantidades.\n\nA un servicio, por el contrario, no se le controla el inventario.\n\nAlegra soporta listas de precios, por lo tanto el precio de un producto o servicio puede estar conformado por varias listas de precio. Todas las cuentas de Alegra cuentan con una lista de precios llamada \"General\", en ésta se registra el precio general del producto. Al consultar un producto o servicio por el API, el precio va a estar conformado por todas las listas de precio. Si se desea consultar el precio general del producto, se debe consultar el precio indicado en la lista de precios General (o identificada con el id 1). Para saber más sobre listas de precio haz clic [aquí](http://ayuda.alegra.com/hc/es/articles/205799159-Configuraci%C3%B3n-de-listas-de-precio-en-Alegra).\n\nUn producto o servicio 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\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Identificador único que representa un producto o servicio específico. La aplicación lo asigna automáticamente.\",\n    \"1-0\": \"name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Nombre del producto o servicio.\",\n    \"2-0\": \"description\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Descripción del producto o servicio.\",\n    \"3-0\": \"reference\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Referencia o código que identifica un producto o servicio.\",\n    \"4-0\": \"price\",\n    \"4-1\": \"Array de objetos PriceList\",\n    \"4-2\": \"Indica los precios asociados al producto o servicio. Cada objeto PriceList contiene los siguientes atributos: \\n* idPriceList : Identificador único que representa una lista de precios específica.\\n* name: Nombre de la lista de precios.  Por ejemplo \\\"General\\\", \\\"Distribuidor\\\"\\n* price: precio del producto en esa lista de precios.\",\n    \"5-0\": \"tax\",\n    \"5-1\": \"Array de objetos Tax\",\n    \"5-2\": \"Indica el impuesto asociado al producto o servicio. Cada objeto tax contiene los siguientes atributos:\\n* id: Identificador del impuesto.\\n* name : Nombre del impuesto.  Por ejemplo \\\"IVA\\\".\\n* percentage: Porcentaje del impuesto. Ej: 16.\\n* description: Descripción del impuesto.\\n* status: Estado del impuesto, puede ser active para un impuesto *activo*, o *inactive* para un impuesto que se encuentra deshabilitado\",\n    \"6-0\": \"category\",\n    \"6-1\": \"Object\",\n    \"6-2\": \"Objeto que contiene la información de la categoría asociada al producto o servicio. Este objeto indica la categoría de Alegra a la cual se llevan los registros de tus ventas cuando realizas movimientos con este producto o servicio.\\nLa categoría está compuesta por los siguientes atributos:\\n* id: Identificador de la categoría.\\n* name : Nombre de la categoría.\",\n    \"7-0\": \"inventory\",\n    \"7-1\": \"Object\",\n    \"7-2\": \"Objeto que contiene la información del inventario del producto. Si este objeto está presente indica que el artículo es inventariable, si no lo está se asume como servicio.\\nContiene los siguientes atributos:\\n* unit : Indica la unidad de medida del producto.\\n* availableQuantity: Indica la cantidad disponible en el inventario. Si el producto se encuentra distribuido en múltiples bodegas, este atributo retorna la cantidad disponible en todas las bodegas.\\n* unitCost : Indica el costo unitario del producto.\\n* initialQuantity: Indica la cantidad inicial con la cual se creó el producto.  Si el producto se encuentra distribuido en múltiples bodegas, este atributo retorna la cantidad inicial en todas las bodegas.\\n* warehouses : Array de objetos warehouse que indican las bodegas asociadas al producto.  Cada objeto warehouse contiene los siguientes atributos: \\n    * id: Identificador único de la bodega.\\n    * name: Nombre de la bodega.\\n    * observations : Observaciones de la bdoega.\\n    * isDefault: Indica si la bodega es la de por defecto.\\n    * address: Dirección de la bodega.\\n    * status : Estado de la bodega, puede ser active o inactive.\\n    * initialQuantity: Cantidad inicial del producto en la bodega.\\n    * availableQuantity: Cantidad disponible del producto en la bodega.\",\n    \"h-3\": \"Ejemplo\",\n    \"0-3\": \"12\",\n    \"1-3\": \"Billetera de cuero\",\n    \"2-3\": \"Billetera de cuero negro\",\n    \"3-3\": \"BILL-123\",\n    \"4-3\": \"```\\n[ {                                   \\\"idPriceList\\\" : 1,\\n\\\"name\\\" : \\\"Principal\\\",\\n  \\\"price\\\" : 1200\\n} ]\\n```\",\n    \"5-3\": \"```\\n[ {\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"IVA\\\",\\n\\\"percentage\\\" : 16,\\n\\\"description\\\" : \\\"Impuesto de valor agregado\\\",\\n\\\"status\\\": \\\"active\\\"\\n} ]\\n```\",\n    \"6-3\": \"```\\n{\\n\\\"id\\\": 54,\\n\\\"name\\\" : \\\"Ventas\\\"\\n}\\n```\",\n    \"7-3\": \"```\\n{\\n\\\"unit\\\" : \\\"meter\\\",\\n\\\"availableQuantity\\\" : 150,\\n\\\"unitCost\\\" : 560,\\n \\\"initialQuantity\\\" : 320,\\n \\\"warehouses\\\": [\\n   {\\n     \\\"id\\\": \\\"1\\\",\\n     \\\"name\\\": \\\"Bodega Norte\\\",\\n     \\\"observations\\\": null,\\n     \\\"isDefault\\\": true,\\n     \\\"address\\\":\\\"Dirección de la bodega Norte\\\",\\n     \\\"status\\\": \\\"active\\\",\\n     \\\"initialQuantity\\\": \\\"320.0\\\",\\n     \\\"availableQuantity\\\": \\\"150\\\"\\n   }\\n ]\\n}\\n```\",\n    \"8-0\": \"status\",\n    \"8-1\": \"String\",\n    \"8-2\": \"Indica el estado del producto o servicio. Las opciones posibles son:\\n* active: para productos que se encuentran activos\\n* inactive: para productos que se encuentran inactivos\",\n    \"8-3\": \"active\"\n  },\n  \"cols\": 4,\n  \"rows\": 9\n}\n[/block]","excerpt":"Endpoint /items","slug":"productos-o-servicios","type":"basic","title":"Descripción general"}

Descripción general

Endpoint /items

Los productos o servicios representan lo que tu negocio vende y/o compra. Los productos son objetos tangibles que tu empresa tiene disponible para la venta y a los cuales les controlas el inventario. (En la aplicación se conoce como inventariables). Estos deben tener una unidad de medida (metros, cm, litros), una cantidad inicial (el número de productos disponibles inicialmente para la venta) y un costo unitario. Al realizar movimientos con estos productos la aplicación automáticamente actualiza el inventario en cuanto a costo unitario y cantidades. A un servicio, por el contrario, no se le controla el inventario. Alegra soporta listas de precios, por lo tanto el precio de un producto o servicio puede estar conformado por varias listas de precio. Todas las cuentas de Alegra cuentan con una lista de precios llamada "General", en ésta se registra el precio general del producto. Al consultar un producto o servicio por el API, el precio va a estar conformado por todas las listas de precio. Si se desea consultar el precio general del producto, se debe consultar el precio indicado en la lista de precios General (o identificada con el id 1). Para saber más sobre listas de precio haz clic [aquí](http://ayuda.alegra.com/hc/es/articles/205799159-Configuraci%C3%B3n-de-listas-de-precio-en-Alegra). Un producto o servicio contiene los siguientes atributos: [block:parameters] { "data": { "h-0": "Nombre", "h-1": "Tipo", "h-2": "Descripción", "0-0": "id", "0-1": "Integer", "0-2": "Identificador único que representa un producto o servicio específico. La aplicación lo asigna automáticamente.", "1-0": "name", "1-1": "String", "1-2": "Nombre del producto o servicio.", "2-0": "description", "2-1": "String", "2-2": "Descripción del producto o servicio.", "3-0": "reference", "3-1": "String", "3-2": "Referencia o código que identifica un producto o servicio.", "4-0": "price", "4-1": "Array de objetos PriceList", "4-2": "Indica los precios asociados al producto o servicio. Cada objeto PriceList contiene los siguientes atributos: \n* idPriceList : Identificador único que representa una lista de precios específica.\n* name: Nombre de la lista de precios. Por ejemplo \"General\", \"Distribuidor\"\n* price: precio del producto en esa lista de precios.", "5-0": "tax", "5-1": "Array de objetos Tax", "5-2": "Indica el impuesto asociado al producto o servicio. Cada objeto tax contiene los siguientes atributos:\n* id: Identificador del impuesto.\n* name : Nombre del impuesto. Por ejemplo \"IVA\".\n* percentage: Porcentaje del impuesto. Ej: 16.\n* description: Descripción del impuesto.\n* status: Estado del impuesto, puede ser active para un impuesto *activo*, o *inactive* para un impuesto que se encuentra deshabilitado", "6-0": "category", "6-1": "Object", "6-2": "Objeto que contiene la información de la categoría asociada al producto o servicio. Este objeto indica la categoría de Alegra a la cual se llevan los registros de tus ventas cuando realizas movimientos con este producto o servicio.\nLa categoría está compuesta por los siguientes atributos:\n* id: Identificador de la categoría.\n* name : Nombre de la categoría.", "7-0": "inventory", "7-1": "Object", "7-2": "Objeto que contiene la información del inventario del producto. Si este objeto está presente indica que el artículo es inventariable, si no lo está se asume como servicio.\nContiene los siguientes atributos:\n* unit : Indica la unidad de medida del producto.\n* availableQuantity: Indica la cantidad disponible en el inventario. Si el producto se encuentra distribuido en múltiples bodegas, este atributo retorna la cantidad disponible en todas las bodegas.\n* unitCost : Indica el costo unitario del producto.\n* initialQuantity: Indica la cantidad inicial con la cual se creó el producto. Si el producto se encuentra distribuido en múltiples bodegas, este atributo retorna la cantidad inicial en todas las bodegas.\n* warehouses : Array de objetos warehouse que indican las bodegas asociadas al producto. Cada objeto warehouse contiene los siguientes atributos: \n * id: Identificador único de la bodega.\n * name: Nombre de la bodega.\n * observations : Observaciones de la bdoega.\n * isDefault: Indica si la bodega es la de por defecto.\n * address: Dirección de la bodega.\n * status : Estado de la bodega, puede ser active o inactive.\n * initialQuantity: Cantidad inicial del producto en la bodega.\n * availableQuantity: Cantidad disponible del producto en la bodega.", "h-3": "Ejemplo", "0-3": "12", "1-3": "Billetera de cuero", "2-3": "Billetera de cuero negro", "3-3": "BILL-123", "4-3": "```\n[ { \"idPriceList\" : 1,\n\"name\" : \"Principal\",\n \"price\" : 1200\n} ]\n```", "5-3": "```\n[ {\n\"id\" : 6,\n\"name\" : \"IVA\",\n\"percentage\" : 16,\n\"description\" : \"Impuesto de valor agregado\",\n\"status\": \"active\"\n} ]\n```", "6-3": "```\n{\n\"id\": 54,\n\"name\" : \"Ventas\"\n}\n```", "7-3": "```\n{\n\"unit\" : \"meter\",\n\"availableQuantity\" : 150,\n\"unitCost\" : 560,\n \"initialQuantity\" : 320,\n \"warehouses\": [\n {\n \"id\": \"1\",\n \"name\": \"Bodega Norte\",\n \"observations\": null,\n \"isDefault\": true,\n \"address\":\"Dirección de la bodega Norte\",\n \"status\": \"active\",\n \"initialQuantity\": \"320.0\",\n \"availableQuantity\": \"150\"\n }\n ]\n}\n```", "8-0": "status", "8-1": "String", "8-2": "Indica el estado del producto o servicio. Las opciones posibles son:\n* active: para productos que se encuentran activos\n* inactive: para productos que se encuentran inactivos", "8-3": "active" }, "cols": 4, "rows": 9 } [/block]