{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/payments/:id","auth":"required","results":{"codes":[{"name":"Ejemplo consulta exitosa","status":200,"code":"{\n  \"id\" : \"1\",\n  \"date\": \"2015-12-10\",\n  \"number\":\"140\",\n  \"paymentMethod\": \"cash\",\n  \"observations\": \"Observaciones del pago\",\n  \"anotation\": \"Notas de mi pago\",\n  \"amount\" : \"100.00\",\n  \"status\":\"open\",\n  \"type\" : \"in\",\n  \"account\" : {\n    \"id\":\"1\",\n    \"name\":\"Bancolombia\",\n    \"type\":\"bank\"\n    },\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      \"amount\" :  \"100\",\n      \"balance\" : \"50\"\n      },\n    {\n      \"id\" : \"15\",\n      \"number\" : \"AL-25\",\n      \"date\" : \"2015-12-13\",\n      \"total\" : \"350\",\n      \"amount\" :  \"350\",\n      \"balance\": \"0\"\n      }\n    ],\n  \"currency\" : {\n    \"code\" : \"USD\",\n    \"symbol\" : \"$\",\n    \"exchangeRate\" : \"3200\"\n   },\n  \"appliedAdvances\": [\n        {\n            \"id\": \"234\",\n            \"number\": \"234\",\n            \"date\": \"2019-11-21\",\n            \"dueDate\": \"2019-11-21\",\n            \"total\": 1110,\n            \"totalPaid\": 40,\n            \"balance\": 1070,\n            \"amount\": 40\n        }\n    ]\n}","language":"json"},{"status":404,"language":"json","code":"{ \n\t\"error\": \"No se encontró en la aplicación el pago que se está buscando\" ,\n  \"code\" : 404\n}"},{"name":"Ejemplo consulta exitosa México","status":200,"language":"json","code":"{\n  \"id\" : \"1\",\n  \"date\": \"2017-12-10\",\n  \"number\":\"140\",\n  \"paymentMethod\": \"cash\",\n  \"observations\": \"Observaciones del pago\",\n  \"anotation\": \"Notas de mi pago\",\n  \"amount\" : \"100.00\",\n  \"status\":\"open\",\n  \"type\" : \"in\",\n  \"account\" : {\n    \"id\":\"1\",\n    \"name\":\"Bancolombia\",\n    \"type\":\"bank\"\n    },\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      \"amount\" :  \"100\",\n      \"balance\" : \"50\"\n      },\n    {\n      \"id\" : \"15\",\n      \"number\" : \"AL-25\",\n      \"date\" : \"2015-12-13\",\n      \"total\" : \"350\",\n      \"amount\" :  \"350\",\n      \"balance\": \"0\"\n      }\n    ],\n  \"currency\" : {\n    \"code\" : \"USD\",\n    \"symbol\" : \"$\",\n    \"exchangeRate\" : \"3200\"\n   },\n  \"stamp\": {\n    \"uuid\": \"099C27AD-A8F1-4ECE-A1AE-4AF35A43475D\",\n    \"stampDate\": \"2018-01-19T14:13:01\"\n  }\n}"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/payments/74 -u 'usuario:::at:::alegra.com:mitoken'"}]},"method":"get","params":[{"name":"id","type":"int","default":"","desc":"Id del pago que se desea consultar.","required":true,"in":"path","ref":"","_id":"56afd9393c70b01700facf25"}]},"next":{"description":"","pages":[]},"title":"Consultar un pago","type":"endpoint","slug":"consultar-un-pago","excerpt":"Endpoint que permite consultar un pago registrado en la aplicación","body":"Endpoint que retorna el pago registrado en la cuenta de Alegra que está identificado con el id que se envía como parámetro.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b2611f65ddf50d0076bab3","user":"56abd213d4432d1900eed227","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"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"],"title":"Pagos","slug":"api","order":9,"from_sync":false,"reference":true,"_id":"56abd4c8f25f160d00e17f81","createdAt":"2016-01-29T21:08:24.369Z","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":32},"createdAt":"2016-02-03T20:20:47.642Z","editedParams2":true,"githubsync":"","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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":39,"createdAt":"2016-01-29T20:57:39.712Z"},"__v":6,"editedParams":true,"project":"56abd2434e4b730d009eb10a"}

getConsultar un pago

Endpoint que permite consultar un pago registrado en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Id del pago que se desea consultar.

Examples


Result Format


Documentation

Endpoint que retorna el pago registrado en la cuenta de Alegra que está identificado con el id que se envía como parámetro.

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 }}