{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/invoices/:id","auth":"required","params":[{"name":"id","type":"int","default":"","desc":"Id de la factura que se desea consultar.","required":true,"in":"path","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"pdf,xml","type":"string","default":"","desc":"Para obtener la url del archivo pdf de la factura de venta se debe enviar el valor `pdf` y para obtener la url del xml de la factura de venta timbrada se debe enviar el parámetro `xml`. Ejemplo: `/invoices?fields=pdf,xml`","required":false,"in":"query","ref":"","_id":"5f05ea28f60f9e02b18855c7"},{"name":"comments","type":"string","default":"","desc":"Para obtener los comentarios de la factura de venta se debe enviar el parámetro `fields` con el valor `comments`.","required":false,"in":"query","ref":"","_id":"5f4fb4cdfc08760033838681"}],"results":{"codes":[{"language":"json","code":"{\n \"id\": 1,\n \"date\": \"2016-02-27\",\n \"dueDate\": \"2016-03-27\",\n \"datetime\": \"2019-10-16 13:46:50\",\n \"observations\": \"\",\n \"anotation\": \"Favor consignar a la cuenta XXXXXX\",\n \"termsConditions\": \"Garantía de 1 año\",\n \"status\": \"open\",\n \"client\": {\n \"id\": 1,\n \"name\": \"Coorporación Alegrate\",\n \"identification\": \"159.549.847\",\n \"email\": \"prueba:::at:::alegra.com\",\n \"phonePrimary\": \"999-99-99\",\n \"phoneSecondary\": \"\",\n \"fax\": \"\",\n \"mobile\": \"(333) 555-55-55\",\n \"address\": {\n \"address\": \"Calle principal #45\",\n \"city\": \"Barcelona\"\n }\n },\n \"numberTemplate\": {\n \"id\": 1,\n \"prefix\": \"A-\",\n \"number\": 520,\n \"text\": \"Resolución de la DIAN # 45112\"\n },\n \"retentions\": [\n {\n \"id\": 1,\n \"name\": \"Compras\",\n \"percentage\": 3.5,\n \"amount\": 21.315\n }\n ],\n \"seller\": {\n \"id\": \"12\",\n \"name\": \"Diana Giraldo\",\n \"identification\": \"520.526.21\",\n \"observations\": \"Líder de Ventas\"\n },\n \"priceList\": {\n \"id\": 5,\n \"name\": \"Distribuidor\"\n },\n \"currency\": {\n \"code\": \"USD\",\n \"symbol\": \"$\",\n \"exchangeRate\": 2950\n },\n \"total\": 609,\n \"totalPaid\": 0,\n \"balance\": 609,\n \"decimalPrecision\" : 2,\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Billetera\",\n \"description\": \"Billetera de cuero negro\",\n \"reference\": \"REF-005\",\n \"discount\": 0,\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 \"remission\": 10\n },\n {\n \"id\": 2,\n \"name\": \"Cartera\",\n \"description\": \"Cartera de cuero color café\",\n \"reference\": \"CAR-195\",\n \"price\": 125,\n \"discount\": 0,\n \"tax\": [\n {\n \"id\": 6,\n \"name\": \"IVA\",\n \"percentage\": 16,\n \"description\": \"Impuesto de valor agregado\",\n \"status\" : \"active\"\n }\n ],\n \"quantity\": 1\n }\n ],\n \"payments\": [],\n \"costCenter\": {\n \"code\": \"1234\",\n \"name\": \"Centro 1\",\n \"description\": \"\",\n \"status\": \"active\",\n \"id\": \"1\"\n }\n}","status":200,"name":"Ejemplo consulta exitosa"},{"code":"{ \n\t\"error\": \"No se encontró en la aplicación la factura 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://api.alegra.com/api/v1/invoices/128 -u '[email protected]:mitoken'","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Consultar una factura de venta","type":"endpoint","slug":"consultar-una-factura-de-venta","excerpt":"Endpoint que permite consultar una factura de venta registrada en la aplicación","body":"Endpoint que retorna la factura de venta registrada 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":"56b2081d1bc8490d00701f0c","__v":12,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Facturas de venta","slug":"facturas-de-venta","order":3,"from_sync":false,"reference":true,"_id":"56b4b32deed075230097d689","__v":0,"project":"56abd2434e4b730d009eb10a","createdAt":"2016-02-05T14:35:25.879Z","version":"56abd2434e4b730d009eb10d"},"githubsync":"","user":"56abd213d4432d1900eed227","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","5fc1133c51c8370081b28e2a"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":44,"createdAt":"2016-01-29T20:57:39.712Z"},"editedParams":true,"parentDoc":null,"createdAt":"2016-02-03T14:01:01.276Z","project":"56abd2434e4b730d009eb10a","editedParams2":true}
getConsultar una factura de venta
Endpoint que permite consultar una factura de venta registrada en la aplicación
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
id:
required
integer
Id de la factura que se desea consultar.
Query Params
pdf:
string
Para obtener la url del archivo pdf de la factura de venta se debe enviar el valor `pdf` y para obtener la url del xml de la factura de venta timbrada se debe enviar el parámetro `xml`. Ejemplo: `/invoices?fields=pdf,xml`
comments:
string
Para obtener los comentarios de la factura de venta se debe enviar el parámetro `fields` con el valor `comments`.