Reference

List Accounts

Retrieves all accounts within a YNAB budget, including checking, savings, credit cards, and loans with their current balances. Use this to get account details and IDs for other account operations or to monitor your financial position.

Create a new account in a budget

Add a new manual account to your budget to track specific financial accounts like savings, investments, or alternative payment methods that aren't connected to your bank.

Get Account by ID

Retrieves detailed information about a specific bank or credit card account within your YNAB budget, including its current balance and transaction history status.

Get Budget Month

Retrieve detailed budget information for a specific month, including total income, expenses, and category-by-category breakdowns to understand your financial performance during that period.

List Budgets

Retrieves all budgets from your YNAB account so you can see an overview of your financial plans and identify which budget to work with next. This is typically the first step when accessing YNAB data through integrations.

Get Budget By ID

Retrieve complete budget data for a specific budget including all accounts, categories, payees, and transactions to get a full snapshot of your financial state.

Get Budget Settings

Retrieve the currency and date formatting preferences configured for a specific budget, helping you understand how your financial data is formatted and localized.

List Budget Months

Retrieve a list of all budget months with summary data, including the ability to fetch only months that have changed since a specific date for efficient tracking of budget updates.

List Categories

Retrieve all categories and category groups from your YNAB budget to understand your spending structure and identify available categories for transaction tracking. Use this when setting up budget tracking, reconciling category assignments, or syncing your budget structure with other tools.

Get Category by ID

Retrieve detailed information about a specific budget category including its budgeted amount, current balance, spending activity, and any goals you've set. Use this to monitor how much you've allocated and spent in individual budget categories.

Get Month Category By ID

Retrieves detailed information about a specific spending category for a chosen month in your budget, showing you exactly how much you've allocated and spent in that category for that period.

Get Payee by ID

Retrieve detailed information about a specific payee in your YNAB budget by their ID, including their name and transaction history. This helps you verify payee details and understand spending patterns for accurate financial tracking.

List Payee Locations

Retrieve all GPS locations associated with payees in your budget, which are automatically captured when transactions are recorded through YNAB mobile apps. This helps you understand where your spending is concentrated and identify familiar transaction locations.

List Payee Locations by Payee

Retrieves all GPS locations where transactions for a specific payee have occurred, helping you understand spending patterns and payee locations tracked through YNAB mobile apps.

List payees in a budget

Retrieve all payees in your YNAB budget to see everyone you regularly pay money to, including customers, vendors, and service providers. This helps you organize your spending, identify recurring payments, and maintain accurate financial records.

Update Payee

Modify an existing payee's name in your budget to keep your financial records organized and accurate. This helps you maintain consistent naming conventions across your spending patterns.

Create Scheduled Transaction

Set up recurring transactions in YNAB for bills, expenses, or income that repeat on a regular schedule, helping you automate your budgeting process and stay on top of predictable financial commitments.

List Transactions

Retrieve transactions from a specific YNAB budget to view spending activity and financial records. Filter by date, type, or since your last sync to efficiently access relevant transaction data.

Delete Scheduled Transaction

Removes a scheduled transaction from your YNAB budget, useful when a recurring payment or income is no longer applicable. This action is permanent and cannot be reversed.

Get Scheduled Transaction by ID

Retrieves the details of a specific scheduled transaction in your budget, including amount, frequency, and account information. Use this to view upcoming bills, paychecks, or recurring expenses you've already set up.

Get Transaction by ID

Retrieves detailed information for a specific transaction in your YNAB budget, including amount, category, date, and notes. Use this when you need to view or verify the specifics of a particular financial transaction.

List Scheduled Transactions

Retrieve all recurring transactions scheduled in your YNAB budget, including future payments like rent, subscriptions, and paychecks. This helps you forecast cash flow and stay on top of upcoming commitments.

List Transactions by Account

Retrieve all transactions for a specific account in YNAB, allowing you to view spending history and financial activity with optional filtering for recent changes. This helps you track account-level finances and reconcile your records.

List Transactions by Category

Retrieve all completed transactions within a specific spending category to analyze spending patterns and track expenses. This helps you understand where your money is going and identify areas where you might be over or under budget.

List Transactions by Payee

Retrieve all transactions associated with a specific payee in your YNAB budget to analyze spending patterns and payment history. This helps you understand your relationship with vendors, clients, or recurring payment sources at a glance.

Update Scheduled Transaction

Modify an existing scheduled transaction in YNAB by updating its date, frequency, amount, payee, category, or account. This keeps your recurring bill tracking and income schedules accurate as your business circumstances change.

Get Authorized User

Retrieve the authenticated user's account details and profile information from YNAB. This helps you verify your connection and access user-specific data needed for personalizing your budgeting setup.