ynab

YNAB component for Home Assistant
This component will retreieve the following data from your YNAB budget

To be budgeted amount
Current month's budgeted amount
Current month's remaining balance of any specified category
Number of transactions needing approval
Number of unclearaed transactions
Number of overspent categories

To keep api usage low, the sensor updates every 5 minutes.

Installation

HACS

Open HACS > Settings
In ADD CUSTOM REPOSITORY box paste this git's URL https://github.com/wxt9861/ynab and select type Integration
Click INSTALL
Make necessary modifications to your configuration.yaml
Restart Home Assistant

Manual install

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called ynab.
Download all the files from the custom_components/ynab/ directory (folder) in this repository.
Place the files you downloaded in the new directory (folder) you created.
Add ynab: to your HA configuration (see examples below)
Restart Home Assistant

Configuration options

Key	Type	Required	Default	Description
`api_key`	`string`	`True`	None	YNAB API key (see insturctions below)
`name`	`string`	False	sensor.ynab	Custom name for the sensor
`budget`	`string`	False	last-used	Budget ID to use if you have multiple budgets. If none specified, your last used budget will be used
`currency`	`string`	False	$	Currency to use as unit of measurement
`categories`	`list`	False	None	List of YNAB categories to include in the sensor. These are CASE SENSATIVE

Example default configuration.yaml

ynab:
  api_key: <api_key_here>

Example: configuration.yaml with options

ynab:
  api_key: <api_key_here>
  name: "My YNAB Budget"
  budget: <budget_id_here>
  currency: "$"
  categories:
    - "HASS Budget"
    - "Vacation Budget"

To enable debug

logger:
  logs:
    custom_components.ynab: debug

Generate YNAB API key / Get budget ID

API:

Log on to YNAB
Go to My Budget > My Account > Developer Settings
Click on New Token
Enter your password and click Generate
Copy the token that appears at the top of the page

Bidget ID:
The budget ID is the combination between the slahses after the URL https://app.youneedabudget.com If you only have one budget, you can leave the budget option at default, if you have multiple budgets pick a budget you want the sensor to report on. At this time data from only 1 budget is retrieved.

nikking / ynab