Loan actions
Record a suspension
Stop the loan’s clock between two dates: no lateness, no penalty, no days past due inside the window, and the plan unchanged.
POST
A suspension records that the Loan’s clock stands still from
from to to, both days included — while a store confirms a return, while a dispute is answered. Inside the window no Period becomes overdue, and a Period already overdue accrues no penalty and counts no day past due; after it, everything resumes. The plan does not move: due dates, interest and the schedule are what they were. Delinquency carries the arithmetic.
The window is stated whole. Ending it sooner is its own act; withdrawing it as though it never was is a retraction.
Path parameters
string
required
The Tenancy acting.
string
required
The Loan. Another Tenancy’s and one that never existed are both
404.Body
string
required
The first day the clock stands still. Yours to state, never read from a clock; not before the Loan’s anchor.
string
required
The last day it stands still, on or after
from. Required — a clock stopped until further notice is a clock nobody restarts.string
required
Your name for the act, in the one act namespace of the Tenancy. A suspension and the return that follows it are two acts and take two references.
string
required
Whoever acted, your own reference.
string
required
Why, in your words.
object
Stored, echoed beside the fact, read by nothing.
Response
201 with the whole Loan: state stays active, and the suspended event carries to beside its occurred_on. Retry 200; a differing body under the recorded reference — another window included — 409 reference_reused.
From then on the delinquency read, the payment options and the book name the suspension in force on the date they are asked about, under suspension. Inside the window the payment options carry no late: what has fallen due stays in overdue.
Refusals
A window that follows one already recorded is a further suspension, not a conflict.