Loan actions
Read an act by its reference
What a reference names: the act, the Loan it is about, and whether the fact it wrote still stands.
GET
Every act on a Loan — a cancellation, an acceleration, a write-off, a rollover, a return, a cession, a retraction — is recorded under a
reference of yours, and this read answers what that reference names. It is the read to make when an act’s response was lost: it tells you whether the act was recorded, against which Loan and on which day, before you decide whether to send it again. A Receipt has always been readable the same way.
The nine acts share one namespace per Tenancy, so the path names no Loan. A reversal keeps its own namespace and is read through its Receipt.
Path parameters
string
required
The Tenancy asking.
string
required
The act’s reference, as you recorded it. One never recorded — or recorded by another Tenancy — is
404 no_act, and asking records nothing.Response
string
required
The reference, echoed.
string
required
cancelled, accelerated, written_off, rolled_over, returned, ceded, suspended, suspension_ended or retracted — spelled as the Loan’s events spell it.string
required
The Loan the act is about.
string
required
The fact the act wrote, as the Loan’s
events name it — or, on a retraction, the fact it withdrew.string
required
The civil day the act stated.
object
What went back, on a return. Absent on every other kind.
string
The last day a suspension stated; its first is
on. Absent on every other kind.string
The suspension an early end ended. Absent on every other kind.
string
required
Who acted, as you stated it.
string
required
Why, as you stated it.
object
Your object, as the act carried it. Absent where none was attached.
boolean
required
Whether the fact this act wrote has since been withdrawn. Always
false on a retraction, which withdraws rather than stands.