ledger_balance
Display account balances with filtering by date, depth, or account pattern. Group results by day, week, month, or year for customized financial reporting and analysis.
Instructions
Show account balances
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Input Schema (JSON Schema)
{
"$defs": {
"LedgerBalance": {
"properties": {
"begin_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date for transactions (YYYY/MM/DD)",
"title": "Begin Date"
},
"daily": {
"default": false,
"description": "Group by day",
"title": "Daily",
"type": "boolean"
},
"depth": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Limit account depth displayed",
"title": "Depth"
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date for transactions (YYYY/MM/DD)",
"title": "End Date"
},
"flat": {
"default": false,
"description": "Show full account names without indentation",
"title": "Flat",
"type": "boolean"
},
"monthly": {
"default": false,
"description": "Group by month",
"title": "Monthly",
"type": "boolean"
},
"no_total": {
"default": false,
"description": "Don't show the final total",
"title": "No Total",
"type": "boolean"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter accounts by regex pattern",
"title": "Query"
},
"weekly": {
"default": false,
"description": "Group by week",
"title": "Weekly",
"type": "boolean"
},
"yearly": {
"default": false,
"description": "Group by year",
"title": "Yearly",
"type": "boolean"
}
},
"title": "LedgerBalance",
"type": "object"
}
},
"properties": {
"params": {
"$ref": "#/$defs/LedgerBalance"
}
},
"required": [
"params"
],
"title": "ledger_balanceArguments",
"type": "object"
}