Corgi BankDocumentation
OpenAPI

The Bank Close object

A captured banking date and ordered dependencies, with immutable attempt evidence and recoverable checkpoints. Missing reconciliations, variances or unresolved statement deliveries block completion and later dates.

Attributes

attemptsintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

completed_atstring · date-time or nullOptional
created_atstring · date-timeRequired
cursorstringOptional
evidencearray of objectsOptional
10 child attributes
actorstringRequired
atstring · date-timeRequired
cursorstringOptional
errorstringOptional
numberintegerRequired
reasonstringOptional
resultobjectRequired
source_sha256stringOptional

SourceSHA256 is the digest of the fenced module source this attempt judged, when the source carries one; it is the close's own record of exactly what it read.

statestringRequired
stepstringRequired
idstringRequired
last_errorstringOptional
last_reasonstringOptional

LastReason is why the step blocked, in the words the module gave, so an operator reads the blocker itself instead of the problem code alone.

lease_untilstring · date-time or nullOptional
planobjectRequired

ClosePlan is captured in an independently approved bank_close_plan request. Version 1 uses the ledger's Federal Reserve calendar and disclosed cutoff; it cannot silently select a different calendar from the posting engine. Version 3 adds the product modules whose own closing source the run asks for.

10 child attributes
enabledbooleanRequired
lendingbooleanRequired
no_lending_reasonstringOptional
no_products_reasonstringOptional
no_reconciliation_reasonstringOptional
policy_evidencestringRequired
productsarray of stringsOptional
reconciliation_sourcesarray of stringsRequired
start_datestring · dateRequired

A business date, YYYY-MM-DD

versionintegerRequired
plan_request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

statusstringRequired
step_indexintegerRequired
stepsarray of stringsRequired

to move to open esc to close