{"_id":"56b2579e9621f20d00efb319","parentDoc":null,"editedParams":true,"user":"56abd213d4432d1900eed227","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"},"project":"56abd2434e4b730d009eb10a","category":{"_id":"56abd4c8f25f160d00e17f81","pages":["56abd52535138c0d005c94cb","56abd70e0b9e0b0d006162a9","56b0b7da36d2580d002477d3","56b0bff78f7a4f0d0029dd38","56b0cbcbce5f410d0056c9c6","56b0dfa64b05c50d001ceaba","56b10d3f6d004b170080666c","56b10e196d004b170080666f","56b1110d02f4bc0d006ce29d","56b11ab7f48f270d00e0dd69","56b2081d1bc8490d00701f0c","56b20ae3a5a1020d00cf4c49","56b20eb17ae4550d0006291e","56b21ae8f48f270d00e0de9e","56b224cd2d9646170059921a","56b230d065ddf50d0076ba4d","56b231653b6f690d00bdb6e4","56b238bd3b6f690d00bdb6f2","56b238f62db51f0d0044e4b6","56b239539621f20d00efb2af","56b24b2565ddf50d0076ba82","56b24bd9f48f270d00e0df0e","56b24c703b6f690d00bdb702","56b24e322d96461700599266","56b24e9f9621f20d00efb304","56b2579e9621f20d00efb319","56b2611f65ddf50d0076bab3","56b262379621f20d00efb331","56b264a89621f20d00efb335","56b2683494ab060d00067427","56b2687ba5a1020d00cf4cda","56b269c2a5a1020d00cf4cdf"],"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":32,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-29T21:08:24.369Z","from_sync":false,"order":9,"slug":"api","title":"Pagos"},"editedParams2":true,"__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T19:40:14.149Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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"}]},"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}"}]},"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 pagos pueden estar asociados a facturas de venta, facturas de compra o categorías.\n\nUn ingreso o recibo de caja debe estar asociado a una factura de venta o a una categoría. Se identifican porque el atributo `type` es 'in' y representan un ingreso de dinero a la cuenta de Alegra.\n\nUn comprobante de egreso debe estar asociado a una factura de compra o a una categoría. En este caso el atributo `type` es 'out' y representan una salida de dinero de la cuenta de Alegra.\n\nUn pago representa un comprobante de egreso o un recibo de caja. Se puede identificar verificando el atributo `type` (in para ingresos y out para egresos) y por la asociación que tenga el pago (categories, invoices o bills), la cual indica las facturas de venta, las categorías o las facturas de compra que se pagaron con el documento. Por ejemplo un pago que sea de tipo 'in' y en sus atributos tenga invoices, representa un pago a facturas de venta. Si en cambio tiene categories, representa un ingreso asociado a una categoría.\n\nUn pago 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 pago. La aplicación lo asigna automáticamente.\",\n    \"1-0\": \"bankAccount\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"Objeto cuenta de banco que indica a dónde entró o de dónde salió el dinero para el pago.  \\nContiene los siguientes atributos:\\n* id : Identificador del banco.\\n* name: Nombre del banco.\\n* type: Tipo de cuenta de banco, las opciones posibles son bank, cash, credit-card.\",\n    \"3-0\": \"date\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Fecha de pago. Formato yyyy-MM-dd.\",\n    \"4-0\": \"paymentMethod\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Método de pago, las opciones posibles son: transfer, cash, deposit, check, credit-card, debit-card.\",\n    \"5-0\": \"observations\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Observaciones del pago.  No son visibles en el documento impreso.\",\n    \"6-0\": \"anotation\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Notas del pago. Visibles en el documento impreso.\",\n    \"7-0\": \"type\",\n    \"7-1\": \"String\",\n    \"7-2\": \"Indica si el pago es de ingreso o egreso.\",\n    \"9-0\": \"client\",\n    \"9-1\": \"Object\",\n    \"9-2\": \"Indica el cliente asociado al pago. \\nContiene los siguientes atirbutos:\\n* id: Identificador del cliente.\\n* name: Nombre del cliente.\\n* phone: Teléfono del cliente.\",\n    \"h-3\": \"Ejemplo\",\n    \"0-3\": \"12\",\n    \"1-3\": \"```\\n{\\n\\\"id\\\":\\\"1\\\",\\n\\\"name\\\": \\\"Bancolombia\\\",\\n\\\"type\\\":\\\"bank\\\"\\n}\\n```\",\n    \"3-3\": \"2015-12-10\",\n    \"4-3\": \"transfer\",\n    \"5-3\": \"Observaciones del pago\",\n    \"6-3\": \"Notas de mi pago\",\n    \"7-3\": \"in\",\n    \"9-3\": \"```\\n{\\n\\\"id\\\" : \\\"20\\\",\\n\\\"name\\\" : \\\"Juan Carlos\\\",\\n\\\"phone\\\" : \\\"310-58-58\\\"\\n}\\n```\",\n    \"10-0\": \"invoices\",\n    \"11-0\": \"bills\",\n    \"12-0\": \"categories\",\n    \"13-0\": \"retentions\",\n    \"14-0\": \"currency\",\n    \"10-2\": \"Array de objetos factura de venta que indica la(s) factura(s) de venta que se pagaron. \\nTodas las facturas de venta pagadas en el pago deben pertenecer al mismo cliente y deben tener la misma moneda.\\n\\nCada objeto tiene:\\n* id: Identificador de la factura.\\n* number: Número de la factura\\n* date: Fecha de la factura\\n* total: Monto total de la factura\\n* amount: Valor pagado en el pago actual.\",\n    \"11-2\": \"Array de objetos factura de compra que indica la(s) factura(s) de compra que se pagaron.\\n\\nTodas las facturas de compra pagadas en el mismo pago deben ser del mismo cliente y deben tener la misma moneda\\n\\nCada objeto tiene:\\n* id: Identificador de la factura.\\n* number: Número de la factura\\n* date: Fecha de la factura\\n* total: Monto total de la factura\\n* amount: Valor pagado en el pago actual.\",\n    \"12-2\": \"Array de objetos categoría que indica la(s) categoría(s) que se pagaron.\\n\\nCada objeto contiene los siguientes atributos:\\n* id: Identificador de la categoría.\\n* name: Nombre de la categoría.\\n* price: Valor pagado\\n* quantity: Cantidad de la categoría.\\n* observations: Observaciones de la categoría.\\n* tax : Array de objectos tax que contiene la información del impuesto de la categoría\\n* total: Total de la categoría. (no incluye impuestos).\",\n    \"13-2\": \"Array de objetos retención que indica las retenciones aplicadas en el pago, este atributo se envía únicamente cuando el pago está asociado a categorías y se realizaron retenciones.\",\n    \"14-2\": \"Objeto moneda que indica la moneda del pago y la tasa de cambio.\\n\\nSolo se incluye si la compañía tiene activa la funcionalidad de multimoneda y el pago está en una moneda diferente de la principal de la compañía. \\n\\nEste objecto contiene:\\n\\n* code : Código ISO de la moneda asociada a la empresa.\\n* exchangeRate: Tasa de cambio.\",\n    \"10-1\": \"Array\",\n    \"11-1\": \"Array\",\n    \"12-1\": \"Array\",\n    \"13-1\": \"Array\",\n    \"14-1\": \"Object\",\n    \"2-0\": \"number\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Número del recibo de caja o comprobante de egreso.\",\n    \"2-3\": \"5\",\n    \"10-3\": \"```\\n[\\n{\\n\\\"id\\\" : \\\"6\\\",\\n\\\"number\\\" : \\\"AL-12\\\",\\n\\\"date\\\" : \\\"2015-12-01\\\",\\n\\\"total\\\" : \\\"150\\\",\\n\\\"amount\\\" :  \\\"100\\\"\\n}\\n]\\n```\",\n    \"12-3\": \"```\\n[\\n{\\n\\\"id\\\" : 6,\\n\\\"name\\\" : \\\"Papelería\\\",\\n\\\"quantity\\\" : 10,\\n\\\"observations\\\" : \\\"Resma papel tamaño carta\\\",\\n\\\"price\\\" : 15,\\n\\\"tax\\\" : [\\n{                                        \\\"id\\\" : 6,                                     \\\"name\\\" : \\\"IVA\\\",                             \\\"percentage\\\" : 16,                 \\\"description\\\" : \\\"Impuesto de valor agregado\\\"\\n}\\n],\\n\\\"total\\\" : 150\\n}\\n]\\n```\",\n    \"11-3\": \"```\\n[\\n{\\n\\\"id\\\" : \\\"6\\\",\\n\\\"number\\\" : \\\"COMPRA-12\\\",\\n\\\"date\\\" : \\\"2016-02-01\\\",\\n\\\"total\\\" : \\\"9000\\\",\\n \\\"amount\\\" :  \\\"8500Ç\\\"\\n}\\n]\\n```\",\n    \"13-3\": \"```\\n[\\n{\\n\\\"id\\\": 1,\\n\\\"name\\\" : \\\"Compras\\\",\\n\\\"percentage\\\" : 3,5,\\n\\\"amount\\\" : 21.315\\n}\\n]\\n```\",\n    \"14-3\": \"`````\\n{\\n\\\"code\\\" : \\\"USD\\\",\\n\\\"symbol\\\" : \\\"$\\\",\\n\\\"exchangeRate\\\" : 2950\\n}\\n````\",\n    \"8-0\": \"status\",\n    \"8-1\": \"String\",\n    \"8-2\": \"Estado del pago, las opciones posibles son:\\n\\n*open : Estado normal del pago\\n*void: El pago se encuentra anulad.\",\n    \"8-3\": \"open\"\n  },\n  \"cols\": 4,\n  \"rows\": 15\n}\n[/block]","excerpt":"Endpoint /payments","slug":"pagos","type":"basic","title":"Descripción general"}

Descripción general

Endpoint /payments

Los pagos pueden estar asociados a facturas de venta, facturas de compra o categorías. Un ingreso o recibo de caja debe estar asociado a una factura de venta o a una categoría. Se identifican porque el atributo `type` es 'in' y representan un ingreso de dinero a la cuenta de Alegra. Un comprobante de egreso debe estar asociado a una factura de compra o a una categoría. En este caso el atributo `type` es 'out' y representan una salida de dinero de la cuenta de Alegra. Un pago representa un comprobante de egreso o un recibo de caja. Se puede identificar verificando el atributo `type` (in para ingresos y out para egresos) y por la asociación que tenga el pago (categories, invoices o bills), la cual indica las facturas de venta, las categorías o las facturas de compra que se pagaron con el documento. Por ejemplo un pago que sea de tipo 'in' y en sus atributos tenga invoices, representa un pago a facturas de venta. Si en cambio tiene categories, representa un ingreso asociado a una categoría. Un pago 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 pago. La aplicación lo asigna automáticamente.", "1-0": "bankAccount", "1-1": "Object", "1-2": "Objeto cuenta de banco que indica a dónde entró o de dónde salió el dinero para el pago. \nContiene los siguientes atributos:\n* id : Identificador del banco.\n* name: Nombre del banco.\n* type: Tipo de cuenta de banco, las opciones posibles son bank, cash, credit-card.", "3-0": "date", "3-1": "String", "3-2": "Fecha de pago. Formato yyyy-MM-dd.", "4-0": "paymentMethod", "4-1": "String", "4-2": "Método de pago, las opciones posibles son: transfer, cash, deposit, check, credit-card, debit-card.", "5-0": "observations", "5-1": "String", "5-2": "Observaciones del pago. No son visibles en el documento impreso.", "6-0": "anotation", "6-1": "String", "6-2": "Notas del pago. Visibles en el documento impreso.", "7-0": "type", "7-1": "String", "7-2": "Indica si el pago es de ingreso o egreso.", "9-0": "client", "9-1": "Object", "9-2": "Indica el cliente asociado al pago. \nContiene los siguientes atirbutos:\n* id: Identificador del cliente.\n* name: Nombre del cliente.\n* phone: Teléfono del cliente.", "h-3": "Ejemplo", "0-3": "12", "1-3": "```\n{\n\"id\":\"1\",\n\"name\": \"Bancolombia\",\n\"type\":\"bank\"\n}\n```", "3-3": "2015-12-10", "4-3": "transfer", "5-3": "Observaciones del pago", "6-3": "Notas de mi pago", "7-3": "in", "9-3": "```\n{\n\"id\" : \"20\",\n\"name\" : \"Juan Carlos\",\n\"phone\" : \"310-58-58\"\n}\n```", "10-0": "invoices", "11-0": "bills", "12-0": "categories", "13-0": "retentions", "14-0": "currency", "10-2": "Array de objetos factura de venta que indica la(s) factura(s) de venta que se pagaron. \nTodas las facturas de venta pagadas en el pago deben pertenecer al mismo cliente y deben tener la misma moneda.\n\nCada objeto tiene:\n* id: Identificador de la factura.\n* number: Número de la factura\n* date: Fecha de la factura\n* total: Monto total de la factura\n* amount: Valor pagado en el pago actual.", "11-2": "Array de objetos factura de compra que indica la(s) factura(s) de compra que se pagaron.\n\nTodas las facturas de compra pagadas en el mismo pago deben ser del mismo cliente y deben tener la misma moneda\n\nCada objeto tiene:\n* id: Identificador de la factura.\n* number: Número de la factura\n* date: Fecha de la factura\n* total: Monto total de la factura\n* amount: Valor pagado en el pago actual.", "12-2": "Array de objetos categoría que indica la(s) categoría(s) que se pagaron.\n\nCada objeto contiene los siguientes atributos:\n* id: Identificador de la categoría.\n* name: Nombre de la categoría.\n* price: Valor pagado\n* quantity: Cantidad de la categoría.\n* observations: Observaciones de la categoría.\n* tax : Array de objectos tax que contiene la información del impuesto de la categoría\n* total: Total de la categoría. (no incluye impuestos).", "13-2": "Array de objetos retención que indica las retenciones aplicadas en el pago, este atributo se envía únicamente cuando el pago está asociado a categorías y se realizaron retenciones.", "14-2": "Objeto moneda que indica la moneda del pago y la tasa de cambio.\n\nSolo se incluye si la compañía tiene activa la funcionalidad de multimoneda y el pago está en una moneda diferente de la principal de la compañía. \n\nEste objecto contiene:\n\n* code : Código ISO de la moneda asociada a la empresa.\n* exchangeRate: Tasa de cambio.", "10-1": "Array", "11-1": "Array", "12-1": "Array", "13-1": "Array", "14-1": "Object", "2-0": "number", "2-1": "String", "2-2": "Número del recibo de caja o comprobante de egreso.", "2-3": "5", "10-3": "```\n[\n{\n\"id\" : \"6\",\n\"number\" : \"AL-12\",\n\"date\" : \"2015-12-01\",\n\"total\" : \"150\",\n\"amount\" : \"100\"\n}\n]\n```", "12-3": "```\n[\n{\n\"id\" : 6,\n\"name\" : \"Papelería\",\n\"quantity\" : 10,\n\"observations\" : \"Resma papel tamaño carta\",\n\"price\" : 15,\n\"tax\" : [\n{ \"id\" : 6, \"name\" : \"IVA\", \"percentage\" : 16, \"description\" : \"Impuesto de valor agregado\"\n}\n],\n\"total\" : 150\n}\n]\n```", "11-3": "```\n[\n{\n\"id\" : \"6\",\n\"number\" : \"COMPRA-12\",\n\"date\" : \"2016-02-01\",\n\"total\" : \"9000\",\n \"amount\" : \"8500Ç\"\n}\n]\n```", "13-3": "```\n[\n{\n\"id\": 1,\n\"name\" : \"Compras\",\n\"percentage\" : 3,5,\n\"amount\" : 21.315\n}\n]\n```", "14-3": "`````\n{\n\"code\" : \"USD\",\n\"symbol\" : \"$\",\n\"exchangeRate\" : 2950\n}\n````", "8-0": "status", "8-1": "String", "8-2": "Estado del pago, las opciones posibles son:\n\n*open : Estado normal del pago\n*void: El pago se encuentra anulad.", "8-3": "open" }, "cols": 4, "rows": 15 } [/block]