Skip to navigation

The Bank Statement Account object

A collected view, not a document: the borrower’s bank accounts collected across every extracted bank statement, so one account’s statements can be read as a series. List-only, so there is no per-document retrieve.

The list endpoint returns { "borrower_id": …, "statements": [ … ], "document_account_labels": [ … ] }.

statements carries one entry per statement document in period order, with the statement’s account identity and period only, never its transactions or balances. document_account_labels is present only when the borrower’s balance sheet names its bank accounts.

The documents behind this object carry document_category bank_statement_business or bank_statement. Money keys are JSON strings with exactly two decimals ("9200000.00", "-1250.50"). Date keys are YYYY-MM-DD, as each key’s Type column shows.

Fields

KeyTypePresent whenDescription
accountobject, nullableAlwaysThe account the statement is for; null when the statement has no account block.
periodobject, nullableAlwaysThe statement period; null when the statement has no period block.

account

The account the statement is for.

KeyTypePresent whenDescription
holderstring, nullableAlwaysName of the account holder as printed.
institutionstring, nullableAlwaysName of the bank as printed.
accountNumberLast4string, nullableAlwaysThe last four digits of the account number.
linkedAccountLast4array of stringWhen the document states itLast four digits of the other accounts that appear on a statement covering several accounts. Empty for a statement of one account.
typestring, nullableAlwaysThe account type as printed, for example checking or savings.

period

The statement period and its opening and closing balances.

KeyTypePresent whenDescription
startstring (YYYY-MM-DD), nullableAlwaysFirst day of the statement period.
endstring (YYYY-MM-DD), nullableAlwaysLast day of the statement period.
openingBalancestring (money), nullableAlwaysBalance at the start of the period, as printed; for a statement that prints none, the linked account’s current balance carried back through its own transactions.
closingBalancestring (money), nullableAlwaysBalance at the end of the period, as printed; for a statement that prints none, the linked account’s current balance carried back through its own transactions.