Skip to main content
GET
Every Loan the Client holds, on the date you name, in one answer. Each Loan carries its listing row — what was paid, the settled and remaining Periods, the penalty rate, whether it owes and to whom. A Loan open on the date also carries what the payment options and the delinquency read answer for it, field for field. Beside the Loans, the book states what the Client holds across them, per currency: what is late, the earliest instalment ahead, the Periods to come and the Periods paid by month, and how many Loans are open and closed. One read, one derivation. The whole answer comes from one pass over the Client’s Receipts up to the date — the same pass that settles a Receipt. No figure in it can differ from the per-Loan reads for the same date. It costs what one schedule read costs, and it replaces a listing plus an options read plus a schedule, delinquency and Loan read per credit.
The payoff is absent unless you ask for it, and nothing is ever recorded. The figure the book serves is the one a recorded payoff quote for the same Loan and date holds. When you relay it to a borrower as the figure to pay, record it there.
A validator on every read. A book read answers with an ETag, with the payoff or without it; send it back in If-None-Match and an unchanged book on the same date is answered 304 with no body, before anything is derived — as on the payment options.

​
Path parameters

​
string
required
The Tenancy asking.
​
string
required
The Client whose book this is.

​
Query parameters

​
string
required
The civil date every figure stands for. Required and never defaulted; absent is 422 — there is no today the Platform can supply.
​
string
default:"none"
Which Loans carry their schedule as the Receipts left it on the date.
​
string
payoff adds each open Loan’s payoff figure and what discharges every open Loan, and records nothing. Anything else is 400 invalid_query.

​
Response

​
string
required
The date every figure is true of.
​
array
required
Every Loan the Client holds, whatever its state.Every dated figure is absent on a Loan that is not open on the date: a closed or cancelled Loan, one whose anchor falls after the date, and a ceded Loan from its cut-off. A Loan the Platform cannot describe carries the reason in anomalies and takes no other Loan with it.
​
array
required
What the Client holds across Loans, one entry per currency. Nothing is summed across currencies.Late means what delinquency means: a Period past its tolerance end and not settled. An instalment falling due on the date is collectable, not late — it is in next_instalment, not in late.A figure across Loans is absent rather than short where a Loan that would count towards it could not be described. The counts stand.

​
One identifier, one book

A book is one registered Client identifier’s. The Platform never relates two identifiers, and no per-Client answer — this book, the options, the obligations, the credit bar — spans more than one. If you learn two identifiers are one person, relate them in your own records.