Facilities
Read a facility
Read a grant together with what has been drawn from it and what is left.
GET
This call answers a Facility as it was created, and the two figures that move: what has been drawn under it, and what remains.
Headroom is the grant’s amount minus the sum of the original principals of every Loan ever issued under it, whatever each Loan’s later state.
Path parameters
string
required
The Tenancy whose grant is read. Another Tenancy’s path answers
403.string
required
The grant’s identifier, as the creation answered it.
Response
Every field the creation answers, and two more.object
required
The sum of the original principals of every Loan ever issued under this grant, as
minor_units and currency.object
required
The amount minus what was drawn. This is the figure an issuance is held against.
string
On a line, the day
drawn and headroom are as of. Absent on a one-draw grant, whose figures name no day.string
On a line another line renewed, that line. Absent otherwise.
A worked remainder
A grant of MXN 10,000.00 with Loans of MXN 3,000.00 and MXN 2,000.00 issued under it answersdrawn of 500000 and headroom of 500000.
Cancel either Loan and the two figures do not move. Repay both in full and they do not move. The grant records what was drawn, and it has no opinion about what became of it.
A line’s remainder
A line answers the same two figures differently, and three more fields beside them.drawn is the principal still outstanding on its Loans — and on the Loans of every line it superseded — as of on, the day the read falls on in the zone the line froze. headroom is the amount less that, never below zero. Repay MXN 1,500.00 of a MXN 4,000.00 draw on a MXN 10,000.00 line and headroom reads 750000 from the receipt’s value date; reverse the receipt and it reads 600000 again.
A line another line superseded carries superseded_by, and its headroom reads zero from the day its successor opens.
Why the read and the issuance cannot disagree
The Platform derives this figure once. The Facility asks the loan domain how much has been drawn under it, and issuance holds a new principal against the same query over the same rows — so the answer here is the answer an issuance would get, taken at the same moment. What the read cannot promise is that the figure survives the next request. Two issuances against one grant are serialised against each other; a read is not, and a Loan issued between your read and your issuance moves the remainder. Issuance decides again, under the Client’s lock, and that decision is the one that binds.Refusals
This route reads no query parameter and takes no body.
Those two are the same
404, which is what keeps them indistinguishable from outside. An identifier the Platform cannot even read as one answers the same way. A read-scoped key is enough.