Loans
Read a loan
The whole record: the folded state, every recorded fact, the frozen plan and the regime it was priced under.
GET
One route answers the whole Loan. Nothing on it is stored as a status:
state is folded from the recorded facts on every read, so the answer and the facts it derives from can never disagree. Loans carries the states, the precedence and the freeze.
Path parameters
string
required
The Tenancy the Loan belongs to.
string
required
The Loan’s identifier, as the issuance answered it. Another Tenancy’s Loan and one that never existed are both
404.Response
string
required
Folded on every read:
active, closed, cancelled, written_off, ceded, held, voided, rescinded, withdrawn or restructured. Precedence where facts pile up: voided over held over cancelled over rescinded and withdrawn over ceded over written_off over closed over restructured over active. This read takes no date, so a hold nobody confirmed reads held even past its last day; the listing answers expired with on.array
required
Every recorded fact, retracted ones included.
array
required
Contradictions the fold resolved rather than refused — empty on a healthy Loan. Each names its kind and the pair of facts behind it.
integer
required
How many rollovers stand in force. Served on every Loan, zero included.
array
What each return in force produced, oldest first:
act, on, amount, unwound_principal, principal_owed_back, interest_owed_back, still_owed by charge, beyond_the_loan — your own refund, outside the book — and returned_whole. Derived on every read; absent on a Loan nothing went back on.object
What the Receipts have settled against this Loan to date — the same figure as the listing row. A stated zero where nothing reached the Loan; absent where the Client’s allocation cannot be derived, with the reason in
anomalies.boolean
required
Whether the Loan still owes anything, by the rule the listing states it: an active or written-off Loan owes the Tenancy, a ceded one owes the assignee, a closed or cancelled one owes nothing.
string
tenant or assignee; absent where the Loan owes nothing.string
The value date of the discharging Receipt. Present exactly on a
closed Loan — a written-off Loan never carries one, even after full recovery.object
Present where a write-off stands:
on, cost — the debt at the judgement, taken apart by charge — and recovered. Delinquency carries the worked block.object
required
{id, version}, pinned at issuance.object
required
The stated terms echoed:
client_id, reference, principal, term_periods, rate, penalty_rate, anchor, jurisdiction, tax, and down_payment, schedule, merchant_ref and context where stated.array
required
The plan as issued — frozen. Where the Loan stands now is the serviced Schedule.
object
required
The jurisdiction and the disclosed cost figure, computed once at issuance and never restated, with the convention it was computed under:
convention, convention_version and provisional.The three are frozen with the figure. A Loan issued while the rule was provisional reads provisional: true for its whole life, whatever is confirmed afterwards; a Loan issued under a confirmed version reads false. A Loan issued before the Platform named its conventions reads mx-cat, version 1, provisional, which is what was true of every one of them. What provisional means.object
required
The jurisdiction’s law as values, frozen:
penalty_rate, late_fee, tolerance_days, penalty_base, capitalises, acceleration.Three fields are served only where the Loan carries them.The example below is a Loan that carries none of the three, so none of the keys appears.