YNAB API Ruby Library

This is the Ruby client for the YNAB API.

Please read the YNAB API documentation for an overview of using the API and a complete list of available resources.

This client is generated using the OpenAPI Generator.

Installation

gem install ynab

Note: The current version of this gem requires Ruby version 3.3 or later. If you are using an older version of Ruby, you can install version 2.1 of this gem.

Usage

To use this client you must obtain an access token from your Account Settings page of the YNAB web app.

require 'ynab'

access_token = ENV['YNAB_ACCESS_TOKEN']
ynab_api = YNAB::API.new(access_token)

plan_response = ynab_api.plans.get_plans
plans = plan_response.data.budgets

plans.each do |plan|
  puts "Plan Name: #{plan.name}"
end

Examples

See the examples folder for example usage scenarios.

Methods

The following methods are available in this library.

	Method	Description
User	user.get_user()	Returns authenticated user information
Plans	plans.get_plans()	Returns plans list with summary information
	plans.get_plan_by_id(plan_id)	Returns a single plan with all related entities
	plans.get_plan_settings_by_id(plan_id)	Returns settings for a plan
Accounts	accounts.get_accounts(plan_id)	Returns all accounts
	accounts.get_account_by_id(plan_id, account_id)	Returns a single account
	accounts.create_account(plan_id, data)	Creates a new account
Categories	categories.get_categories(plan_id)	Returns all categories grouped by category group
	categories.get_category_by_id(plan_id, category_id)	Returns a single category
	categories.get_month_category_by_id(plan_id, month, category_id)	Returns a single category for a specific plan month
	categories.create_category(plan_id, data)	Creates a new category
	categories.create_category_group(plan_id, data)	Creates a new category group
	categories.update_category(plan_id, category_id, data)	Updates a category
	categories.update_category_group(plan_id, category_group_id, data)	Updates a category group
	categories.update_month_category(plan_id, month, category_id, data)	Updates a category for a specific month
Payees	payees.get_payees(plan_id)	Returns all payees
	payees.get_payee_by_id(plan_id, payee_id)	Returns a single payee
	payees.update_payee(plan_id, payee_id, data)	Updates a payee
Payee Locations	payee_locations.get_payee_locations(plan_id)	Returns all payee locations
	payee_locations.get_payee_location_by_id(plan_id, payee_location_id)	Returns a single payee location
	payee_locations.get_payee_locations_by_payee(plan_id, payee_id)	Returns all payee locations for the specified payee
Months	months.get_plan_months(plan_id)	Returns all plan months
	months.get_plan_month(plan_id, month)	Returns a single plan month
Money Movements	money_movements.get_money_movements(plan_id)	Returns all money movements
	money_movements.get_money_movements_by_month(plan_id, month)	Returns all money movements for a specific month
	money_movements.get_money_movement_groups(plan_id)	Returns all money movement groups
	money_movements.get_money_movement_groups_by_month(plan_id, month)	Returns all money movement groups for a specific month
Transactions	transactions.get_transactions(plan_id)	Returns plan transactions
	transactions.get_transactions_by_account(plan_id, account_id)	Returns all transactions for a specified account
	transactions.get_transactions_by_category(plan_id, category_id)	Returns all transactions for a specified category
	transactions.get_transactions_by_payee(plan_id, payee_id)	Returns all transactions for a specified payee
	transactions.get_transactions_by_month(plan_id, month)	Returns all transactions for a specified month
	transactions.get_transaction_by_id(plan_id, transaction_id)	Returns a single transaction
	transactions.create_transaction(plan_id, data)	Creates a single transaction or multiple transactions
	transactions.update_transaction(plan_id, transaction_id, data)	Updates a single transaction
	transactions.update_transactions(plan_id, data)	Updates multiple transactions
	transactions.delete_transaction(plan_id, transaction_id)	Deletes a single transaction
	transactions.import_transactions(plan_id)	Imports transactions
Scheduled Transactions	scheduled_transactions.get_scheduled_transactions(plan_id)	Returns all scheduled transactions
	scheduled_transactions.get_scheduled_transaction_by_id(plan_id, scheduled_transaction_id)	Returns a single scheduled transaction
	scheduled_transactions.create_scheduled_transaction(plan_id, data)	Creates a single scheduled transaction
	scheduled_transactions.update_scheduled_transaction(plan_id, scheduled_transaction_id, data)	Updates a single scheduled transaction
	scheduled_transactions.delete_scheduled_transaction(plan_id, scheduled_transaction_id)	Deletes a single scheduled transaction

Versioning

The version of this client is defined in the ynab.gemspec file and follows semantic versioning. The version of this client is maintained independently and does not align with the the version of YNAB API itself (which is defined in the OpenAPI spec). To determine which spec version of the YNAB API was used when generating this client you can refer to the "description" in the field in the ynab.gemspec file.

License

Copyright (c) 2024 YNAB

Licensed under the Apache-2.0 license