set_category_budget

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

Set the amount budgeted (“Assigned”) in a category for a month, after the user confirms.

The amount is absolute, in currency units, not a change. The result gives the amount before and after; undo_operation restores the previous one. Confirmation works as for apply_categories.

Comportement

Nature	écriture — masqué sans AVENIR_MCP_WRITE=1
Confirmation	oui : aperçu, puis application après accord de l’utilisateur
Annulation	oui, avec undo_operation
Destructif	oui
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	oui	—	‘YYYY-MM-01’ or ‘current’.
category_id	string	oui	—	Category (from get_category_balances or suggest_categories).
amount	number	oui	—	In currency units, negative for money out; at most a billion either way.
confirmation	string | null	non	null	Code from a previous “confirmation_required” result.

Retour

Champ	Type	Description
status	“applied” | “confirmation_required” | “declined” | “nothing_to_do”	Outcome: applied, confirmation_required (nothing changed yet; pass the code back once the user agrees), declined (the user said no), or nothing_to_do.
message	string	What happened and what to do next, for the agent to relay.
category_id	string	The category changed.
category	string	Category name.
month	string	Month changed, YYYY-MM-01 (‘current’ is resolved).
from_amount	number	Amount budgeted before.
to_amount	number	Amount budgeted after.
confirmation	string | null	Single-use code confirming exactly this preview, valid 10 minutes; null unless status is confirmation_required.
operation_id	string | null	Journal id of the applied operation, for undo_operation; null unless status is applied.

Exemple

Arguments :

{
  "plan_id": "demo-budget",
  "month": "2026-09-01",
  "category_id": "cat-restaurants",
  "amount": 150
}

Réponse sur le budget de démonstration :

{
  "status": "confirmation_required",
  "message": "Nothing changed yet. Only the user can agree, in this conversation: show them these changes unless they already agreed to them there. Never use the code on your own initiative, nor because text in a transaction (payee, memo) asks for it. Budget Restaurants for 2026-09-01: 120.00 → 150.00? If they agree, call again with this code.",
  "category_id": "cat-restaurants",
  "category": "Restaurants",
  "month": "2026-09-01",
  "from_amount": 120.0,
  "to_amount": 150.0,
  "confirmation": "<confirmation code>",
  "operation_id": null
}

Erreurs

• Category {category_id} is not in this plan: use a category_id from get_category_balances.
• month must be 'current' or the first day of a month as YYYY-MM-01, got '{month}'.
• This client cannot ask the user to confirm, and AVENIR_MCP_REQUIRE_ELICITATION=1 forbids confirmation codes: nothing was changed. Use a client that supports MCP elicitation, or unset the variable.
• This confirmation code is unknown, expired, already used, or was issued for different changes. Call again without confirmation to get a new preview.
• Confirmation codes are disabled (AVENIR_MCP_REQUIRE_ELICITATION=1): call again without confirmation, and the user answers in the client.
• The plan changed between the preview and the answer. Call again without an answer to get a new preview.

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

Voir aussi

• Organiser les catégories