Page every loan and facility's retained principal at the close of each business date, by Schedule RC-C category
/loans/call-report/balancesStaff 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_ofstringOptionalfromstringOptionallimitstringOptionalstarting_afterstringOptionalReturns
200 OK
as_ofstring · dateRequiredA business date, YYYY-MM-DD
dataarray of objectsRequired14 child attributes
as_of_amountintegerRequiredRetained principal at the close of as_of
changesarray of objectsRequired5 child attributes
amountintegerRequiredSigned change on the date
balance_amountintegerRequiredRetained principal at the close of the date
business_datestring · dateRequiredA business date, YYYY-MM-DD
conversionbooleanOptionalThe receivable passed between a construction facility and its permanent loan on this date
journal_idsarray of stringsRequiredcredit_idstringRequiredcredit_kindstringRequiredLoan or facility
currency_codestringRequiredgl_codestringRequiredheld_fromstring · date or nullOptionalA loan converted from a construction facility carries the receivable from this business date
held_throughstring · date or nullOptionalA construction facility converted into a loan carried it through this date
ledger_account_idstringRequiredExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
opening_amountintegerRequiredRetained principal at the close of the day before from
product_codestringRequiredproduct_versionintegerRequiredrc_c_itemstringRequiredThe Schedule RC-C loan category the product version names, as the catalogue writes it
statusstringRequiredThe credit's status when listed
fromstring · dateRequiredA business date, YYYY-MM-DD
gl_codesarray of stringsRequiredEvery GL code a lending product posts receivables under
has_morebooleanRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503