Loans
Read the delinquency
What lateness has cost as of a date: penalty and late fee per overdue period, and the loan’s oldest unresolved lateness.
GET
Delinquency is derived, as of the date you name, and attributed per Period — the shape a supervisor reconciles. Delinquency carries the rules: when a Period becomes overdue, what the penalty accrues on, what freezes at a write-off, and what a suspension stops.
A validator. The answer carries an
ETag over the Loan’s Client’s book and the date — the schedule and the delinquency are folded from every Receipt of the Client, so anything recorded about the Client moves 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 the Loan belongs to.
string
required
The Loan. Another Tenancy’s and one that never existed are both
404.Query parameters
string
required
The civil date the answer stands as of. Required and never defaulted; absent is
422 — there is no today the Platform can supply.Response
integer
required
The Loan’s oldest unresolved lateness in days — the figure a portfolio report buckets by. Frozen at a write-off, like everything below.
object
required
The penalty accrued across every overdue Period, with
late_fee, tax and total beside it — the whole cost of lateness on the date.array
required
Each overdue Period’s own account.
array
What waivers by the date released of the Period’s charges —
reference, on, period, charge, amount. The figures beside them are what lateness cost and are not reduced; what is still owed is the payment options’ answer. Absent where none did.object
The suspension in force on the date —
event_id, reference, from, to, and ended_on where an early end restarted the clock. Absent where the clock was running. Inside it no day counts and nothing accrues: a Period overdue before the window reads with the days and the penalty it had.