Loan actions
Record a write-off
Record the judgement that the debt will not be collected. The charging stops; the debt survives in full.
POST
A write-off is your recorded judgement that the debt will not be collected. It is not forgiveness: the debt survives it in full and stays collectable — what stops is the charging, on the write-off date itself. Writing a Loan off carries the freeze and the recovery.
The path segment is
write-off, with a hyphen.
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 of the judgement, never defaulted. Every delinquency figure freezes at it.
string
required
Your name for the act, in the one act namespace of the Tenancy.
string
required
Whoever acted, your own reference. Never derived from the credential.
string
required
Why, in your words. No vocabulary is imposed.
object
Stored, echoed beside the fact, read by nothing.
Response
201 with the whole Loan: state reads written_off, and the write_off block prices the judgement — cost, the debt at the write-off taken apart by charge, and recovered, what has been collected against it since. Money that arrives later is an ordinary Receipt: it settles the arrears first and then cost, advancing no instalment and recalculating no plan, so what is still owed is always cost less recovered. recovered grows, the state does not move, and closed_on never appears — a recovery does not revive the Loan, and full recovery does not close it.
Retry 200; a differing body under the recorded reference, 409 reference_reused. A write-off is withdrawn by retracting it — or superseded by a cession, which a charged-off book mostly is.