/v1/payment-schedulesThe repayment schedules being collected
The schedules this workspace is collecting on — what was funded, the total payback, the instalment amount and cadence, how much has been collected, what is still outstanding and whether the schedule is behind — next payment date first. Narrow with ?facilityId=, ?dealRowId= (a deal record on our own board), ?status= (active, paused, completed, defaulted, settled, cancelled), ?delinquent=true|false and ?limit= (50 by default, 200 max); the CRM's separate active and delinquent lists are this one filtered. For the rows as a PAGE — the whole Payment schedules board with its columns, saved views and facet filters, or one deal's rows through ?dealRowId= — read get_definitions_key_rows with key payment-schedules; this route is the servicing operation itself.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": [
"string"
]
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}