Loan actions
Record a cancellation
Record that the agreement never began. The loan reports cancelled, keeps its record, and answers the whole read back.
POST
A cancellation asserts the Loan never began — signed in error, or never disbursed. Recording answers
201 with the Loan as it now reads; an identical retry answers 200; a differing request under the recorded reference is 409 reference_reused. Cancelling a Loan carries the semantics in full.
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 civil day the fact is about, never defaulted. Not before the
anchor: a cancellation cannot predate the agreement it cancels.string
required
Your name for the act. One namespace per Tenancy across all nine acts — a reference that named a cancellation cannot later name a write-off. A refused act spends no reference.
string
required
Your own reference for whoever acted, at most 1024 bytes, never blank. Never derived from the credential.
string
required
What they wrote down about why — free text, at most 1024 bytes, never blank. The Platform imposes no vocabulary of reasons.
object
Your key-value object, stored and echoed beside the fact on every read, read by nothing.
Response
201 with the whole Loan: state reads cancelled, the cancelled event carries the act, and the plan stays readable — nothing recorded is removed. A cancellation is withdrawn by retracting it.