Consultar pagos

get

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

Endpoint que permite consultar los pagos registrados en la aplicación

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

start

integer

≥ 0

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

limit

integer

≤ 30

Defaults to 30

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

enum

Defaults to ASC

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

Allowed:

order_field

string

enum

Campo por el cual se desea ordenar.

Allowed:

type

string

enum

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

Allowed:

metadata

boolean

Defaults to false

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.

client_id

integer

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

conciliation_id

integer

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

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.

includeUnconciliated

boolean

Defaults to false

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

fields

string

enum

Indica si se deben incluir campos adicionales a la consulta, estos campos van separados por una coma (,). Usos - ?fields=conciliation

Response

200Se obtiene una lista que contiene los pagos