Lista de notas de crédito

get

https://api.alegra.com/api/v1/credit-notes

Endpoint que permite consultar las notas de crédito registradas en la cuenta de Alegra. Si no se envía límite de notas de crédito por defecto se envían 30.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

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

integer

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.

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

string

Id del item por el cual se desea filtrar las notas de crédito.

client_id

string

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

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, México, Costa Rica, Argentina, Chile, Perú, Panamá.

Response

200Retorna la lista de las notas de crédito