list_payees
Retrieve all payees in a YNAB plan to review, categorize, or manage budget transactions. Use a plan ID and optionally exclude specific fields.
Instructions
List all payees in a plan.
Args: plan_id: The plan ID (use list_plans to find available IDs) exclude_fields: Optional list of field names to exclude from each payee. If omitted, the model's default exclude list is used (see FIELDS.md). Pass [] to return all fields. Pass a custom list to override the default.
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": {
"plan_id": "<plan_id>"
},
"name": "list_payees"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes | ||
| exclude_fields | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |