Skip to content

Brex: List cash account statements

Brex transactions.transactionsListCashStatements: arguments, response, policy and SDK examples.

← Transactions operations · Get started

Operation brex.transactions_listcashstatements

Provider route: GET /v2/accounts/cash/{id}/statements. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/brex with npm, or alter-sdk-brex with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { BrexIntegration } from "@alter-ai/brex";
async function execute(input: Parameters<BrexIntegration["transactions"]["transactionsListCashStatements"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new BrexIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.transactions.transactionsListCashStatements(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_brex import BrexIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = BrexIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.transactions.transactions_list_cash_statements(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cursorJSONOptional
query.cursor (anyOf 1)stringAlternative
query.cursor (anyOf 2)nullAlternative
query.limitJSONOptional
query.limit (anyOf 1)integerAlternativeFormat: int32
query.limit (anyOf 2)nullAlternative

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List cash account statements — response body

Referenced models: List cash account statements — response body

List cash account statements — response body
FieldTypePresenceDescription and constraints
$objectRoot
itemsarrayRequired within parent
items[]ModelEach itemExpand List cash account statements — response body — items item
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative

Referenced models: List cash account statements — response body — items item

List cash account statements — response body — items item
FieldTypePresenceDescription and constraints
$objectRoot
end_balanceJSONOptional
end_balance (anyOf 1)JSONAlternative
end_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
end_balance (anyOf 2)nullAlternative
idstringRequired within parent
periodModelRequired within parentExpand List card accounts — response body — item current statement period
start_balanceJSONOptional
start_balance (anyOf 1)JSONAlternative
start_balance (anyOf 1) (allOf 1)ModelAll variants applyExpand Get transfer — response body — amount
start_balance (anyOf 2)nullAlternative

Referenced models: Get transfer — response body — amount, List card accounts — response body — item current statement period

Get transfer — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
Money fields can be signed or unsigned. Fields are signed (an unsigned value will be interpreted as positive). The amount of money will be represented in the smallest denomination
of the currency indicated. For example, USD 7.00 will be represented in cents with an amount of 700.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Format: int64
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyJSONOptional
currency (anyOf 1)stringAlternativeThe type of currency, in ISO 4217 format.
Default: USD
currency (anyOf 2)nullAlternative
List card accounts — response body — item current statement period
FieldTypePresenceDescription and constraints
$objectRoot
end_datestringRequired within parentEnd date of the statement period at UTC 00:00:00 (exclusive)
Format: date
start_datestringRequired within parentStart date of the statement period at UTC 00:00:00 (inclusive)
Format: date

SDK function policy ID: brex.transactions_listcashstatements. Catalog operation: transactions:listCashStatements. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["statements.cash.readonly"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.