Corgi BankDocumentation
OpenAPI

Page every loan and facility's retained principal at the close of each business date, by Schedule RC-C category

GET/loans/call-report/balances

Staff or service identity with lending:read or lending:write; customers and API keys are refused. as_of (required) is a non-future business date; from defaults to as_of and is at most 185 days earlier. Pages credits by id with limit (at most 100) and starting_after; ending_before is refused. Each loan or facility with a receivable account lists its principal net of participations sold at the close of the day before from, each dated change through as_of with its journals, and the Schedule RC-C category its product version names as the catalogue writes it. Balances are the ledger history of the credit's own receivable account, listed only after the account's name, owner, currency, namespace and GL code prove it is the one lending opened; a construction facility's receivable passes to its permanent loan on the conversion business date. A receivable recorded on two credits other than that pair refuses the listing with conflict; an unproven account answers lending.reconciliation_required.

Query parameters

as_ofstringOptional
fromstringOptional
limitstringOptional
starting_afterstringOptional

Returns

200 OK

as_ofstring · dateRequired

A business date, YYYY-MM-DD

dataarray of objectsRequired
14 child attributes
as_of_amountintegerRequired

Retained principal at the close of as_of

changesarray of objectsRequired
5 child attributes
amountintegerRequired

Signed change on the date

balance_amountintegerRequired

Retained principal at the close of the date

business_datestring · dateRequired

A business date, YYYY-MM-DD

conversionbooleanOptional

The receivable passed between a construction facility and its permanent loan on this date

journal_idsarray of stringsRequired
credit_idstringRequired
credit_kindstringRequired

Loan or facility

currency_codestringRequired
gl_codestringRequired
held_fromstring · date or nullOptional

A loan converted from a construction facility carries the receivable from this business date

held_throughstring · date or nullOptional

A construction facility converted into a loan carried it through this date

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

opening_amountintegerRequired

Retained principal at the close of the day before from

product_codestringRequired
product_versionintegerRequired
rc_c_itemstringRequired

The Schedule RC-C loan category the product version names, as the catalogue writes it

statusstringRequired

The credit's status when listed

fromstring · dateRequired

A business date, YYYY-MM-DD

gl_codesarray of stringsRequired

Every GL code a lending product posts receivables under

has_morebooleanRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close