get_budget_vs_actual

Erzeugt

Aus dem Code erzeugt mit python -m docsgen; ein Test schlägt fehl, sobald die Seite nicht mehr übereinstimmt. Die Beschreibungen stammen aus dem Code und bleiben auf Englisch: In dieser Sprache lesen Agenten sie.

Zweck

Return a budget-vs-actual breakdown with utilisation percentage per category.

Amounts in currency units; utilization_pct above 100 means over budget.

Verhalten

Art	nur lesend
Bestätigung	nein
Rückgängig	nein
Idempotent	ja
YNAB-Anfragen	1 für das Beispiel unten, leerer Cache

Parameter

Name	Typ	Pflicht	Standard	Beschreibung
plan_id	string	ja	—	YNAB plan id or ‘last-used’.
month	string	nein	"current"	ISO month ‘YYYY-MM-01’ or ‘current’.

Rückgabe

array of object

Feld	Typ	Beschreibung
id	string	YNAB id of the category.
name	string	Category name.
group	string	Name of the category’s group, e.g. Fun for Tennis.
budgeted	number	Amount assigned to the category this month.
actual	number	Amount spent this month, as a positive number.
balance	number	What is left: budgeted minus spent, plus what was carried over; negative when overspent.
utilization_pct	number	Spent as a share of budgeted, in percent; above 100 means overspent, 0 when nothing is budgeted.

Beispiel

Argumente:

{
  "plan_id": "demo-budget",
  "month": "2026-09-01"
}

Antwort auf dem Demo-Budget:

[
  {
    "id": "cat-rent",
    "name": "Miete",
    "group": "Fixkosten",
    "budgeted": 950.0,
    "actual": 950.0,
    "balance": 0.0,
    "utilization_pct": 100.0
  },
  {
    "id": "cat-power",
    "name": "Strom",
    "group": "Fixkosten",
    "budgeted": 70.0,
    "actual": 0.0,
    "balance": 70.0,
    "utilization_pct": 0.0
  },
  {
    "id": "cat-phone",
    "name": "Handy",
    "group": "Fixkosten",
    "budgeted": 20.0,
    "actual": 19.99,
    "balance": 0.01,
    "utilization_pct": 99.9
  },
  {
    "id": "cat-groceries",
    "name": "Lebensmittel",
    "group": "Alltag",
    "budgeted": 400.0,
    "actual": 0.0,
    "balance": 400.0,
    "utilization_pct": 0.0
  },
  "… 5 more"
]

Fehler

• month must be 'current' or the first day of a month as YYYY-MM-01, got '{month}'.

Fehler von YNAB selbst kommen als Error calling tool '<tool>': YNAB <status>: <detail> zurück.

Siehe auch

• Einen Monat auswerten