Corgi BankDocumentation
OpenAPI

Whether the register lets the bank close a business_date: breaks and lender statements awaiting review or reconciliation beyond the reviewed tolerance, matured or ineligible pledges, and advances beyond capacity

GET/ledger/collateral/close-readiness

Blocks on a break or a lender's latest statement awaiting review or reconciliation beyond break_block_age_days, a reserved or acknowledged pledge on a matured or ineligible asset, and advances beyond a lender's lendable value; ledger end of day enforces the same judgement. A read needs ledger:read or ledger:post.

Query parameters

business_datestringOptional

Returns

200 OK

blockersarray of stringsRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

ineligible_pledgesintegerRequired
lendersarray of objectsRequired
10 child attributes
capacity_amountintegerRequired
latest_statement_idintegerOptional
latest_statement_statusstringOptional
lendable_amountintegerRequired
lender_idintegerRequired
lender_kindstringRequired
live_pledgesintegerRequired
outstanding_amountintegerRequired
schedule_idintegerOptional
shortfall_amountintegerRequired
lenders_shortintegerRequired
matured_pledgesintegerRequired
max_break_age_daysintegerRequired
oldest_break_daysintegerRequired
open_breaksintegerRequired
parameters_approvedbooleanRequired
readybooleanRequired
statements_awaiting_reconciliationintegerRequired
statements_awaiting_reviewintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close