{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/estimates/","auth":"required","method":"get","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual cotización se quiere consultar. Por ejemplo para consultar desde la cotización 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de cotizaciones a partir del inicio que se desea retornar.  Por defecto retorna 30 cotizaciones. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d7"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar las cotizaciones.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d6"},{"name":"order_field","type":"string","default":"date","desc":"Campo por el cual se desea ordenar, las opciones posibles son id, name, date, dueDate.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d5"},{"name":"metadata","type":"boolean","default":"","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 cotizaciones.  Actualmente la información que se envía en metadata incluye el total de cotizaciones que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"5739f140b94be63400a28ea0"},{"name":"item_id","type":"int","default":"","desc":"Filtrar las cotizaciones por el id del item.","required":false,"in":"query","ref":"","_id":"5eeba133132a88019d1cd8bf"},{"name":"client_id","type":"int","default":"","desc":"Filtra las cotizaciones por id del cliente.","required":false,"in":"query","ref":"","_id":"5f0cf5723280580018737086"},{"name":"number","type":"string","default":"","desc":"Numeración de la cotización por la cual se desea filtrar, se puede especificar el prefijo y el numero.","required":false,"in":"query","ref":"","_id":"5f6cab6b12ff6a021d63846a"},{"name":"client_name","type":"string","default":"","desc":"Nombre del cliente el cual se desea filtrar las cotizaciones.","required":false,"in":"query","ref":"","_id":"5f6cab6b12ff6a021d638469"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la cotización la cual se desea filtrar.","required":false,"in":"query","ref":"","_id":"5f6cab6b12ff6a021d638468"}],"results":{"codes":[{"language":"json","code":"[\n  {\n    \"id\": \"8\",\n    \"number\" : \"8\",\n    \"date\": \"2016-05-16\",\n    \"dueDate\": \"2016-06-15\",\n    \"observations\": \"\",\n    \"anotation\": \"\",\n    \"seller\": null,\n    \"priceList\" : null,\n    \"client\": {\n      \"id\": \"1\",\n      \"name\": \"Mi contacto\",\n      \"identification\": \"12345678\",\n      \"phonePrimary\": \"384596546\",\n      \"phoneSecondary\": \"96875146\",\n      \"fax\": \"\",\n      \"mobile\": \"\",\n      \"email\": \"\",\n      \"address\": {\n        \"address\": \"\",\n        \"city\": \"\"\n      }\n    },\n    \"total\": 1720400,\n    \"items\": [\n      {\n        \"id\": 2,\n        \"name\": \"Consultoría\",\n        \"description\": \"Consultoría mes de Mayo\",\n        \"price\": 500000,\n        \"discount\": \"0.00\",\n        \"reference\": \"\",\n        \"quantity\": \"3.00\",\n        \"tax\" : [],\n        \"total\": 1500000\n      },\n      {\n        \"id\": 1,\n        \"name\": \"Servicio\",\n        \"description\": null,\n        \"price\": 95000,\n        \"discount\": \"0.00\",\n        \"reference\": \"852\",\n        \"quantity\": \"2.00\",\n        \"tax\": [\n          {\n          \"id\": \"3\",\n          \"name\": \"IVA\",\n          \"percentage\": \"16.00\",\n          \"description\": \"\",\n          \"type\": \"IVA\",\n          \"status\" : \"active\"\n            }\n          ],\n        \"total\": 220400\n      }\n    ]\n  },\n  {\n    \"id\": \"9\",\n    \"number\" : \"15\",\n    \"date\": \"2016-05-16\",\n    \"dueDate\": \"2016-06-15\",\n    \"observations\": \"Observaciones\",\n    \"anotation\": \"Notas de mi cotización\",\n    \"client\": {\n       \"id\": 2,\n        \"name\": \"Acrecer\",\n        \"identification\": \"963.654.988\",\n        \"email\": \"prueba2:::at:::alegra.com\",\n        \"phonePrimary\": \"111 11 11\",\n        \"phoneSecondary\": \"\",\n        \"fax\": \"\",\n        \"mobile\": \"(333) 555-55-55\",\n        \"observations\": \"\",\n        \"address\": {\n            \"address\": \"Avenida Madison\",\n            \"city\": \"New York, USA\"\n      }\n    },\n    \"total\": 610200,\n    \"seller\": {\n      \"id\": \"6\",\n      \"name\": \"Alejandro\",\n      \"identification\": \"1958-985\",\n      \"observations\": \"Vendedor del almacén del sur\"\n    },\n    \"priceList\" : null,\n    \"currency\": {\n      \"code\" : \"USD\",\n      \"symbol\" : \"$\",\n      \"exchangeRate\" : 2950\n    },\n    \"items\": [\n      {\n        \"id\": 2,\n        \"name\": \"Servicio\",\n        \"description\": \"\",\n        \"price\": 500000,\n        \"discount\": \"0.00\",\n        \"reference\": \"\",\n        \"quantity\": \"1.00\",\n        \"tax\" : [],\n        \"total\": 500000\n      },\n      {\n        \"id\": 1,\n        \"name\": \"Termo negro\",\n        \"description\": \"Termo para agua \",\n        \"price\": 95000,\n        \"discount\": \"0.00\",\n        \"reference\": \"852\",\n        \"quantity\": \"1.00\",\n        \"tax\": [\n          {\n          \"id\": \"3\",\n          \"name\": \"IVA\",\n          \"percentage\": \"16.00\",\n          \"description\": \"\",\n          \"type\": \"IVA\",\n\t\t\t\t  \"status\" : \"active\"\n            }\n          ],\n        \"total\": 110200\n      }\n    ]\n  },\n  {\n    \"id\": \"10\",\n    \"number\" : \"10\",\n    \"date\": \"2016-05-16\",\n    \"dueDate\": \"2016-06-15\",\n    \"observations\": \"\",\n    \"anotation\": \"\",\n    \"client\": {\n      \"id\": \"1\",\n      \"name\": \"Mi contacto\",\n      \"identification\": \"12345678\",\n      \"phonePrimary\": \"384596546\",\n      \"phoneSecondary\": \"96875146\",\n      \"fax\": \"345454\",\n      \"mobile\": \"12345678\",\n      \"email\": \"[email protected]\",\n      \"address\": {\n        \"address\": \"Mi casa\",\n        \"city\": \"Mi ciudad\"\n      }\n    },\n    \"total\": 610200,\n    \"seller\" : null,\n    \"priceList\" : null,\n    \"items\": [\n      {\n        \"id\": 2,\n        \"name\": \"Servicio\",\n        \"description\": \"\",\n        \"price\": 500000,\n        \"discount\": \"0.00\",\n        \"reference\": \"\",\n        \"quantity\": \"1.00\",\n        \"tax\": [],\n        \"total\": 500000\n      },\n      {\n        \"id\": 1,\n        \"name\": \"Termo negro\",\n        \"description\": \"Termo para agua \",\n        \"price\": 95000,\n        \"discount\": \"0.00\",\n        \"reference\": \"852\",\n        \"quantity\": \"1.00\",\n        \"tax\": [\n          {\n          \"id\": \"3\",\n          \"name\": \"IVA\",\n          \"percentage\": \"16.00\",\n          \"description\": \"\",\n          \"type\": \"IVA\",\n\t\t\t\t  \"status\" : \"active\"\n            }\n          ],\n        \"total\": 110200\n      }\n    ]\n  }\n ]","status":200,"name":"Ejemplo consulta exitosa"},{"code":"{ \n\t\"error\": \"El límite de cotizaciones para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}","language":"json","status":400,"name":"Bad Request - Límite sobrepasa máximo permitido"},{"status":200,"language":"json","code":"{\n  \"metadata\" : {\n    \"total\" : 15\n  },\n  \"data\" : [\n    [\n      {\n        \"id\": \"8\",\n        \"date\": \"2016-05-16\",\n        \"dueDate\": \"2016-06-15\",\n        \"observations\": \"\",\n        \"anotation\": \"\",\n        \"client\": {\n          \"id\": \"1\",\n          \"name\": \"Mi contacto\",\n          \"identification\": \"12345678\",\n          \"phonePrimary\": \"384596546\",\n     \t\t  \"phoneSecondary\": \"96875146\",\n\t\t      \"fax\": \"\",\n    \t\t  \"mobile\": \"\",\n\t\t      \"email\": \"\",\n\t\t      \"address\": {\n            \"address\": \"\",\n            \"city\": \"\"\n          }\n        },\n        \"total\": 1720400,\n        \"seller\": null,\n        \"priceList\" : null,\n        \"items\": [\n          {\n            \"id\": 2,\n            \"name\": \"Consultoría\",\n            \"description\": \"Consultoría mes de Mayo\",\n            \"price\": 500000,\n            \"discount\": \"0.00\",\n            \"reference\": \"\",\n            \"quantity\": \"3.00\",\n            \"total\": 1500000,\n            \"tax\" : []\n            },\n          {\n            \"id\": 1,\n            \"name\": \"Servicio\",\n            \"description\": null,\n            \"price\": 95000,\n            \"discount\": \"0.00\",\n            \"reference\": \"852\",\n            \"quantity\": \"2.00\",\n            \"tax\": [\n              {\n                \"id\": \"3\",\n                \"name\": \"IVA\",\n                \"percentage\": \"16.00\",\n                \"description\": \"\",\n                \"type\": \"IVA\",\n                \"status\" : \"active\"\n                }\n              ],\n            \"total\": 220400\n            }\n          ]\n      },\n      {\n        \"id\": \"9\",\n        \"date\": \"2016-05-16\",\n        \"dueDate\": \"2016-06-15\",\n        \"observations\": \"Observaciones\",\n        \"anotation\": \"Notas de mi cotización\",\n        \"client\": {\n          \"id\": 2,\n          \"name\": \"Acrecer\",\n          \"identification\": \"963.654.988\",\n          \"email\": \"[email protected]\",\n          \"phonePrimary\": \"111 11 11\",\n          \"phoneSecondary\": \"\",\n          \"fax\": \"\",\n          \"mobile\": \"(333) 555-55-55\",\n          \"observations\": \"\",\n          \"address\": {\n            \"address\": \"Avenida Madison\",\n            \"city\": \"New York, USA\"\n            }\n          },\n        \"total\": 610200,\n        \"seller\": {\n          \"id\": \"6\",\n          \"name\": \"Alejandro\",\n          \"identification\": \"1958-985\",\n          \"observations\": \"Vendedor del almacén del sur\"\n          },\n        \"priceList\" : null,\n        \"items\": [\n          {\n            \"id\": 2,\n            \"name\": \"Servicio\",\n            \"description\": \"\",\n            \"price\": 500000,\n            \"discount\": \"0.00\",\n            \"reference\": \"\",\n            \"quantity\": \"1.00\",\n            \"tax\" : [],\n            \"total\": 500000\n            },\n          {\n            \"id\": 1,\n            \"name\": \"Termo negro\",\n            \"description\": \"Termo para agua \",\n            \"price\": 95000,\n            \"discount\": \"0.00\",\n            \"reference\": \"852\",\n            \"quantity\": \"1.00\",\n            \"tax\": [\n              {\n                \"id\": \"3\",\n                \"name\": \"IVA\",\n                \"percentage\": \"16.00\",\n                \"description\": \"\",\n                \"type\": \"IVA\",\n                \"status\" : \"active\"\n                }\n              ],\n            \"total\": 110200\n            }\n          ]\n        },\n      {\n        \n        \"id\": \"10\",\n        \"date\": \"2016-05-16\",\n        \"dueDate\": \"2016-06-15\",\n        \"observations\": \"\",\n        \"anotation\": \"\",\n        \"client\": {\n          \"id\": \"1\",\n          \"name\": \"Mi contacto\",\n          \"identification\": \"12345678\",\n          \"phonePrimary\": \"384596546\",\n          \"phoneSecondary\": \"96875146\",\n          \"fax\": \"345454\",\n          \"mobile\": \"12345678\",\n          \"email\": \"[email protected]\",\n          \"address\": {\n            \"address\": \"Mi casa\",\n            \"city\": \"Mi ciudad\"\n            }\n          },\n        \"total\": 610200,\n        \"seller\": null,\n        \"priceList\" : null,\n        \"items\": [\n          {\n            \"id\": 2,\n            \"name\": \"Servicio\",\n            \"description\": \"\",\n            \"price\": 500000,\n            \"discount\": \"0.00\",\n            \"reference\": \"\",\n            \"quantity\": \"1.00\",\n            \"tax\" : [],\n            \"total\": 500000\n            },\n          {\n            \"id\": 1,\n            \"name\": \"Termo negro\",\n            \"description\": \"Termo para agua \",\n            \"price\": 95000,\n            \"discount\": \"0.00\",\n            \"reference\": \"852\",\n            \"quantity\": \"1.00\",\n            \"tax\": [\n              {\n                \"id\": \"3\",\n                \"name\": \"IVA\",\n                \"percentage\": \"16.00\",\n                \"description\": \"\",\n                \"type\": \"IVA\",\n                \"status\" : \"active\"\n                }\n              ],\n            \"total\": 110200\n            }\n          ]\n        }\n      ]\n    ]\n}","name":"Consulta exitosa con metadatos"}]},"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/estimates/ -u '[email protected]:mitoken'"}]}},"next":{"description":"","pages":[]},"title":"Lista de cotizaciones","type":"endpoint","slug":"lista-de-cotizaciones","excerpt":"Endpoint que permite consultar las cotizaciones registradas en la aplicación","body":"Endpoint que retorna las cotizaciones registradas en la cuenta de Alegra. Si no se envía límite de cotizaciones, por defecto se envían 30 cotizaciones.  \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]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5739f06f6c5ba134007a19a7","githubsync":"","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cotizaciones","slug":"cotizaciones","order":4,"from_sync":false,"reference":true,"_id":"5739ed9aad40e23200f674b6","createdAt":"2016-05-16T15:56:10.484Z","__v":0,"version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a"},"parentDoc":null,"project":"56abd2434e4b730d009eb10a","__v":9,"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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"createdAt":"2016-05-16T16:08:15.182Z","editedParams2":true,"editedParams":true}

getLista de cotizaciones

Endpoint que permite consultar las cotizaciones registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual cotización se quiere consultar. Por ejemplo para consultar desde la cotización 20, se envía start=20.
limit:
integer30
Cantidad de cotizaciones a partir del inicio que se desea retornar. Por defecto retorna 30 cotizaciones. 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 cotizaciones. 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 id, name, date, dueDate.
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 cotizaciones. Actualmente la información que se envía en metadata incluye el total de cotizaciones que tiene registrada la empresa.
item_id:
integer
Filtrar las cotizaciones por el id del item.
client_id:
integer
Filtra las cotizaciones por id del cliente.
number:
string
Numeración de la cotización por la cual se desea filtrar, se puede especificar el prefijo y el numero.
client_name:
string
Nombre del cliente el cual se desea filtrar las cotizaciones.
date:
yyyy-mm-dd
Fecha de la cotización la cual se desea filtrar.

Examples


Result Format


Documentation

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