List bank statements

1 curl -G https://api-staging.openledger.com/v1/reports/statements/list \ 2 -H "Authorization: Bearer <token>" \ 3 -d entityId=entityId

1 { 2 "statements": [ 3 { 4 "item_id": "item_id", 5 "institution_id": "institution_id", 6 "institution_name": "institution_name", 7 "accounts": [ 8 { 9 "account_id": "account_id", 10 "account_mask": "account_mask", 11 "account_name": "account_name", 12 "account_official_name": "account_official_name", 13 "account_subtype": "account_subtype", 14 "account_type": "account_type", 15 "internal_account_id": "internal_account_id", 16 "internal_account_name": "internal_account_name", 17 "internal_account_mask": "internal_account_mask", 18 "statements": [ 19 { 20 "statement_id": "statement_id", 21 "month": 0, 22 "year": 0, 23 "date_posted": "date_posted" 24 } 25 ] 26 } 27 ], 28 "request_id": "request_id" 29 } 30 ], 31 "total_accounts": 0, 32 "successful_accounts": 0 33 }

Retrieves available bank statements from connected Plaid accounts

Query parameters

entityIdstringRequired

The ID of the entity to list statements for

accountIdstringOptional

Optional specific account ID to filter statements

Response

Statements listed successfully

statementslist of objects or null

Array of statement data grouped by account

total_accountsinteger or null

Total number of accounts queried

successful_accountsinteger or null

Number of accounts that successfully returned statements

Headers

Query parameters

Response

Errors