Lista de pagos

get

https://api.alegra.com/api/v1/payments

Endpoint que retorna los pagos registrados en la cuenta de Alegra. Si no se envía límite de pagos por defecto se envían 30.

Query Params

start

integer

Desde cual pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.

limit

integer

Cantidad de pagos a partir del inicio que se desea retornar. Por defecto retorna 30 pagos. Si este valor es mayor que 30, la aplicación retorna error.

order_direction

string

Orden ascendente o descendente en el cual se quieren retornar los pagos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).

order_field

string

Campo por el cual se desea ordenar, las opciones posibles son id, number, date, type.

type

string

Filtrar los pagos por ingresos o egresos, para ingresos se envía type como 'in', para egresos 'out'.

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 los pagos. Actualmente la información que se envía en metadata incluye el total de pagos que tiene registrada la empresa. Si se envía el parámetro type retorna el total de pagos del tipo enviado.

string

Ids de los pagos. Sirve para consultar pagos específicos. Deben ir separados por coma (,) y sin espacios. Máximo se puede consultar un total de 30 pagos al tiempo. Si se especifica este parámetro, todos los otros parámetros serán ignorados.

client_id

string

Filtra los ingresos y/o egresos por id del cliente.

conciliation_id

string

Id de la conciliación. Permite recuperar los pagos asociados a una conciliación

includeUnconciliated

boolean

Incluye transacciones no conciliadas, debe ir junto con conciliation_id, de lo contrario se ignora este parámetro

fields

string

Permite recuperar campos adicionales. Se pueden incluir varios y deben ir separados por comas. Opciones disponibles: conciliation, voucherNumber (COL)

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Retorna la lista de pagos

404Bad request - Límite sobrepasa máximo permitido