Corgi BankDocumentation
OpenAPI

The Bank Close Plan object

An independently approved operating plan. Submit bank_close_plan through /requests with version, enabled, start_date, lending, no_lending_reason, reconciliation_sources, no_reconciliation_reason, policy_evidence and, on version 3, products (deposit_placements, customer_investments) or no_products_reason. Its scheduler uses the ledger's Federal Reserve calendar and cutoff; no plan means no scheduled close.

Attributes

checkerstringRequired
makerstringRequired
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
request_idstringRequired

Example req_2tVh8nqLxq4GbDe0K1F6S9zRcWm

to move to open esc to close