Gather Business Insights (BI) by analyzing the ledgers for one or more Financial Accounts.
Use this API to search ledgers based on filters such as the transaction type and amount. The API returns a queryId that can be used to query the search status and retrieve the results.
Note The search is limited to the Business Account associated with the request access token.
POST /v1/search/ledger
Authorization: Bearer <access_token>
financialAccountIds REQUIRED
string (UUID)
List of Financial Account IDs to include in the search. These accounts must belong to the Business Account associated with the request access token.
fromCreatedAt
string (date), required format: yyyy-mm-dd
Date the ledger entry was created in RocketKOR. This filter will return entries created on or after this date.
toCreatedAt
string (date), required format: yyyy-mm-dd
Date the ledger entry was created in RocketKOR. This filter will return entries created on or before this date.
fromAmount
number
Amount of the ledger entry. This filter will return entries with an amount equal to or greater than this amount.
toAmount
number
Amount of the ledger entry. This filter will return entries with an amount equal to or less than this amount.
movementType
string enum, values: DEBIT, CREDIT
Type of ledger entry (DEBIT or CREDIT). If movementType is provided, transactionType will be ignored.
transactionType
string enum, values: SEND, REQUEST, DEPOSIT, WITHDRAWAL, REVERSAL, RETURN, ADJUSTMENT
Type of transaction. Possible values are:
resultFormat
string enum, values: CSV, JSON
Type of file used to store the search results.
Returns a queryId. Use this queryId to query the search status and retrieve the search results.
queryId
string (UUID)
ID representing the search results.
SAMPLE REQUEST
{
"financialAccountIds": [
"b0a38132-df41-4cd3-9ae9-c655c46ad50b"
],
"fromCreatedAt": "2023-01-01",
"toCreatedAt": "2023-01-31",
"fromAmount": 1000.00,
"toAmount": 5000.00,
"movementType": [
"DEBIT"
],
"transactionType": [
"SEND"
],
"resultFormat": "CSV"
}
SAMPLE RESPONSE
{
"queryId": "01e3488a-f668-431f-93dc-96c5dc368f96"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.