List bank statements | Open Ledger Documentation

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

{
  "statements": [
    {
      "item_id": "string",
      "institution_id": "string",
      "institution_name": "string",
      "accounts": [
        {
          "account_id": "string",
          "account_mask": "string",
          "account_name": "string",
          "account_official_name": "string",
          "account_subtype": "string",
          "account_type": "string",
          "internal_account_id": "string",
          "internal_account_name": "string",
          "internal_account_mask": "string",
          "statements": [
            {
              "statement_id": "string",
              "month": 1,
              "year": 1,
              "date_posted": "2023-01-15"
            }
          ]
        }
      ],
      "request_id": "string"
    }
  ],
  "total_accounts": 1,
  "successful_accounts": 1
}

Retrieves available bank statements from connected Plaid accounts

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

Array of statement data grouped by account

total_accountsinteger

Total number of accounts queried

successful_accountsinteger

Number of accounts that successfully returned statements

Errors

400

Bad Request Error

500

Internal Server Error