{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/credit-notes","auth":"required","settings":"","results":{"codes":[{"name":"Ejemplo consulta exitosa","code":"[\n{\n    \"id\": \"1\",\n    \"date\": \"2020-02-17\",\n    \"observations\": \"Observaciones de la nota de crédito\",\n    \"anotation\": \"Notas de la nota de crédito\",\n    \"termsConditions\": null,\n    \"status\": \"open\",\n    \"client\": {\n        \"id\": \"21\",\n        \"name\": \"Usuario Alegra\",\n        \"identification\": \"40012947\",\n        \"phonePrimary\": \"7435678\",\n        \"phoneSecondary\": null,\n        \"fax\": null,\n        \"mobile\": \"3143143434\",\n        \"email\": \"usuario:::at:::alegra.com\",\n        \"address\": {\n            \"street\": \"Calle principal #45\",\n            \"exteriorNumber\": null,\n            \"interiorNumber\": null,\n            \"colony\": \"Barcelona\",\n            \"locality\": \"Piedra\",\n            \"municipality\": null,\n            \"zipCode\": \"150001\",\n            \"state\": \"Cataluña\",\n            \"country\": \"España\"\n        }\n    },\n    \"warehouse\": {\n        \"id\": \"1\",\n        \"name\": \"Principal\",\n        \"observations\": \"Bodega principal de la compañia\",\n        \"isDefault\": true,\n        \"address\": null,\n        \"status\": \"active\"\n    },\n    \"total\": 1000,\n    \"balance\": 0,\n    \"totalApplied\": 1000,\n    \"decimalPrecision\": 0,\n    \"items\": [\n        {\n            \"id\": 2,\n            \"name\": \"item 2\",\n            \"reference\": \"\",\n            \"description\": \"\",\n            \"price\": 1000,\n            \"discount\": \"0.00\",\n            \"quantity\": \"1.00\",\n            \"tax\": [],\n            \"total\": 1000\n        }\n    ],\n    \"numberTemplate\": {\n        \"number\": \"1\",\n        \"documentType\": \"creditNote\"\n    },\n    \"invoices\": [\n        {\n            \"id\": \"69\",\n            \"prefix\": \"Q\",\n            \"number\": \"69\",\n            \"date\": \"2020-02-27\",\n            \"dueDate\": \"2020-02-27\",\n            \"amount\": 100,\n            \"total\": 12122,\n            \"balance\": 11922\n        }\n    ],\n    \"refunds\": [\n        {\n            \"id\": \"3\",\n            \"number\": \"1\",\n            \"date\": \"2020-03-17\",\n            \"account\": {\n                \"id\": \"2\",\n                \"name\": \"Banco 1\"\n            },\n            \"amount\": 400,\n            \"observations\": \"Observaciones del reembolso\"\n        },\n        {\n            \"id\": \"4\",\n            \"number\": \"2\",\n            \"date\": \"2020-03-15\",\n            \"account\": {\n                \"id\": \"3\",\n                \"name\": \"Tarjeta de crédito empresarial\"\n            },\n            \"amount\": 500,\n            \"observations\": \"Observaciones del segundo reembolso\"\n        } \n    ],\n    \"type\": \"03\"\n},\n  {\n    \"id\": \"2\",\n    \"date\": \"2020-02-17\",\n    \"observations\": \"Observaciones de la nota de crédito\",\n    \"anotation\": \"Notas de la nota de crédito\",\n    \"termsConditions\": null,\n    \"status\": \"open\",\n    \"client\": {\n        \"id\": \"21\",\n        \"name\": \"Usuario Alegra\",\n        \"identification\": \"40012947\",\n        \"phonePrimary\": \"7435678\",\n        \"phoneSecondary\": null,\n        \"fax\": null,\n        \"mobile\": \"3143143434\",\n        \"email\": \"[email protected]\",\n        \"address\": {\n            \"street\": \"Calle principal #45\",\n            \"exteriorNumber\": null,\n            \"interiorNumber\": null,\n            \"colony\": \"Barcelona\",\n            \"locality\": \"Piedra\",\n            \"municipality\": null,\n            \"zipCode\": \"150001\",\n            \"state\": \"Cataluña\",\n            \"country\": \"España\"\n        }\n    },\n    \"warehouse\": {\n        \"id\": \"1\",\n        \"name\": \"Principal\",\n        \"observations\": \"Bodega principal de la compañia\",\n        \"isDefault\": true,\n        \"address\": null,\n        \"status\": \"active\"\n    },\n    \"total\": 1000,\n    \"balance\": 0,\n    \"totalApplied\": 1000,\n    \"decimalPrecision\": 0,\n    \"items\": [\n        {\n            \"id\": 2,\n            \"name\": \"item 2\",\n            \"reference\": \"\",\n            \"description\": \"\",\n            \"price\": 1000,\n            \"discount\": \"0.00\",\n            \"quantity\": \"1.00\",\n            \"tax\": [],\n            \"total\": 1000\n        }\n    ],\n    \"numberTemplate\": {\n        \"number\": \"1\",\n        \"documentType\": \"creditNote\"\n    },\n    \"invoices\": [\n        {\n            \"id\": \"69\",\n            \"prefix\": \"Q\",\n            \"number\": \"69\",\n            \"date\": \"2020-02-27\",\n            \"dueDate\": \"2020-02-27\",\n            \"amount\": 100,\n            \"total\": 12122,\n            \"balance\": 11922\n        }\n    ],\n    \"refunds\": [\n        {\n            \"id\": \"3\",\n            \"number\": \"1\",\n            \"date\": \"2020-03-17\",\n            \"account\": {\n                \"id\": \"2\",\n                \"name\": \"Banco 1\"\n            },\n            \"amount\": 400,\n            \"observations\": \"Observaciones del reembolso\"\n        },\n        {\n            \"id\": \"4\",\n            \"number\": \"2\",\n            \"date\": \"2020-03-15\",\n            \"account\": {\n                \"id\": \"3\",\n                \"name\": \"Tarjeta de crédito empresarial\"\n            },\n            \"amount\": 500,\n            \"observations\": \"Observaciones del segundo reembolso\"\n        } \n    ],\n    \"type\": \"03\",\n    \"costCenter\": {\n        \"code\": \"1234\",\n        \"name\": \"Centro 1\",\n        \"description\": \"\",\n        \"status\": \"active\",\n        \"id\": \"1\"\n    }\n}\n]","language":"json","status":200}]},"params":[{"name":"start","type":"int","default":"0","desc":"Desde cual nota de crédito se quiere consultar. Por ejemplo para consultar desde la nota de crédito 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd62"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de notas de crédito a partir del inicio que se desea retornar.  Por defecto retorna 30 notas de crédito. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd61"},{"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 facturas.  Actualmente la información que se envía en metadata incluye el total de las notas de crédito que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd60"},{"name":"id","type":"string","default":"","desc":"Ids de las notas de crédito. Sirve para consultar notas específicas. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 facturas al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd5f"},{"name":"item_id","type":"int","default":"","desc":"Id del item por el cual se desea filtrar las notas de crédito.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd5e"},{"name":"client_id","type":"int","default":"","desc":"Id del cliente por el cual se desea filtrar las notas de crédito.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd5d"},{"name":"attachment","type":"boolean","default":"","desc":"Retorna un objeto attachment con los archivos adjuntos a la nota de crédito.","required":false,"in":"query","ref":"","_id":"5e8cafc1256522001ffbcd5c"},{"name":"number","type":"string","default":"","desc":"Numeración de la nota de crédito por la cual se desea filtrar, se puede especificar el prefijo y el numero.","required":false,"in":"query","ref":"","_id":"5f6caa84dd1987006690a1f1"},{"name":"client_name","type":"string","default":"","desc":"Nombre del cliente el cual se desea filtrar las notas de crédito.","required":false,"in":"query","ref":"","_id":"5f6caa84dd1987006690a1f0"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la nota de crédito la cual se desea filtrar.","required":false,"in":"query","ref":"","_id":"5f6caa84dd1987006690a1ef"},{"name":"emission_status","type":"string","default":"","desc":"Permite filtrar por estado de emisión de la nota crédito cuando es una nota crédito electrónica, los posibles valores se pueden consultar en el catálogo de parámetros de la versión: [Colombia](https://developer.alegra.com/docs/colombia), [México](https://developer.alegra.com/docs/m%C3%A9xico),  [Costa Rica](https://developer.alegra.com/docs/costa-rica), [Argentina](https://developer.alegra.com/docs/argentina), [Chile](https://developer.alegra.com/docs/chile),  [Perú](https://developer.alegra.com/docs/per%C3%BA), [Panamá](https://developer.alegra.com/docs/per%C3%BA).","required":false,"in":"query","ref":"","_id":"5fb7e95091bce10043df0a1c"}],"examples":{"codes":[{"code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  \"https://api.alegra.com/api/v1/credit-notes/\" -u '[email protected]:mitoken'","language":"json"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Lista de notas de crédito","type":"endpoint","slug":"lista-de-notas-de-crédito","excerpt":"Endpoint que permite consultar las notas de crédito registradas en la aplicación","body":"","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e8cafc1256522001ffbcd5b","createdAt":"2020-04-07T16:52:17.539Z","user":"56abd213d4432d1900eed227","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Notas Crédito","slug":"notas-crédito","order":22,"from_sync":false,"reference":false,"_id":"5e8ca028538a310018ccd2df","createdAt":"2020-04-07T15:45:44.192Z","version":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":0},"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"},"project":"56abd2434e4b730d009eb10a","__v":9,"parentDoc":null}

getLista de notas de crédito

Endpoint que permite consultar las notas de crédito registradas en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual nota de crédito se quiere consultar. Por ejemplo para consultar desde la nota de crédito 20, se envía start=20.
limit:
integer30
Cantidad de notas de crédito a partir del inicio que se desea retornar. Por defecto retorna 30 notas de crédito. Si este valor es mayor que 30, la aplicación retorna error.
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 las notas de crédito que tiene registrada la empresa.
id:
string
Ids de las notas de crédito. Sirve para consultar notas específicas. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 facturas al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.
item_id:
integer
Id del item por el cual se desea filtrar las notas de crédito.
client_id:
integer
Id del cliente por el cual se desea filtrar las notas de crédito.
attachment:
boolean
Retorna un objeto attachment con los archivos adjuntos a la nota de crédito.
number:
string
Numeración de la nota de crédito 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 notas de crédito.
date:
yyyy-mm-dd
Fecha de la nota de crédito la cual se desea filtrar.
emission_status:
string
Permite filtrar por estado de emisión de la nota crédito cuando es una nota crédito electrónica, los posibles valores se pueden consultar en el catálogo de parámetros de la versión: [Colombia](https://developer.alegra.com/docs/colombia), [México](https://developer.alegra.com/docs/m%C3%A9xico), [Costa Rica](https://developer.alegra.com/docs/costa-rica), [Argentina](https://developer.alegra.com/docs/argentina), [Chile](https://developer.alegra.com/docs/chile), [Perú](https://developer.alegra.com/docs/per%C3%BA), [Panamá](https://developer.alegra.com/docs/per%C3%BA).

Examples


Result Format


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