set_category_target

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, change or remove a category’s target, after the user confirms.

A target YNAB tracks for the category: an amount to reach by a date (a holiday fund, a yearly tax), or an amount to set aside each month, week or year. Give either by_date or frequency, not both; with neither, an existing target keeps its kind and only its amount changes (a new one is monthly). No amount removes the target. Undo restores the previous target, except one set in YNAB’s app as monthly funding, a target balance or a debt payment when it is replaced or removed: the user is told before confirming. 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’.
category_id	string	oui	—	Category (from get_category_balances or list_category_groups).
amount	number | null	non	null	Target amount in currency units, greater than 0; omit to remove it.
by_date	string | null	non	null	YYYY-MM-DD to reach the amount by.
frequency	“monthly” | “weekly” | “yearly” | null	non	null	monthly, weekly or yearly: the amount to set aside that often.
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	string	Category name.
before	string	The target before, e.g. “no target” or “50.00 each month”.
after	string	The target after.
undoable	boolean	False when YNAB’s API cannot bring the previous target back; the user is told first.
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",
  "category_id": "cat-holidays",
  "amount": 1200,
  "by_date": "2027-06-01"
}

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. Set the target of Vacances: no target → 1200.00 by 2027-06-01? If they agree, call again with this code.",
  "category": "Vacances",
  "before": "no target",
  "after": "1200.00 by 2027-06-01",
  "undoable": true,
  "confirmation": "<confirmation code>",
  "operation_id": null
}

Erreurs

• Category {category_id} is not in this plan: use a category_id from get_category_balances or list_category_groups.
• Give either a date or a frequency, not both: YNAB refuses the two.
• To remove the target, give no amount, no date and no frequency.
• The amount must be greater than 0; to remove the target, give none.
• YNAB takes neither a date nor a frequency on a category paired to a loan account: give an amount alone.
• YNAB takes no frequency on a credit card payment category: give an amount alone, or a date.
• 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