Corgi BankDocumentation
OpenAPI

Propose a break's resolution: a match, an adjustment against a reviewed GL, a timing difference or a dismissal

POST/ledger/correspondent/breaks/{id}/proposals

Correspondent banking authority: staff reads need ledger:correspondent:read (or ledger:read), writes need ledger:correspondent:write with a verified non-API-key staff identity and a step-up within five minutes, and a review also needs ledger:correspondent:approve and a different person from the maker. Nostro and correspondent ledger accounts are opened, posted and closed only through this module.

Path parameters

idstringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

actionstringRequired
break_versionintegerRequired
clears_bystring · date or nullOptional

Accept_timing

gl_codestringOptional

Post_adjustment

ledger_refsarray of stringsOptional

Match: the ledger items

notestringRequired
statement_refsarray of stringsOptional

Match: the other statement items

Returns

200 OK

actionstringRequired
break_idstringRequired
break_versionintegerRequired
clears_bystring · date or nullOptional

Accept_timing

gl_codestringOptional

Post_adjustment

idstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ledger_refsarray of stringsOptional

Match: the ledger items

makerstringRequired
notestringRequired
recorded_atstring · date-timeRequired
reviewobject or nullOptional

ReviewRecord is a retained decision.

4 child attributes
approvebooleanRequired
checkerstringRequired
reasonstringRequired
recorded_atstring · date-timeRequired
review_statusstringRequired

Pending_review, approved or rejected

statement_refsarray of stringsOptional

Match: the other statement items

Errors

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

400401403404409412413422424429500503

to move to open esc to close