Search Financial Account Statements

Search for monthly statements for a Financial Account. You can search for statements for internal, integrated bank, and integrated card Financial Accounts.

You can filter the results based on criteria such as the account holder ID, Financial Account ID, and statement date. You can also sort the results and 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>

Accept Header

Accept: application/vnd.rocketkor.v2+json

The Accept header is required to call the latest version of the API.

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 start date. This filter will return statements with a start date on or after this date.

This filter must be used in conjunction with statementStartDateTo. Together, these filters specify the date range to include in the search.

statementStartDateTo

string (date-time)

Search for statements based on the start date. This filter will return statements with a start date on or before this date.

This filter must be used in conjunction with statementStartDateFrom. Together, these filters specify the date range to include in the search.

statementEndDateFrom

string (date-time)

Search for statements based on the end date. This filter will return statements with an end date on or after this date.

This filter must be used in conjunction with statementEndDateTo. Together, these filters specify the date range to include in the search.

statementEndDateTo

string (date-time)

Search for statements based on the end date. This filter will return statements with an end date on or before this date.

This filter must be used in conjunction with statementEndDateTo. Together, these filters specify the date range to include in the search.

statementCreatedDateFrom

string (date-time)

Search for statements based on the creation date. This filter will return statements with a creation date on or after this date.

This filter must be used in conjunction with statementCreatedDateTo. Together, these filters specify the date range to include in the search.

statementCreatedDateTo

string (date-time)

Search for statements based on the creation date. This filter will return statements with a creation date on or before this date.

This filter must be used in conjunction with statementCreatedDateFrom. Together, these filters specify the date range to include in the search.

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 indexing.

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": "2025-01-01T00:00:00.000Z",
      "statementEndDate": "2025-01-31T23:59:59.999Z",
      "statementCreatedDate": "2025-01-04T22:58:29.782Z",
      "createdBy": "BI 'Accounts Statement' Job",
      "createdAt": "2025-01-04T22:58:29.782Z",
      "openingBalance": 4210.00,
      "closingBalance": 5600.00,
      "statementPath": "reports/AccountStatements/.../AccountStatement_202501.json",
      "statementYearMonth": {
        "year": 2025,
        "month": "JANUARY",
        "monthValue": 01,
        "leapYear": false
      }
    },
    {...},
    {...}
  ]
}
				
			
Exit mobile version