{"_id":"5c7e9f3c4ea30f0029fbcb27","project":"56abd2434e4b730d009eb10a","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":27,"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","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"5c7e9c7c412d4c003f750162","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-03-05T15:57:48.910Z","from_sync":false,"order":20,"slug":"facturas-de-proveedor","title":"Facturas de Proveedor"},"user":"5a2184feb778240012e38415","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-03-05T16:09:32.815Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://app.alegra.com/api/v1/bills/ -u 'usuario:::at:::alegra.co:mitoken'","language":"curl"}]},"results":{"codes":[{"name":"","code":"[\n    {\n        \"id\": \"1\",\n        \"date\": \"2019-02-21\",\n        \"dueDate\": \"2019-02-21\",\n        \"observations\": \"Observaciones de la factura de proveedor.\",\n        \"termsConditions\": \"Términos y condiciones de la factura de proveedor.\",\n        \"status\": \"closed\",\n        \"provider\": {\n            \"id\": \"1\",\n            \"name\": \"Coorporación Alegrate\",\n            \"identification\": \"159.549.847\",\n            \"phonePrimary\": \"999-99-99\",\n            \"phoneSecondary\": \"\",\n            \"fax\": \"\",\n            \"mobile\": \"(333) 555-55-55\",\n            \"email\": \"prueba@alegra.com\"\n        },\n        \"numberTemplate\": {\n            \"number\": \"FPAPI1\"\n        },\n        \"total\": 2100,\n        \"totalPaid\": 2100,\n        \"balance\": 0,\n        \"decimalPrecision\": \"2\",\n        \"warehouse\": {\n            \"id\": \"1\",\n            \"name\": \"Principal\"\n        },\n        \"payments\": [\n            {\n                \"id\": \"1\",\n                \"prefix\": null,\n                \"number\": \"1\",\n                \"date\": \"2019-02-21\",\n                \"amount\": 2100,\n                \"paymentMethod\": \"cash\",\n                \"observations\": \"Observaciones del pago\",\n                \"anotation\": \"Notas del pago\",\n                \"status\": \"open\"\n            }\n        ],\n        \"purchases\": {\n            \"categories\": [\n                {\n                    \"id\": \"1\",\n                    \"name\": \"Ajustes de inventario\",\n                    \"price\": 2100,\n                    \"discount\": \"0.00\",\n                    \"observations\": \"\",\n                    \"tax\": null,\n                    \"quantity\": \"1.00\",\n                  \t\"subtotal\": 2100,\n                    \"total\": 2100\n                }\n            ]\n        },\n        \"retentions\": []\n    }\n]","language":"json","status":200},{"name":"","code":"{ \n\t\"error\": \"El límite de facturas para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}","language":"json","status":400},{"name":"OK - Con metadatos","status":200,"language":"json","code":"{\n    \"metadata\": {\n        \"total\": 2\n    },\n    \"data\": [\n        {\n            \"id\": \"1\",\n            \"date\": \"2019-02-21\",\n            \"dueDate\": \"2019-02-21\",\n            \"observations\": \"Observaciones de la factura de proveedor.\",\n            \"termsConditions\": \"Términos y condiciones de la factura de proveedor.\",\n            \"status\": \"closed\",\n            \"provider\": {\n                \"id\": \"1\",\n                \"name\": \"Coorporación Alegrate\",\n                \"identification\": \"159.549.847\",\n                \"phonePrimary\": \"999-99-99\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"email\": \"prueba@alegra.com\"\n            },\n            \"numberTemplate\": {\n                \"number\": \"FPAPI1\"\n            },\n            \"total\": 2100,\n            \"totalPaid\": 2100,\n            \"balance\": 0,\n            \"decimalPrecision\": \"2\",\n            \"warehouse\": {\n                \"id\": \"1\",\n                \"name\": \"Principal\"\n            },\n            \"payments\": [\n                {\n                    \"id\": \"1\",\n                    \"prefix\": null,\n                    \"number\": \"1\",\n                    \"date\": \"2019-02-21\",\n                    \"amount\": 2100,\n                    \"paymentMethod\": \"cash\",\n                    \"observations\": \"Observaciones del pago\",\n                    \"anotation\": \"Notas del pago\",\n                    \"status\": \"open\"\n                }\n            ],\n            \"purchases\": {\n                \"categories\": [\n                    {\n                        \"id\": \"1\",\n                        \"name\": \"Ajustes de inventario\",\n                        \"price\": 2100,\n                        \"discount\": \"0.00\",\n                        \"observations\": \"\",\n                        \"tax\": null,\n                        \"quantity\": \"1.00\",\n                      \t\"subtotal\": 2100,\n                        \"total\": 2100\n                    }\n                ]\n            },\n            \"retentions\": []\n      \t}\n    ]\n}"}]},"settings":"","auth":"required","params":[{"_id":"5c7e9f3c4ea30f0029fbcb30","ref":"","in":"query","required":false,"desc":"Desde cuál factura de proveedor se quiere consultar. Por ejemplo para consultar desde la factura de proveedor 20, se envía start=20.","default":"0","type":"int","name":"start"},{"_id":"5c7e9f3c4ea30f0029fbcb2f","ref":"","in":"query","required":false,"desc":"Cantidad de facturas de proveedor a partir del inicio que se desea retornar.  Por defecto retorna 30 facturas de proveedor. Si este valor es mayor que 30, la aplicación retorna error.","default":"30","type":"int","name":"limit"},{"_id":"5c7e9f3c4ea30f0029fbcb2e","ref":"","in":"query","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar las facturas de proveedor. Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","default":"ASC","type":"string","name":"order_direction"},{"_id":"5c7e9f3c4ea30f0029fbcb2d","ref":"","in":"query","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son date, name, dueDate.","default":"date","type":"string","name":"order_field"},{"_id":"5c7e9f3c4ea30f0029fbcb2c","ref":"","in":"query","required":false,"desc":"Filtrar resultados según el número de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo número coincida total o parcialmente con el valor enviado en este parámetro.","default":"","type":"string","name":"billNumber"},{"_id":"5c7e9f3c4ea30f0029fbcb2b","ref":"","in":"query","required":false,"desc":"Filtrar resultados según el nombre del cliente de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo nombre de proveedor coincida total o parcialmente con el valor enviado en este parámetro.","default":"","type":"string","name":"client_name"},{"_id":"5c7e9f3c4ea30f0029fbcb2a","ref":"","in":"query","required":false,"desc":"Filtrar resultados según fecha de creación de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.","default":"","type":"yyyy-mm-dd","name":"date"},{"_id":"5c7e9f3c4ea30f0029fbcb29","ref":"","in":"query","required":false,"desc":"Filtrar resultados según fecha de vencimiento de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya fecha de vencimiento coincida exactamente con el valor enviado en este parámetro.","default":"","type":"yyyy-mm-dd","name":"dueDate"},{"_id":"5c7e9f3c4ea30f0029fbcb28","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 las facturas.  Actualmente la información que se envía en metadata incluye el total de facturas que tiene registrada la empresa.","default":"","type":"boolean","name":"metadata"}],"url":"/bills/"},"isReference":false,"order":1,"body":"Endpoint que retorna las facturas de proveedor registradas en la cuenta de Alegra. Si no se envía límite de facturas, por defecto se envían 30 facturas.\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 las facturas de proveedor registradas en la aplicación","slug":"lista-de-facturas-de-proveedor","type":"endpoint","title":"Lista de facturas de proveedor"}

getLista de facturas de proveedor

Endpoint que permite consultar las facturas de proveedor registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cuál factura de proveedor se quiere consultar. Por ejemplo para consultar desde la factura de proveedor 20, se envía start=20.
limit:
integer30
Cantidad de facturas de proveedor a partir del inicio que se desea retornar. Por defecto retorna 30 facturas de proveedor. 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 las facturas de proveedor. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
order_field:
stringdate
Campo por el cual se desea ordenar, las opciones posibles son date, name, dueDate.
billNumber:
string
Filtrar resultados según el número de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo número coincida total o parcialmente con el valor enviado en este parámetro.
client_name:
string
Filtrar resultados según el nombre del cliente de la factura de proveedor. Se retornarán todas las facturas de proveedor cuyo nombre de proveedor coincida total o parcialmente con el valor enviado en este parámetro.
date:
yyyy-mm-dd
Filtrar resultados según fecha de creación de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya fecha de creación (atributo date) coincida exactamente con el valor enviado en este parámetro.
dueDate:
yyyy-mm-dd
Filtrar resultados según fecha de vencimiento de la factura de proveedor. Se retornarán todas las facturas de proveedor cuya fecha de vencimiento coincida exactamente con el valor enviado en este parámetro.
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 las facturas. Actualmente la información que se envía en metadata incluye el total de facturas que tiene registrada la empresa.

Examples


Result Format


Documentation

Endpoint que retorna las facturas de proveedor registradas en la cuenta de Alegra. Si no se envía límite de facturas, por defecto se envían 30 facturas. [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 }}