Loans
Read a statement
A Loan’s figures for a period you name: what it owed before, what arose and what was paid inside, what it owes after, and what comes next.
GET
Every figure a periodic statement prints, for the civil period from
The first example is the worked Loan’s September: 5,000.00 owed at the start, Period 1’s interest and fee with their IVA arising on the 10th, the instalment of 1,017.38 paid that day, and 4,258.18 of principal owed at the end — 5,000.00 + 275.56 − 1,017.38. The second is twelve days of October in which Period 2 stood unpaid: the penalty those days accrued, and nothing else arising; the closing balance holds the whole unpaid instalment’s charges with its late fee and every day of penalty so far.
from to to, inclusive. The opening balance is what the schedule, the delinquency read and the payment options answer for the day before the period; the closing balance is what they answer for its last day. Between them: every charge that arose, every Receipt applied, every reversal and every fact. The opening plus what arose less what the Receipts settled is the closing — computed once by the Platform, not subtracted by you.
A statement records nothing. Ask about any past period, as often as you like; the same period answers the same.
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 period’s first civil day,
YYYY-MM-DD. Required and never defaulted; absent is 422.string
required
The period’s last civil day,
YYYY-MM-DD, inclusive. Required; absent is 422. A to before from is 400 invalid_query. from equal to to is a one-day period.Response
object
required
Every field of a listing row: the figures the Loan was issued with —
principal, term_periods, rate, fee, penalty_rate, anchor, totals.payments — and its state, owes and owed_to. paid and the Period counts are as of to.string
required
The period, echoed.
object
What the Loan owed on the day before
from.Zeros before the anchor and once the Loan has ended. Absent on a day the Loan stood ceded — from the cut-off it is owed to the assignee — and where the Loan could not be described, with the reason in anomalies.array
required
Every charge that arose inside the period, each attributed to its Period.
The payment taken at the purchase is never here: the purchase settled it.
array
required
Every Receipt value-dated inside the period that reached this Loan:
receipt, as the Receipts listing reads it back, and applied, what it did to this Loan — Periods, charges and tax, any prepayment — as its allocation states it.array
required
Every reversed Receipt value-dated inside the period that named this Loan or no Loan. It settled nothing from its value date.
array
required
Every fact recorded about the Loan dated inside the period — a rollover, a waiver, a suspension, the issuance — as the Loan read renders it.
object
What the Loan owed on
to, on the opening’s terms.object
The first Period falling due after
to that still asks for something: index, due_on and owed, a figure by component. Absent where nothing lies ahead — every Period settled, the Loan ended, or its whole balance owed now.string
required
The statement’s cut date, which is
to.object
The box a statement of a mass-market credit prints:
disclosure (the CAT as the Loan froze it, with provisional), rate and penalty_rate.object
The interest charged inside the period:
amount, tax, total.object
The fees and late fees charged inside the period:
amount, tax, total.array
required
The payments the statement asks for: those falling due inside the period, or the next one where none does.
array
required
Every Receipt inside the period that paid principal ahead of the plan:
receipt_id, reference, principal, and effect — shortened with removed, the payments the plan no longer reaches, or lowered with instalment, the new instalment, and by, how much it fell.