Get Payee
get_payeeRead-only
Retrieve detailed information about a specific payee in your YNAB budget to manage transactions and track spending sources.
Instructions
[1 API call] Get details for a single payee
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| budget_id | No | Budget ID or 'last-used' | last-used |
| payee_id | Yes | The payee ID |
Implementation Reference
- src/tools/payees.ts:31-52 (handler)Registration and handler logic for the 'get_payee' tool.
server.registerTool("get_payee", { title: "Get Payee", description: "[1 API call] Get details for a single payee", inputSchema: { budget_id: z.string().default("last-used").describe("Budget ID or 'last-used'"), payee_id: z.string().describe("The payee ID"), }, annotations: { readOnlyHint: true }, }, async ({ budget_id, payee_id }) => { try { const response = await getClient().payees.getPayeeById(budget_id, payee_id); const p = response.data.payee; const lines = [ `Name: ${p.name}`, `Transfer Account: ${p.transfer_account_id ?? "None"}`, `ID: ${p.id}`, ]; return textResult(lines.join("\n")); } catch (e: any) { return errorResult(e.message); } });