Skip to main content
YNAB logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 27
  • Triggers: 0
  • Slug: YNAB
  • Version: 20261101_00

Tools

Slug: YNAB_CREATE_ACCOUNTTool to create a new account in a budget. Use when you need to add a manual (non-linked) account to a specific budget.

Input Parameters

object
required
The account object to create with name, type, and initial balance
string
required
ID of the budget in which to create the account. Use ‘default’ for the default budget or ‘last-used’ for the last used budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_CREATE_CATEGORYCreate a category in a category group in a YNAB plan.

Input Parameters

string
required
Plan UUID, ‘last-used’, or ‘default’ when default plan selection is enabled.
object
required
The category to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_CREATE_SCHEDULED_TRANSACTIONCreates a scheduled (recurring) transaction in a YNAB budget. Use this to set up bills, recurring expenses, or income that repeats on a schedule. Requires an account_id (from YNAB_LIST_ACCOUNTS), a date, frequency, and amount in milliunits.

Input Parameters

string
required
Budget UUID or literal ‘last-used’/‘default’ to operate on
object
required
Scheduled transaction object to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_CREATE_TRANSACTIONCreate one ordinary, non-scheduled transaction in a YNAB plan.

Input Parameters

string
required
Plan UUID, ‘last-used’, or ‘default’ when default plan selection is enabled.
object
required
The single ordinary transaction to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_DELETE_SCHEDULED_TRANSACTIONPermanently deletes a scheduled transaction from a YNAB budget. Use this when a recurring transaction is no longer needed. This action cannot be undone. Obtain the scheduled_transaction_id from list_scheduled_transactions or get_scheduled_transaction_by_id before calling this.

Input Parameters

string
required
The budget UUID, or use ‘last-used’ to target the last used budget, or ‘default’ when default budget selection is enabled.
string
required
The UUID of the scheduled transaction to delete. Obtain this from list_scheduled_transactions or get_scheduled_transaction_by_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_DELETE_TRANSACTIONPermanently delete an ordinary transaction and return it. This cannot be undone through the toolkit.

Input Parameters

string
required
The plan UUID, or ‘last-used’ for the last used plan, or ‘default’ when default plan selection is enabled.
string
required
The identifier of the ordinary transaction to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_ACCOUNT_BY_IDTool to retrieve a single account resource. Use when you need details of a specific account by its ID after determining the budget.

Input Parameters

string
required
Budget identifier; use ‘default’ if the default budget selection is enabled for your OAuth app.
string
required
Account identifier (UUID) within the specified budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_BUDGET_BY_IDRetrieve a complete budget export by ID, including all accounts, categories, payees, and transactions. Use this tool when you need comprehensive budget data. The response includes: - Budget metadata (name, date/currency formats) - All accounts with balances - Category groups and categories with budgeted amounts and balances - All payees - All transactions and scheduled transactions (optional, may be large) For incremental syncing, use last_knowledge_of_server to only fetch changes since your last request. Note: Currency amounts are in ‘milliunits’ format (divide by 1000 for standard units).

Input Parameters

string
required
The ID of the budget to retrieve. Use ‘last-used’ for the most recently accessed budget, or ‘default’ if default budget selection is enabled in YNAB settings.
integer
Optional. If provided, returns only entities changed since this server knowledge value (delta request).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_BUDGET_MONTHTool to retrieve a specific budget month. Use when you need detailed summary and category budgets for a given month after confirming the budget ID. Monetary amounts are returned in milliunits (divide by 1000 for standard currency). Response includes high-level aggregates and a nested category array within the month payload for per-category budget analysis.

Input Parameters

string
required
Budget month in ISO 8601 format (YYYY-MM-01) or ‘current’ for the current calendar month (UTC).
string
required
Budget identifier; if OAuth ‘default budget selection’ is enabled, you may use ‘default’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_BUDGET_SETTINGSRetrieve currency and date formatting settings for a specific YNAB budget. Use the budget ID, or a supported special value such as ‘last-used’ or ‘default’, to identify the budget.

Input Parameters

string
required
ID of the budget to fetch settings for. Supports special values like ‘last-used’ or ‘default’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_CATEGORY_BY_IDRetrieve a single YNAB budget category by its ID. Use this to get detailed category information including budgeted amounts, activity, balance, and goal settings. Amounts are returned for the current budget month (UTC). Requires both budget_id and category_id - use ‘last-used’ or ‘default’ for budget_id if you don’t have a specific budget ID.

Input Parameters

string
required
The budget ID (UUID format). Use ‘last-used’ for the most recently accessed budget, or ‘default’ if default budget selection is enabled.
string
required
The unique identifier (UUID) of the category to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_MONTH_CATEGORY_BY_IDTool to retrieve a single category for a specific budget month. Use after selecting the budget and month when you need month-specific category details.

Input Parameters

string
required
Budget month in ISO 8601 full-date format (YYYY-MM-DD).
string
required
Budget identifier; use ‘default’ if default budget selection is enabled.
string
required
Category identifier (UUID) within the specified budget month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_PAYEE_BY_IDTool to retrieve a single payee by its ID. Use when you need full details of a payee after confirming the budget and payee selection.

Input Parameters

string
required
The unique identifier (UUID) of the payee to retrieve.
string
required
The budget identifier. Can be a UUID, ‘default’ (if OAuth default budget selection is enabled), or ‘last-used’ to reference the last accessed budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_SCHEDULED_TRANSACTION_BY_IDTool to retrieve a single scheduled transaction. Use when you need details of a specific scheduled transaction by its ID after confirming the budget.

Input Parameters

string
required
The budget UUID or special value: ‘last-used’ for the last accessed budget, or ‘default’ if default budget selection is enabled in YNAB settings.
string
required
The UUID of the scheduled transaction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_TRANSACTION_BY_IDTool to retrieve a single transaction by its ID. Use when you need detailed information for a specific transaction after confirming the budget.

Input Parameters

string
required
The budget ID. Use ‘default’ to reference the default budget when OAuth default budget selection is enabled, or ‘last-used’ for the last accessed budget.
string
required
The UUID of the transaction to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_GET_USERRetrieve the authenticated YNAB user’s information, including their unique user ID. Use this to identify the current user after authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_ACCOUNTSRetrieves all accounts for a specified YNAB budget. Use this tool to: - Get a complete list of accounts (checking, savings, credit cards, loans, etc.) in a budget - Retrieve account IDs for use with other YNAB account-related operations - Monitor account balances (current, cleared, and uncleared) - Perform efficient delta syncing by passing last_knowledge_of_server Returns account details including balances in milliunits (1000 milliunits = 1 currency unit). For example, a balance of 150000 milliunits equals $150.00. Note: Use ‘default’ or ‘last-used’ as budget_id for convenience, or obtain specific budget UUIDs from the List Budgets endpoint.

Input Parameters

string
required
The budget UUID or special value. Use ‘default’ for the user’s default budget, or ‘last-used’ for the most recently accessed budget. Alternatively, provide a specific budget UUID obtained from the List Budgets endpoint.
integer
If provided, only entities that have changed since this server knowledge value will be included in the response (delta request). Obtain this value from a previous response’s server_knowledge field for efficient syncing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_BUDGETSRetrieves all budgets accessible to the authenticated YNAB user. Use this tool to: - Get a list of all budgets in the user’s YNAB account - Retrieve budget IDs for use with other YNAB operations - Optionally include account details for each budget Returns budget summaries including name, last modification time, date range, and formatting preferences. Budget IDs from this response are required for most other YNAB API operations.

Input Parameters

boolean
If True, includes the list of accounts for each budget in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_CATEGORIESTool to list all category groups and their categories for a budget. Use when you need the full set of budget categories or only those changed since last sync. Category names may include emojis or near-identical labels; always use category_id from the response in downstream requests.

Input Parameters

string
required
Budget identifier; use ‘default’ if the default budget selection is enabled for your OAuth app.
integer
For delta syncing: only return categories changed since this server knowledge. Response will include an updated server_knowledge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_MONTHSTool to list months for a budget with summary information. Use when you need an overview of all months or only changed months since a given knowledge value (delta requests).

Input Parameters

string
required
The budget UUID to list months for. Use ‘last-used’ to specify the last accessed budget, or ‘default’ if default budget selection is enabled in the OAuth application settings.
integer
Server knowledge value from a previous response. When provided, only months that have changed since this value will be returned (delta request). Omit for a full list of months.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_PAYEE_LOCATIONSRetrieves all GPS locations associated with payees in a budget. Payee locations are recorded when transactions are saved using the YNAB mobile apps, storing GPS coordinates to help pre-populate nearby payees. Use this tool when you need to find all recorded locations for payees in a budget. Note: Not all payees will have locations recorded.

Input Parameters

string
required
The ID of the budget (UUID format). Use ‘last-used’ to specify the last used budget, or ‘default’ if default budget selection is enabled in your YNAB account settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_PAYEE_LOCATIONS_BY_PAYEERetrieves all GPS locations associated with a specific payee in a budget. Payee locations are recorded when transactions are saved using the YNAB mobile apps, storing GPS coordinates to help pre-populate nearby payees. Use this tool when you need to find where a payee’s transactions typically occur. Note: Not all payees will have locations recorded.

Input Parameters

string
required
The unique identifier (UUID) of the payee to retrieve locations for.
string
required
The ID of the budget (UUID format). Use ‘last-used’ to specify the last used budget, or ‘default’ if default budget selection is enabled in your YNAB account settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_PAYEESTool to list payees in a budget. Use when you need all payees or only those changed since a known server knowledge value.

Input Parameters

string
required
Budget identifier (UUID). Use ‘last-used’ to refer to the last accessed budget or ‘default’ if OAuth default budget selection is enabled.
integer
Only return entities changed since this server knowledge value (delta requests).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_SCHEDULED_TRANSACTIONSList all scheduled (recurring) transactions for a YNAB budget. Returns future-dated transactions that repeat on a schedule (e.g., rent, subscriptions, paychecks). Supports delta sync to fetch only changes since a previous request using the server_knowledge value.

Input Parameters

string
required
The budget ID. Use ‘last-used’ to get the last used budget, or ‘default’ if default budget selection is enabled. Otherwise, provide the actual budget UUID.
integer
Server knowledge value for delta sync. When provided, only scheduled transactions changed since this value are returned. Use the server_knowledge value from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_TRANSACTIONSTool to list transactions in a budget. Use when you need all or delta-filtered transactions after confirming the budget. Omitting all filters returns the full transaction history, which may produce large payloads; prefer since_date, type, or last_knowledge_of_server to scope results.

Input Parameters

string ("uncategorized" | "unapproved")
Filter by transaction type; supported values: ‘uncategorized’, ‘unapproved’.
string
required
Budget identifier (UUID). Use ‘default’ if default budget selection is enabled, or ‘last-used’ to specify the last used budget.
string
Only include transactions on or after this ISO date (YYYY-MM-DD).
integer
Optional. If provided, returns only entities changed since this server knowledge value (delta request).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_TRANSACTIONS_BY_ACCOUNTTool to list transactions for a specific account. Use when you need all or delta-filtered transactions for a given account after confirming the budget and account ID.

Input Parameters

string ("uncategorized" | "unapproved")
If specified, only transactions of the specified type will be included. Use ‘uncategorized’ to get transactions without a category, or ‘unapproved’ to get transactions that have not been approved.
string
required
The ID of the budget. Use ‘default’ if default budget selection is enabled, or ‘last-used’ to specify the last used budget.
string
required
The ID of the account to retrieve transactions from (UUID format).
string
If specified, only transactions on or after this date will be included. The date should be ISO formatted (e.g., ‘2024-01-01’).
integer
The starting server knowledge value. If provided, only entities that have changed since this value will be included (delta request). Useful for syncing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_TRANSACTIONS_BY_CATEGORYTool to list transactions for a specific category (excludes pending). Use when you need completed transactions for a given category after obtaining budget_id and category_id. Response includes deleted transactions; filter client-side using the deleted boolean field.

Input Parameters

string ("uncategorized" | "unapproved")
Filter by transaction type; supported values: ‘uncategorized’, ‘unapproved’.
string
required
Budget identifier (UUID). Use ‘default’ if default budget selection is enabled, or ‘last-used’ to specify the last used budget.
string
Only include transactions on or after this ISO date (YYYY-MM-DD). No upper-bound parameter exists; apply client-side filtering for bounded date ranges.
string
required
Category identifier whose transactions are to be retrieved. Confirm the exact UUID before fetching; category names may be ambiguous due to similar labels or emoji.
integer
Delta-style filter; only return entities changed since this server knowledge index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_LIST_TRANSACTIONS_BY_PAYEETool to list transactions for a specific payee in a budget. Use when you need to fetch all non-pending transactions for a payee after confirming budget and payee IDs.

Input Parameters

string ("uncategorized" | "unapproved")
Optional filter by transaction type: ‘uncategorized’ or ‘unapproved’.
string
required
Payee identifier to filter transactions.
string
required
Budget identifier; use ‘default’ for the default budget if enabled for your OAuth app.
string
Optional ISO date (YYYY-MM-DD). Only include transactions on or after this date.
integer
Optional. If provided, returns only entities changed since this server knowledge value (delta request).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_CATEGORYUpdate a YNAB category’s name, group, note, or target settings.

Input Parameters

string
required
Plan UUID, ‘last-used’, or ‘default’.
object
required
Category fields to update.
string
required
UUID of the category to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_MONTH_CATEGORYSet a category’s assigned amount for one YNAB plan month.

Input Parameters

string
required
Plan month in YYYY-MM-DD format, or ‘current’.
string
required
Plan UUID, ‘last-used’, or ‘default’ when default plan selection is enabled.
integer
required
Assigned amount for the category in milliunits.
string
required
Identifier of the category to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_PAYEETool to update a payee. Use when you need to rename an existing payee.

Input Parameters

string
required
The new name for the payee.
string
required
The unique identifier (UUID) of the payee to update.
string
required
Budget identifier. Use ‘default’ if OAuth default budget selection is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_SCHEDULED_TRANSACTIONUpdate an existing scheduled transaction in YNAB. Allows modifying the date, frequency, amount, payee, category, memo, or account of a scheduled transaction. Use YNAB_LIST_SCHEDULED_TRANSACTIONS first to get the scheduled_transaction_id. Amounts should be in milliunits (negative for expenses, positive for income).

Input Parameters

string
required
Budget UUID or literal ‘last-used’/‘default’ to operate on
object
required
Fields of the scheduled transaction to update
string
required
Identifier of the scheduled transaction to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_TRANSACTIONUpdate fields on one existing ordinary YNAB transaction.

Input Parameters

string
required
Plan UUID, ‘last-used’, or ‘default’.
object
required
Fields to update on the transaction.
string
required
UUID of the transaction to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: YNAB_UPDATE_TRANSACTIONSUpdate multiple ordinary transactions by transaction ID or import ID.

Input Parameters

string
required
Plan UUID, ‘last-used’, or ‘default’.
array
required
Transaction patches to apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not