Search Financial Account Statements

Search for monthly statements for Integrated Bank Financial Accounts. You can use filters such as the account holder ID, Financial Account ID, and statement date. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Note Use the Retrieve a Financial Account Statement API to retrieve a more detailed monthly statement.

Endpoint

GET /v1/financial-account-statements

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

accountHolderId

string (UUID)

ID of the account holder for the Financial Account. The account holder can be a Customer Account or Business Account.

financialAccountId

string (UUID)

ID of the Financial Account.

statementStartDateFrom

string (date-time)

Search for statements based on the statement start date. This filter is used in conjunction with statementStartDateTo to define a date range for the search.

statementStartDateFrom Set the start date for the date range.
statementStartDateTo Set the end date for the date range.

statementStartDateTo

string (date-time)

Search for statements based on the statement start date. This filter is used in conjunction with statementStartDateFrom to define a date range for the search.

statementStartDateFrom Set the start date for the date range.
statementStartDateTo Set the end date for the date range.

statementEndDateFrom

string (date-time)

Search for statements based on the statement end date. This filter is used in conjunction with statementEndDateTo to define a date range for the search.

statementEndDateFrom Set the start date for the date range.
statementEndDateTo Set the end date for the date range.

statementEndDateTo

string (date-time)

Search for statements based on the statement end date. This filter is used in conjunction with statementEndDateFrom to define a date range for the search.

statementEndDateFrom Set the start date for the date range.
statementEndDateTo Set the end date for the date range.

statementCreatedDateFrom

string (date-time)

Search for statements based on the statement creation date. This filter is used in conjunction with statementCreatedDateTo to define a date range for the search.

statementCreatedDateFrom Set the start date for the date range.
statementCreatedDateTo Set the end date for the date range.

statementCreatedDateTo

string (date-time)

Search for statements based on the statement creation date. This filter is used in conjunction with statementCreatedDateFrom to define a date range for the search.

statementCreatedDateFrom Set the start date for the date range.
statementCreatedDateTo Set the end date for the date range.

sort

array of strings

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page index.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Financial Account Statement Summary objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "businessAccountId": "085b70e5-87d0-4242-b880-fadbc4c9257b",
      "accountHolderId": "a03e5af0-70fe-47b3-99bb-64cf6dba1c4a",
      "currency": "USD",
      "id": "51f9dc2d-cfa1-4180-ab41-4c5897db9a13",
      "financialAccountId": "14d8e541-a3ca-4703-8660-8d217bf2df1f",
      "statementStartDate": "2023-03-01T00:00:00.000Z",
      "statementEndDate": "2023-03-31T23:59:59.999Z",
      "statementCreatedDate": "2023-04-15T22:58:29.782Z",
      "createdAt": "2023-04-15T22:58:29.782Z",
      "createdBy": "BI 'Accounts Statement' Glue Job",
      "openingBalance": 4210.00,
      "closingBalance": 5600.00,
      "statementPath": "reports/AccountStatements/business_account_id=ad531842-8ec3-4e5a-b41c-830257683174/financial_account_id=d21f28c9-dc29-4fae-b673-df9cca1b07d7/year=2023/month=5/AccountStatement_202305.json",
      "statementYearMonth": {
        "year": 2023,
        "month": "MARCH",
        "monthValue": 03,
        "leapYear": false
      }
    },
    {...},
    {...}
  ]
}