Skip to main content
GET
The read a charge run makes each morning. One entry per Client with something fallen due and unpaid on the date you name — the instalment falling due that day, a Period still inside its tolerance, and a late Period alike — and nobody else. Its cost follows what falls due, not how many borrowers you hold. Each entry carries, per Loan owing on the date, the payment options’ own overdue, late and instalment for that Loan, field for field, and per currency the Client’s totals. A Loan that owes nothing on the date is not in its entry. A Loan whose figures the Platform cannot produce is left out; the Client’s own options or book names why.
Collect what instalment.settled_by names. On an instalment’s own due date it is overdue, which already holds the instalment. Adding instalment.owed to it collects the instalment twice.
This read records nothing and serves no payoff. A run that needs a payoff reads the one Client’s options or book. A walk lists each Client once. Clients come in ascending order of identifier. A Client owing for the whole walk is listed exactly once. A Client whose debt a receipt settles before the walk reaches it is not listed — which is what you want from a charge run. A page may be short and still carry a cursor. One request examines at most twice limit Clients, since each costs a whole Client’s derivation. Where that bound stops the walk before the page fills, the page is answered short — possibly empty — with a cursor at the position reached. Read the end of the walk from the absence of a cursor, never from the length of a page.

​
Path parameters

​
string
required
The Tenancy asking.

​
Query parameters

​
string
required
The civil date the figures stand for. Required and never defaulted; absent is 422 outside_loan.
​
string
late keeps the Clients carrying a late figure on some Loan. A Client whose only owing Period falls due on the date, or sits inside its tolerance, is left out. Anything else is 400 invalid_query.
​
integer
Keeps the Clients whose worst days past due reach this number. Above zero it implies only=late. Not a whole number from zero is 400 invalid_query.
​
integer
default:"50"
Clients per page, 1 to 200.
​
string
The previous page’s cursor, verbatim.

​
Response

​
string
required
The date asked about.
​
array
required
The Clients with something fallen due, in ascending order of identifier.
​
string
Present where the walk goes on.