get_budget
Gets the user's budget for their configured forecast period — one entry per category with budgeted vs actual figures, the data behind the Budget page's per-category list. Optionally rolls up child categories into their parents. Use get_budget_summary for analysis over a specific date range; navigate_to_budget is the matching page link to offer alongside an answer.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"user_id": "<user_id>"
},
"name": "get_budget"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| roll_up | No | Whether parent categories should have their children's figures rolled up into them. Children will still appear separately but their figures will also be included in the parent. Default: false. | |
| user_id | Yes | The unique identifier of the user. |