Clients
Read a client's obligations
What you owe the client back, as one balance, naming the receipts, returns and rollovers that produced it.
GET
An Obligation is money you owe the Client: an excess that reached no Loan, and
owed_back a recomputation in the borrower’s favour produced. The route answers one balance and what produced it — money owed back carries how each kind arises. Settling the balance is yours: the Platform records what is owed and moves no money.
A recomputation is not always a Receipt’s. A goods return reprices the plan exactly as a Receipt electing principal does, so a Client who advanced an instalment and then returned the goods is owed the interest that advance collected for days they no longer owe principal for. That part of the balance names the return, under returns, because no money arrived with the fact and there is no Receipt to name.
A return can also give principal back. Where the goods went back at more than the principal still outstanding — the whole price, after instalments were paid — the principal the Loan had received is owed to the Client, named by the same return. returned states the two apart for each return: the principal paid for goods that went back, and the interest the repricing stopped charging.
A rollover can leave the same kind of balance, and names itself under rollovers. It empties the periods it supersedes and moves what they charged onto its settlement and the continuation segment; what was already settled against a superseded period is credited onto those charges, and what no surviving charge succeeds is owed back — interest the settlement charges for fewer days than an advance had paid for, and a penalty or late fee for days that have already elapsed.
Path parameters
string
required
The Tenancy asking.
string
required
The Client the money is owed to.
Query parameters
integer
default:"50"
How many receipt references to serve, between 1 and 200. It bounds
receipts alone: the balance, returns and rollovers are whole on every page.string
Where to resume, returned verbatim from the previous page.
Response
string
required
The Client.
object
required
The whole standing balance. A Client owed nothing answers zero.
array
required
The references of the Receipts that produced it — the audit trail from the balance to each allocation.
array
The act references of the recorded returns that produced part of it, oldest first, each once. Absent where no return did.Served whole rather than paged, unlike
receipts: a Client’s returns are bounded by the Loans it holds and the acts recorded against them. Follow one to the Loan it was recorded against, and the Loan to its Receipts.array
What each of those returns owes back, in the order of
returns: act, loan_id, on, principal — principal the Loan had received that the return gives back — interest — what its repricing left settled above what the plan then charged, with the fee and tax that ride it — and amount, the two together. Absent where no return owes anything. Served whole.array
The act references of the recorded rollovers whose supersession produced part of it, oldest first. Absent where no rollover did.Served whole, for the same reason the returns are.
array
What the acts that undid this Client’s Loans owe back: one line per Receipt that reached an undone Loan before the act, oldest first —
kind (rescinded, voided, withdrawn), on, act, loan_id, receipt and amount. Absent where no act undid a Loan that took money. Served whole.array
The act references of the settlements for less whose Receipts went beyond the figure agreed, oldest first. Absent where none did.