{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Descripción general","type":"basic","slug":"ordenes-de-compra","excerpt":"Endpoint /purchase-orders","body":"Una órden de compra contiene los siguientes atributos:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Nombre\",\n    \"h-1\": \"Tipo\",\n    \"h-2\": \"Descripción\",\n    \"h-3\": \"Ejemplo\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"Identificador único que representa una órden de compra específica. La aplicación lo asigna automáticamente.\",\n    \"0-3\": \"1\",\n    \"1-0\": \"date\",\n    \"1-1\": \"String.  Formato yyyy-MM-dd\",\n    \"1-2\": \"Fecha de la órden de compra.\",\n    \"1-3\": \"2019-02-12\",\n    \"2-0\": \"deliveryDate\",\n    \"2-1\": \"String.  Formato yyyy-MM-dd\",\n    \"2-2\": \"Fecha de entrega de la órden de compra.\",\n    \"2-3\": \"2019-02-22\",\n    \"3-0\": \"observations\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Observaciones de la órden de compra.\",\n    \"3-3\": \"Estas son las observaciones de mi órden de compra.\",\n    \"4-0\": \"termsConditions\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Términos y condiciones aplicables a la órden de compra.\",\n    \"4-3\": \"Limite garantía de 1 año\",\n    \"5-0\": \"anotation\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Notas de la órden de compra.\",\n    \"5-3\": \"Se debe entregar en empaque especial.\",\n    \"6-0\": \"status\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Estado de la órden de compra, las opciones posibles son: \\n* open : La órden no se ha pagado completamente.\\n* closed: La órden se ha pagado completamente.\\n* Void: La órden se ha anulado.\",\n    \"6-3\": \"open\",\n    \"7-0\": \"provider\",\n    \"7-1\": \"Object\",\n    \"7-2\": \"Objeto que contiene la información del proveedor asociado a la órden.\",\n    \"7-3\": \"```\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Coorporación Alegrate\\\",                        \\\"identification\\\": \\\"159.549.847\\\",\\n\\\"email\\\": \\\"prueba:::at:::alegra.com\\\",                      \\\"phonePrimary\\\": \\\"999-99-99\\\",\\n\\\"phoneSecondary\\\": \\\"\\\",\\n\\\"fax\\\": \\\"\\\",\\n\\\"mobile\\\": \\\"(333) 555-55-55\\\"\\n}\\n```\",\n    \"8-0\": \"provider (Perú)\",\n    \"8-1\": \"Object\",\n    \"8-2\": \"**Solo para versión Alegra Perú**\\n\\nObjeto que contiene la información del proveedor asociado a la órden.\\n\\nEn Perú el atributo `identification` pasa a ser un objeto que contiene el atributo `number` con la identificación del proveedor.\",\n    \"8-3\": \"```\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Coorporación Alegrate\\\",                        \\\"identification\\\": {\\n\\\"number\\\": \\\"159.549.847\\\"\\n},\\n\\\"email\\\": \\\"[email protected]\\\",                      \\\"phonePrimary\\\": \\\"999-99-99\\\",\\n\\\"phoneSecondary\\\": \\\"\\\",\\n\\\"fax\\\": \\\"\\\",\\n\\\"mobile\\\": \\\"(333) 555-55-55\\\"\\n}\\n```\",\n    \"9-0\": \"provider (Colombia)\",\n    \"9-1\": \"Object\",\n    \"9-2\": \"**Solo para versión Alegra Colombia**\\n\\nObjeto que contiene la información del proveedor asociado a la órden.\\n\\nEn Colombia contiene el atributo adicional `identificationObject` el cual es un objeto que consta del atributo `number` con la identificación del proveedor.\",\n    \"9-3\": \"```\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Coorporación Alegrate\\\",                        \\n\\\"identification\\\": \\\"159.549.847\\\",\\n\\\"identificationObject\\\": {\\n\\\"number\\\": \\\"159.549.847\\\"\\n},\\n\\\"email\\\": \\\"[email protected]\\\",                      \\\"phonePrimary\\\": \\\"999-99-99\\\",\\n\\\"phoneSecondary\\\": \\\"\\\",\\n\\\"fax\\\": \\\"\\\",\\n\\\"mobile\\\": \\\"(333) 555-55-55\\\"\\n}\\n```\",\n    \"10-0\": \"numberTemplate\",\n    \"10-1\": \"Object\",\n    \"10-2\": \"Objeto que contiene la información de la numeración de la órden.  Contiene los siguientes atributos:\\n* number: Número de la factura.\",\n    \"10-3\": \"```\\n{\\n\\\"number\\\" : 520,\\n\\\"prefix\\\": \\\"RE\\\"\\n}\\n```\",\n    \"11-0\": \"numberTemplate (República Dominicana)\",\n    \"11-1\": \"Object\",\n    \"11-2\": \"**Solo para versión Alegra República Dominicana**\\n\\nObjeto que contiene la información de la numeración de la órden.  Contiene los siguientes atributos:\\n* prefix: Prefijo de la factura.\\n* number: Número de la factura.\\n* informalProvider: Indica si es un proveedor informal.\",\n    \"11-3\": \"```\\n{\\n\\\"prefix\\\": \\\"B1\\\",\\n\\\"number\\\" : 100000001,\\n\\\"informalProvider\\\": true\\n}\\n```\",\n    \"12-0\": \"total\",\n    \"12-1\": \"Double\",\n    \"12-2\": \"Total de la órden de compra. Se debe tener en cuenta que el total de la órden es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la factura.\",\n    \"12-3\": \"12500.45\",\n    \"13-0\": \"subTotal\",\n    \"13-1\": \"Double\",\n    \"13-2\": \"Sub Total de la órden de compra. Se debe tener en cuenta que el total de la órden es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la factura.\",\n    \"13-3\": \"10500.00\",\n    \"14-0\": \"decimalPrecision\",\n    \"14-1\": \"Integer\",\n    \"14-2\": \"Precisión decimal de la órden de compra.\",\n    \"14-3\": \"2\",\n    \"15-0\": \"warehouse\",\n    \"15-1\": \"Object\",\n    \"15-2\": \"Objeto que contiene la información de la bodega de la órden.\\nContiene los siguientes atributos:\\n* id: Identificador único que representa una bodega específica.\\n* name: Nombre de la bodega.\",\n    \"15-3\": \"```\\n{\\n\\\"id\\\" : 1,\\n\\\"name\\\" : \\\"Nombre de la bodega\\\"\\n}\\n```\",\n    \"16-0\": \"purchases\",\n    \"16-1\": \"Object\",\n    \"16-2\": \"Objeto que contiene los productos y categorías de la órden.\\nContiene los siguientes atributos:\\n\\n**items**: Array de objetos Item, que contiene los productos.\\nCada objeto contiene los siguientes atributos:\\n* id: Identificador del producto. \\n* name: Nombre del producto.\\n* discount: Porcentaje de descuento aplicado al producto.\\n* observations: Observaciones del producto. \\n* tax: Array de objetos tax que indican los impuestos aplicados al producto al momento de la compra.\\n* price: Precio de compra del producto.\\n* quantity: Cantidad comprada del producto.\\n* total: Total del producto (no incluye impuestos).\\n* subtotal: Subtotal del producto.\\n\\n**categories**: Array de objetos category, que contiene las categorías.\\nCada objeto contiene los siguientes atributos:\\n* id: Identificador de la categoría. \\n* name: Nombre de la categoría.\\n* discount: Porcentaje de descuento aplicado a la categoría.\\n* observations: Observaciones de la categoría. \\n* tax: Array de objetos tax que indican los impuestos aplicados a la categoría al momento de la compra.\\n* price: Precio de compra de la categoría.\\n* quantity: Cantidad comprada de la categoría.\\n* total: Total de la categoría (no incluye impuestos).\\n* subtotal: Subtotal de la categoría.\",\n    \"16-3\": \"```\\n{\\n\\\"items\\\": [\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\": \\\"Billetera\\\",\\n\\\"observations\\\": \\\"Billetera de cuero negro\\\",\\n\\\"discount\\\" : 10,\\n\\\"tax\\\" : [\\n{\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"IVA\\\",\\n\\\"percentage\\\" : 16,\\n\\\"description\\\" : \\\"Impuesto de valor agregado\\\",\\n\\\"type\\\": \\\"IVA\\\",\\n\\\"status\\\": \\\"active\\\"\\n}\\n],\\n\\\"price\\\" : 80,\\n\\\"quantity\\\" : 5,\\n\\\"total\\\" : 360,\\n\\\"subtotal\\\": 360\\n}\\n],\\n\\\"categories\\\": [\\n{\\n\\\"id\\\": 5091,\\n\\\"name\\\": \\\"Otros gastos\\\",\\n\\\"observations\\\": \\\"Observaciones de la categoría.\\\",\\n\\\"discount\\\" : 10,\\n\\\"tax\\\" : [\\n{\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"IVA\\\",\\n\\\"percentage\\\" : 16,\\n\\\"description\\\" : \\\"Impuesto de valor agregado\\\",\\n\\\"type\\\": \\\"IVA\\\",\\n\\\"status\\\": \\\"active\\\"\\n}\\n],\\n\\\"price\\\" : 80,\\n\\\"quantity\\\" : 5,\\n\\\"total\\\" : 360,\\n\\\"subtotal\\\": 360\\n}\\n]\\n}\\n```\",\n    \"17-0\": \"currency\",\n    \"17-1\": \"Object\",\n    \"17-2\": \"Objeto que incluye la información de la moneda asociada a la factura.\\n** Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.\\n**\\nEste objeto contiene:\\n* code : Código ISO de la moneda asociada a la empresa.\\n* exchangeRate: Tasa de cambio.\",\n    \"17-3\": \"```\\n{\\n\\\"code\\\" : \\\"USD\\\",\\n\\\"symbol\\\" : \\\"$\\\",\\n\\\"exchangeRae\\\" : 2950\\n}\\n```\"\n  },\n  \"cols\": 4,\n  \"rows\": 18\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e9f0dea4b3a920065ffbfbc","createdAt":"2020-04-21T15:14:50.602Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Órdenes de Compra","slug":"órdenes-de-compra","order":26,"from_sync":false,"reference":false,"_id":"5e9f0d4c720ad8006c6c7dc1","createdAt":"2020-04-21T15:12:12.508Z","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":0},"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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"project":"56abd2434e4b730d009eb10a","__v":0,"parentDoc":null}

Descripción general

Endpoint /purchase-orders

Una órden de compra contiene los siguientes atributos: [block:parameters] { "data": { "h-0": "Nombre", "h-1": "Tipo", "h-2": "Descripción", "h-3": "Ejemplo", "0-0": "id", "0-1": "Integer", "0-2": "Identificador único que representa una órden de compra específica. La aplicación lo asigna automáticamente.", "0-3": "1", "1-0": "date", "1-1": "String. Formato yyyy-MM-dd", "1-2": "Fecha de la órden de compra.", "1-3": "2019-02-12", "2-0": "deliveryDate", "2-1": "String. Formato yyyy-MM-dd", "2-2": "Fecha de entrega de la órden de compra.", "2-3": "2019-02-22", "3-0": "observations", "3-1": "String", "3-2": "Observaciones de la órden de compra.", "3-3": "Estas son las observaciones de mi órden de compra.", "4-0": "termsConditions", "4-1": "String", "4-2": "Términos y condiciones aplicables a la órden de compra.", "4-3": "Limite garantía de 1 año", "5-0": "anotation", "5-1": "String", "5-2": "Notas de la órden de compra.", "5-3": "Se debe entregar en empaque especial.", "6-0": "status", "6-1": "String", "6-2": "Estado de la órden de compra, las opciones posibles son: \n* open : La órden no se ha pagado completamente.\n* closed: La órden se ha pagado completamente.\n* Void: La órden se ha anulado.", "6-3": "open", "7-0": "provider", "7-1": "Object", "7-2": "Objeto que contiene la información del proveedor asociado a la órden.", "7-3": "```\n{\n\"id\": 1,\n\"name\": \"Coorporación Alegrate\", \"identification\": \"159.549.847\",\n\"email\": \"[email protected]\", \"phonePrimary\": \"999-99-99\",\n\"phoneSecondary\": \"\",\n\"fax\": \"\",\n\"mobile\": \"(333) 555-55-55\"\n}\n```", "8-0": "provider (Perú)", "8-1": "Object", "8-2": "**Solo para versión Alegra Perú**\n\nObjeto que contiene la información del proveedor asociado a la órden.\n\nEn Perú el atributo `identification` pasa a ser un objeto que contiene el atributo `number` con la identificación del proveedor.", "8-3": "```\n{\n\"id\": 1,\n\"name\": \"Coorporación Alegrate\", \"identification\": {\n\"number\": \"159.549.847\"\n},\n\"email\": \"[email protected]\", \"phonePrimary\": \"999-99-99\",\n\"phoneSecondary\": \"\",\n\"fax\": \"\",\n\"mobile\": \"(333) 555-55-55\"\n}\n```", "9-0": "provider (Colombia)", "9-1": "Object", "9-2": "**Solo para versión Alegra Colombia**\n\nObjeto que contiene la información del proveedor asociado a la órden.\n\nEn Colombia contiene el atributo adicional `identificationObject` el cual es un objeto que consta del atributo `number` con la identificación del proveedor.", "9-3": "```\n{\n\"id\": 1,\n\"name\": \"Coorporación Alegrate\", \n\"identification\": \"159.549.847\",\n\"identificationObject\": {\n\"number\": \"159.549.847\"\n},\n\"email\": \"[email protected]\", \"phonePrimary\": \"999-99-99\",\n\"phoneSecondary\": \"\",\n\"fax\": \"\",\n\"mobile\": \"(333) 555-55-55\"\n}\n```", "10-0": "numberTemplate", "10-1": "Object", "10-2": "Objeto que contiene la información de la numeración de la órden. Contiene los siguientes atributos:\n* number: Número de la factura.", "10-3": "```\n{\n\"number\" : 520,\n\"prefix\": \"RE\"\n}\n```", "11-0": "numberTemplate (República Dominicana)", "11-1": "Object", "11-2": "**Solo para versión Alegra República Dominicana**\n\nObjeto que contiene la información de la numeración de la órden. Contiene los siguientes atributos:\n* prefix: Prefijo de la factura.\n* number: Número de la factura.\n* informalProvider: Indica si es un proveedor informal.", "11-3": "```\n{\n\"prefix\": \"B1\",\n\"number\" : 100000001,\n\"informalProvider\": true\n}\n```", "12-0": "total", "12-1": "Double", "12-2": "Total de la órden de compra. Se debe tener en cuenta que el total de la órden es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la factura.", "12-3": "12500.45", "13-0": "subTotal", "13-1": "Double", "13-2": "Sub Total de la órden de compra. Se debe tener en cuenta que el total de la órden es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la factura.", "13-3": "10500.00", "14-0": "decimalPrecision", "14-1": "Integer", "14-2": "Precisión decimal de la órden de compra.", "14-3": "2", "15-0": "warehouse", "15-1": "Object", "15-2": "Objeto que contiene la información de la bodega de la órden.\nContiene los siguientes atributos:\n* id: Identificador único que representa una bodega específica.\n* name: Nombre de la bodega.", "15-3": "```\n{\n\"id\" : 1,\n\"name\" : \"Nombre de la bodega\"\n}\n```", "16-0": "purchases", "16-1": "Object", "16-2": "Objeto que contiene los productos y categorías de la órden.\nContiene los siguientes atributos:\n\n**items**: Array de objetos Item, que contiene los productos.\nCada objeto contiene los siguientes atributos:\n* id: Identificador del producto. \n* name: Nombre del producto.\n* discount: Porcentaje de descuento aplicado al producto.\n* observations: Observaciones del producto. \n* tax: Array de objetos tax que indican los impuestos aplicados al producto al momento de la compra.\n* price: Precio de compra del producto.\n* quantity: Cantidad comprada del producto.\n* total: Total del producto (no incluye impuestos).\n* subtotal: Subtotal del producto.\n\n**categories**: Array de objetos category, que contiene las categorías.\nCada objeto contiene los siguientes atributos:\n* id: Identificador de la categoría. \n* name: Nombre de la categoría.\n* discount: Porcentaje de descuento aplicado a la categoría.\n* observations: Observaciones de la categoría. \n* tax: Array de objetos tax que indican los impuestos aplicados a la categoría al momento de la compra.\n* price: Precio de compra de la categoría.\n* quantity: Cantidad comprada de la categoría.\n* total: Total de la categoría (no incluye impuestos).\n* subtotal: Subtotal de la categoría.", "16-3": "```\n{\n\"items\": [\n{\n\"id\": 1,\n\"name\": \"Billetera\",\n\"observations\": \"Billetera de cuero negro\",\n\"discount\" : 10,\n\"tax\" : [\n{\n\"id\" : 6,\n\"name\" : \"IVA\",\n\"percentage\" : 16,\n\"description\" : \"Impuesto de valor agregado\",\n\"type\": \"IVA\",\n\"status\": \"active\"\n}\n],\n\"price\" : 80,\n\"quantity\" : 5,\n\"total\" : 360,\n\"subtotal\": 360\n}\n],\n\"categories\": [\n{\n\"id\": 5091,\n\"name\": \"Otros gastos\",\n\"observations\": \"Observaciones de la categoría.\",\n\"discount\" : 10,\n\"tax\" : [\n{\n\"id\" : 6,\n\"name\" : \"IVA\",\n\"percentage\" : 16,\n\"description\" : \"Impuesto de valor agregado\",\n\"type\": \"IVA\",\n\"status\": \"active\"\n}\n],\n\"price\" : 80,\n\"quantity\" : 5,\n\"total\" : 360,\n\"subtotal\": 360\n}\n]\n}\n```", "17-0": "currency", "17-1": "Object", "17-2": "Objeto que incluye la información de la moneda asociada a la factura.\n** Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.\n**\nEste objeto contiene:\n* code : Código ISO de la moneda asociada a la empresa.\n* exchangeRate: Tasa de cambio.", "17-3": "```\n{\n\"code\" : \"USD\",\n\"symbol\" : \"$\",\n\"exchangeRae\" : 2950\n}\n```" }, "cols": 4, "rows": 18 } [/block]