get_budget_vs_actual

Généré

Généré depuis le code par python -m docsgen ; un test échoue s’il ne correspond plus. Les descriptions viennent du code et restent en anglais : c’est la langue dans laquelle les agents les lisent.

Rôle

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

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

Comportement

Nature	lecture seule
Confirmation	non
Annulation	non
Idempotent	oui
Requêtes YNAB	1 pour l’exemple ci-dessous, cache vide

Paramètres

Nom	Type	Obligatoire	Défaut	Description
plan_id	string	oui	—	YNAB plan id or ‘last-used’.
month	string	non	"current"	ISO month ‘YYYY-MM-01’ or ‘current’.

Retour

array of object

Champ	Type	Description
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.

Exemple

Arguments :

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

Réponse sur le budget de démonstration :

[
  {
    "id": "cat-rent",
    "name": "Rent",
    "group": "Bills",
    "budgeted": 950.0,
    "actual": 950.0,
    "balance": 0.0,
    "utilization_pct": 100.0
  },
  {
    "id": "cat-power",
    "name": "Electricity",
    "group": "Bills",
    "budgeted": 70.0,
    "actual": 0.0,
    "balance": 70.0,
    "utilization_pct": 0.0
  },
  {
    "id": "cat-phone",
    "name": "Phone",
    "group": "Bills",
    "budgeted": 20.0,
    "actual": 19.99,
    "balance": 0.01,
    "utilization_pct": 99.9
  },
  {
    "id": "cat-groceries",
    "name": "Groceries",
    "group": "Everyday",
    "budgeted": 400.0,
    "actual": 0.0,
    "balance": 400.0,
    "utilization_pct": 0.0
  },
  "… 5 more"
]

Erreurs

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

Les erreurs propres à YNAB reviennent sous la forme Error calling tool '<tool>': YNAB <status>: <detail>.

Voir aussi

• Faire le point sur un mois