Get Transactions
ynab_get_transactionsRetrieve YNAB transactions by plan, date range, type, account, category, payee, amount, direction, or memo, and optionally return only inflow, outflow, and net totals.
Instructions
Gets transactions from a plan, optionally between a start and end date and by type (all, uncategorized or unapproved). Filter by at most one of account, category or payee: they cannot be combined, and if several are given only the first in that order is applied. To search, add payee or memo text, an amount range or a direction. Any search option (or untilDate) adds inflow, outflow and net totals over every match; the totals include transfers between accounts, such as credit card payments. totalsOnly returns just the totals (e.g. categoryId with a year's dates and totalsOnly). Without categoryId or payeeId, split transactions are matched leg by leg and the totals count only the matching legs. With categoryId or payeeId, rows are matched as YNAB returns them, so a split's parent row in the payee listing counts at its full amount.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Filter by transaction type. Defaults to 'all'. | |
| limit | No | Maximum number of transactions to return (default: 100). Totals always cover every match. | |
| planId | No | The plan ID (optional, defaults to YNAB_PLAN_ID; budgetId is a deprecated alias) | |
| payeeId | No | Filter to only transactions with this payee | |
| budgetId | No | Deprecated alias of planId (still accepted) | |
| accountId | No | Filter to only transactions in this account | |
| direction | No | Only money going out, coming in, or both. Defaults to 'any'. | |
| maxAmount | No | Largest amount to include, ignoring sign, in currency units | |
| minAmount | No | Smallest amount to include, ignoring sign, in currency units (e.g. 25.50) | |
| sinceDate | No | Only return transactions on or after this date (ISO format: 2024-01-01) | |
| untilDate | No | Only return transactions on or before this date (ISO format: 2024-12-31) | |
| categoryId | No | Filter to only transactions in this category | |
| totalsOnly | No | Return only the totals, without transaction rows (default: false) | |
| memoContains | No | Only transactions whose memo contains this text (case-insensitive) | |
| payeeContains | No | Only transactions whose payee name contains this text (case-insensitive) |