Module ynab

ballerinax/ynab Ballerina library

2.0.0

Overview

YNAB (You Need A Budget) is a personal budgeting platform built around giving every dollar a job. This connector wraps version 1.87.0 of the YNAB REST API and lets Ballerina applications read and manage budget plans, accounts, categories, payees, months, money movements, transactions and scheduled transactions.

Key features

  • Read plans and plan settings, with delta requests based on server knowledge
  • Manage accounts, categories and category groups, including monthly category budgets
  • Create, update, import and delete transactions and scheduled transactions
  • Browse payees and payee locations, and create or rename payees
  • Review monthly budget summaries and money movements

Setup guide

To use the connector you need a YNAB account and a personal access token.

  1. Sign in to YNAB.
  2. Open Account Settings and go to Developer Settings.
  3. Under Personal Access Tokens, choose New Token, enter your password and copy the generated token. It is shown only once.

Quickstart

To use the ynab connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Copy
import ballerinax/ynab;

Step 2: Instantiate a new connector

Create a Config.toml file with your access token:

Copy
accessToken = "<your-personal-access-token>"

Then create a client in your .bal file:

Copy
configurable string accessToken = ?;

final ynab:Client ynabClient = check new ({
    auth: {
        token: accessToken
    }
});

Step 3: Invoke the connector operation

Copy
public function main() returns error? {
    ynab:PlanSummaryResponse _ = check ynabClient->getPlans();
}

Step 4: Run the Ballerina application

Copy
bal run

Examples

The YNAB connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Import

import ballerinax/ynab;Copy

Other versions

See more...

Metadata

Released date: about 15 hours ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-20 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 35

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/YNAB

Area/Finance & Accounting

Type/Connector

YNAB


Contributors