{"_id":"56b262379621f20d00efb331","user":"56abd213d4432d1900eed227","editedParams2":true,"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,"parentDoc":null,"project":"56abd2434e4b730d009eb10a","__v":2,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-03T20:25:27.294Z","link_external":false,"link_url":"","githubsync":"","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/payments/ -u 'usuario:::at:::alegra.co:mitoken'","language":"curl"}]},"method":"get","results":{"codes":[{"language":"json","code":"[\n  {\n    \"id\" : 1,\n    \"date\": \"2015-12-10\",\n    \"paymentMethod\": \"cash\",\n    \"observations\": \"Observaciones del pago\",\n    \"anotation\": \"Notas de mi pago\",\n    \"client\": {\n      \"id\" : \"20\",\n      \"name\" : \"Juan Carlos\",\n      \"phone\" : \"310-58-58\"\n      },\n    \"invoices\" : [\n      {\n        \"id\" : 6,\n        \"number\" : \"AL-12\",\n        \"date\" : \"2015-12-01\",\n        \"total\" : 150,\n        \"totalPaid\" :  100,\n        \"balance\":50\n        }, \n      {\n        \"id\" :200,\n        \"amount\" : 500\n        }\n      ],\n    \"bankAccount\" : {\n      \"id\" : 2,\n      \"name\" : \"Bancolombia\",\n      \"type\" : \"bank\"\n      },\n    \"currency\" : {\n      \"code\" : \"USD\",\n      \"symbol\" : \"$\",\n      \"exchangeRate\" : 3200\n      }\n    },\n  {\n    \"id\" : 2,\n    \"date\": \"2015-12-15\",\n    \"paymentMethod\": \"transfer\",\n    \"observations\": \"Pago papelería diciembre\",\n    \"anotation\": \"\",\n    \"client\" : null,\n    \"type\" : \"in\",\n    \"bankAccount\" : {\n      \"id\" : 1,\n      \"name\" : \"Caja mejor\",\n      \"type\" : \"cash\"\n      },\n    \"categories\" : [\n      {\n        \"id\" : 6,\n        \"name\" : \"Papelería\",\n        \"quantity\" : 10,\n        \"observations\" : \"Resma papel tamaño carta\",\n        \"price\" : 15,\n        \"tax\" : [\n          {\n            \"id\" : 6,\n            \"name\" : \"IVA\",\n            \"percentage\" : 16,\n            \"description\" : \"Impuesto de valor agregado\",\n            \"status\" : \"active\"\n            }\n          ]\n        }\n      ]\n    }\n]","status":200,"name":"Ejemplo consulta exitosa"},{"status":400,"name":"Bad Request - Límite sobrepasa máximo permitido","code":"{ \n\t\"error\": \"El límite de pagos para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}","language":"text"},{"code":"{\n  \"metadata\" : {\n    \"total\" : 20\n  },\n  \"data\": [\n            {\n                \"id\" : 1,\n                \"date\": \"2015-12-10\",\n                \"paymentMethod\": \"cash\",\n                \"observations\": \"Observaciones del pago\",\n                \"anotation\": \"Notas de mi pago\",\n                \"client\": {\n                        \"id\" : \"20\",\n                        \"name\" : \"Juan Carlos\",\n                        \"phone\" : \"310-58-58\"\n                        },\n                \"invoices\" : [\n                            {\n                                \"id\" : 6,\n                                \"number\" : \"AL-12\",\n                                \"date\" : \"2015-12-01\",\n                                \"total\" : 150,\n                                \"totalPaid\" :  100\n                            }, \n                            {\n                             \"id\" :200,\n                             \"amount\" : 500\n                            }\n                        ],\n                \"bankAccount\" :{\n                            \"id\" : 2,\n                            \"name\" : \"Bancolombia\",\n                            \"type\" : \"bank\"\n                },\n                \"currency\" : {\n                    \"code\" : \"USD\",\n                    \"exchangeRate\" : 3200\n                }\n            },\n           {\n                \"id\" : 2,\n                \"date\": \"2015-12-15\",\n                \"paymentMethod\": \"transfer\",\n                \"observations\": \"Pago papelería diciembre\",\n                \"anotation\": \"\",\n                \"client\" : {},\n                \"type\" : \"in\",\n                \"bankAccount\" :{\n                            \"id\" : 1,\n                            \"name\" : \"Caja mejor\",\n                            \"type\" : \"cash\"\n                },\n                \"categories\" : [\n                            {\n                                \"id\" : 6,\n                                \"name\" : \"Papelería\",\n                                \"quantity\" : 10,\n                                \"observations\" : \"Resma papel tamaño carta\",\n                                \"price\" : 15,\n                                \"tax\" : [\n                                {\n                                    \"id\" : 2,\n                                    \"percentage\" : 16\n                                }\n                                ]\n                            } \n                        ]\n            }\n            ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56afd9393c70b01700facf25","ref":"","in":"query","required":false,"desc":"Desde cual pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.","default":"0","type":"int","name":"start"},{"_id":"56b0b7da36d2580d002477d7","ref":"","in":"query","required":false,"desc":"Cantidad de pagos  a partir del inicio que se desea retornar.  Por defecto retorna 30 pagos. Si este valor es mayor que 30, la aplicación retorna error.","default":"30","type":"int","name":"limit"},{"_id":"56b0b7da36d2580d002477d6","ref":"","in":"query","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar los pagos.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","default":"ASC","type":"string","name":"order_direction"},{"_id":"56b0b7da36d2580d002477d5","ref":"","in":"query","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son id, number, date, type.","default":"id","type":"string","name":"order_field"},{"_id":"56b0b7da36d2580d002477d4","ref":"","in":"query","required":false,"desc":"Filtrar los pagos por ingresos o egresos, para ingresos se envía type como 'in', para egresos 'out'.","default":"","type":"string","name":"type"},{"_id":"56faea6ca790640e00c7ed3c","ref":"","in":"query","required":false,"desc":"Incluir en los resultados metadatos.  Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo \"metadata\" y otro \"data\" en donde se envían los pagos.  Actualmente la información que se envía en metadata incluye el total de pagos que tiene registrada la empresa.  Si se envía el parámetro type retorna el total de pagos del tipo enviado.","default":"","type":"boolean","name":"metadata"}],"url":"/payments/"},"isReference":true,"order":2,"body":"Endpoint que retorna los pagos registrados en la cuenta de Alegra. Si no se envía límite de pagos por defecto se envían 30.  \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\\n```\\n{\\n  \\\"code\\\": 903,\\n  \\\"message\\\" : \\\"El límite debe ser menor o igual a 30\\\"\\n}\\n```\"\n}\n[/block]","excerpt":"Endpoint que permite consultar los pagos registrados en la aplicación","slug":"lista-de-pagos","type":"endpoint","title":"Lista de pagos"}

getLista de pagos

Endpoint que permite consultar los pagos registrados en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.
limit:
integer30
Cantidad de pagos a partir del inicio que se desea retornar. Por defecto retorna 30 pagos. Si este valor es mayor que 30, la aplicación retorna error.
order_direction:
stringASC
Orden ascendente o descendente en el cual se quieren retornar los pagos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
order_field:
stringid
Campo por el cual se desea ordenar, las opciones posibles son id, number, date, type.
type:
string
Filtrar los pagos por ingresos o egresos, para ingresos se envía type como 'in', para egresos 'out'.
metadata:
boolean
Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los pagos. Actualmente la información que se envía en metadata incluye el total de pagos que tiene registrada la empresa. Si se envía el parámetro type retorna el total de pagos del tipo enviado.

Examples


Result Format


Documentation

Endpoint que retorna los pagos registrados en la cuenta de Alegra. Si no se envía límite de pagos por defecto se envían 30. [block:callout] { "type": "warning", "title": "Atención", "body": "Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\n```\n{\n \"code\": 903,\n \"message\" : \"El límite debe ser menor o igual a 30\"\n}\n```" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}