Skip to main content
GET
Schedules a proposed limit would make unviable

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

account_id
string

Payer account.

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

proposed_limit
string

The limit being considered. This route reports what it would break; it does NOT apply the reduction.

Ejemplo:

"1000.00"

start_date
string<date>

Earliest settlement date to consider, inclusive.

end_date
string<date>

Latest settlement date to consider, inclusive.

limit
integer<int64>

Page size, 1..100. Absent means 20. A value outside that range is REFUSED, never clamped -- the same rule the sibling list route follows.

cursor
string

Opaque cursor from a previous page.

Respuesta

OK

items
object[] | null
requerido

The affected schedules, soonest first. Empty when nothing is affected -- never null.

proposedLimit
string
requerido

Echoed back, so the page is self-describing when it is saved or forwarded.

nextCursor
string