Skip to main content
GET
Listar dispersiones

Authorizations

api_access_token
string
header
required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id
integer
required

The numeric ID of the account

Query Parameters

role
enum<string>
Available options:
owner,
ph_admin,
vendor,
ally
status
enum<string>
Available options:
awaiting_approval,
awaiting_resolution,
approved,
sent,
confirmed,
rejected,
returned
channel
string
month
string

Mes de las dispersiones selladas, como YYYY-MM. Por defecto, el mes actual en la zona horaria de facturación de la cuenta.

from
string<date>

Inicio del periodo (incluido) para las dispersiones selladas; reemplaza el primer día del mes.

to
string<date>

Fin del periodo (incluido) para las dispersiones selladas; reemplaza el último día del mes.

q
string

Busca por ID de la dispersión, referencia externa, nombre del destinatario o razón social de la empresa.

payout_day
integer

Solo propietarios cuyo mandato les paga ese día del mes.

sort
enum<string>

Campo de orden. Sin él, primero van las dispersiones abiertas y luego por fecha programada e ID.

Available options:
amount,
status,
date
order
enum<string>
default:desc
Available options:
asc,
desc
page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100

Response

Dispersiones con conteos, totales por estado y paginación.

counts
object
required

Cantidad de dispersiones en total (all) y por rol: owner, ph_admin, vendor y ally.

summary
object
required
meta
object
required
payload
object[]
required