Loan actions
Settle for less
Close the Loan against a figure the receipts reached. The rest is forgiven.
POST
A settlement for less closes the Loan at the end of
on against amount. The receipts value-dated on or before on must have reached it.
- What the Loan still owed on the day is forgiven, stated by charge on the read as
settled_for_less.forgiven. - Receipts beyond the figure by the day are owed to the Client, named by the settlement in the obligations.
- A receipt after
onmeets a closed Loan.
closed, with the settlement among its facts.
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 day the Loan closes.
object
required
The figure agreed, in the Loan’s currency.
string
required
Your name for the act, in the one act namespace of the Tenancy.
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 reads closed, closed_on is on, and settled_for_less states the figure and what was forgiven. Retry 200.