cd52d3f68f1b
Consultar pagos
Endpoint que permite consultar los pagos registrados en la aplicación
Query parameters
Desde cuál pago se quiere consultar. Por ejemplo para consultar desde el pago 20, se envía start=20.
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.
Orden ascendente o descendente en el cual se quieren retornar los pagos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
Campo por el cual se desea ordenar.
Filtrar los pagos por ingresos o egresos, para ingresos se envía type como 'in', para egresos 'out'.
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.
Filtra los ingresos y/o egresos por id del cliente.
Id de la conciliación. Permite recuperar los pagos asociados a una conciliación.
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.
Incluye transacciones no conciliadas, debe ir junto con conciliation_id, de lo contrario se ignora este parámetro.
Indica si se deben incluir campos adicionales a la consulta, estos campos van separados por una coma (,). Usos - ?fields=conciliation
Response
Se obtiene una lista que contiene los pagos