Documentation
account_register
account_register MCP tool reference, parameters, return type, and safety hints.
What it does
Shows the transaction register for one account, with date, status, branch, and pagination filters.
(account_id: string, asset_id?: string | null, date_from?: string | null, date_to?: string | null, time_from?: string | null, time_to?: string | null, branch?: string | null, status?: string | null, limit?: number, offset?: number, summary?: boolean) => Record<string, unknown>Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.
When to use it
Use this section to decide whether the tool fits the user request before calling it.
Before calling
Agents should gather these facts or confirmations first.
Have exact values for required inputs: account_id.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
account_idrequiredLedger account id or resolvable account reference.
asset_idoptionalAsset or currency id used by the ledger.
Default: nulldate_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nulltime_fromoptionalStart timestamp filter.
Default: nulltime_tooptionalEnd timestamp filter.
Default: nullbranchoptionalScenario branch name or id.
Default: nullstatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nulllimitoptionalMaximum number of rows to return.
Default: 100offsetoptionalNumber of rows to skip before returning results.
Default: 0summaryoptionalBoolean switch for this workflow.
Default: falseAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
account_register
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "account_register",
"arguments": {
"account_id": "<account_id>"
}
}