Corgi BankDocumentation
OpenAPI

List a nostro account's invoices

GET/ledger/correspondent/nostro-accounts/{id}/invoices

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

Returns

200 OK

dataarray of objectsRequired
21 child attributes
accrued_amountintegerRequired

The accrued charges the invoice billed

accrued_not_invoicedarray of stringsRequired

Accrued charge ids of the period the invoice did not bill

billed_charge_idsarray of stringsRequired
currency_codestringRequired
document_sha256stringRequired
exceptionsbooleanRequired
idstringRequired
invoice_numberstringRequired
linesarray of objectsRequired
4 child attributes
amountintegerRequired
codestringRequired
descriptionstringOptional
uetrstringOptional
matchesarray of objectsRequired
8 child attributes
amountintegerRequired
charge_idstringOptional
codestringRequired
descriptionstringOptional
expected_amountintegerRequired
outcomestringRequired
uetrstringOptional
variance_amountintegerRequired

Billed less expected

nostro_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

periodstringRequired
recorded_atstring · date-timeRequired
recorded_bystringRequired
reviewobject or nullOptional

ReviewRecord is a retained decision.

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

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_refstringRequired
statement_item_refstringOptional
statusstringRequired

Pending_review, approved, rejected or settled

total_amountintegerRequired
variance_amountintegerRequired

Total less the accrued charges it billed

Errors

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

400401403404409412413422424429500503

to move to open esc to close