Skip to content

Mercury: Get treasury account statements

Mercury treasury.getTreasuryStatements: arguments, response, policy and SDK examples.

← Treasury operations · Get started

Operation mercury.gettreasurystatements

Provider route: GET /treasury/{treasuryId}/statements. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["treasury"]["getTreasuryStatements"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.treasury.getTreasuryStatements(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.treasury.get_treasury_statements(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.treasuryIdstringRequired within parentID for a Mercury account.
Format: uuid
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalMaximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
Default: 1000
Format: int64
Maximum: 1000
Minimum: 1
query.orderstringOptionalSort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’
Default: asc
One of: asc, desc
query.start_afterstringOptionalThe ID of the statement to start the page after (exclusive). When provided, results will begin with the statement immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
Format: uuid
query.end_beforestringOptionalThe ID of the statement to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
Format: uuid
query.documentTypestringOptionalFilter statements by document type.
One of: MonthlyStatement, TradeConfirmation, 1099, 1099R, 1042S, 5498, 5498ESA, 1099Q, FMV, SDIRA

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get treasury account statements — response body

Referenced models: Get treasury account statements — response body

Get treasury account statements — response body
FieldTypePresenceDescription and constraints
$objectRootPaginated response for treasury account statements
pageobjectRequired within parent
page.nextPagestringOptionalID for the account statement
Format: uuid
page.previousPagestringOptionalID for the account statement
Format: uuid
statementsarrayRequired within parent
statements[]ModelEach itemExpand Get treasury account statements — response body — statements item

Referenced models: Get treasury account statements — response body — statements item

Get treasury account statements — response body — statements item
FieldTypePresenceDescription and constraints
$objectRootIndividual treasury statement in the response
accountIdJSONRequired within parent
accountId (allOf 1)stringAll variants applyID for a Mercury account.
Format: uuid
accountId (allOf 2)JSONAll variants applyExternal treasury account ID this statement belongs to
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyTimestamp when the record was created
creationDateJSONRequired within parent
creationDate (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
creationDate (allOf 2)JSONAll variants applyDate the statement was created by the custodian
descriptionstringRequired within parentHuman-readable description of the statement
documentTypeJSONRequired within parent
documentType (allOf 1)stringAll variants applyKnown values: MonthlyStatement, TradeConfirmation, 1099, 1099R, 1042S, 5498, 5498ESA, 1099Q, FMV, SDIRA
documentType (allOf 2)JSONAll variants applyType of document (e.g. monthly statement, trade confirmation, tax form)
downloadUrlstringRequired within parentURL to download the statement PDF
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the account statement
Format: uuid
id (allOf 2)JSONAll variants applyUnique identifier for the statement
periodEndJSONRequired within parent
periodEnd (allOf 1)stringAll variants applyFormat: date
periodEnd (allOf 2)JSONAll variants applyEnd of the period covered by the statement
periodStartJSONRequired within parent
periodStart (allOf 1)stringAll variants applyFormat: date
periodStart (allOf 2)JSONAll variants applyStart of the period covered by the statement
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyTimestamp when the record was last updated

SDK function policy ID: mercury.gettreasurystatements. Catalog operation: mercury:getTreasuryStatements. 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.

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.