https://github.com/tim-smart/ynab-api-importer

Syncs the last 7 days of bank transactions into YNAB
https://github.com/tim-smart/ynab-api-importer

bnz ynab ynab-api

Last synced: 10 days ago
JSON representation

Syncs the last 7 days of bank transactions into YNAB

• Host: GitHub
• URL: https://github.com/tim-smart/ynab-api-importer
• Owner: tim-smart
• Created: 2018-11-08T02:54:59.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-07T22:04:58.000Z (about 1 year ago)
• Last Synced: 2024-10-11T15:22:27.092Z (26 days ago)
• Topics: bnz, ynab, ynab-api
• Language: TypeScript
• Homepage:
• Size: 214 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# ynab-api-importer

A lot of international banks are unsupported by YNAB's direct feed feature. So

here is yet another YNAB API importer.

To make this useful you will need some technical knowledge. It is recommended

that you run this as a cron job everyday to make sure YNAB is always up-to-date.

Current the following adapters are implemented:

- BNZ (Bank of New Zealand)

## Installation

```

npm i -g ynab-api-importer

```

## Configuration

Copy `config.example.js` to `config.js` and change to your liking.

Then run:

```

ynab-importer config.js

```

## For developers

If you would like to create your own adapter, take a look at `src/banks/bnz.ts`.

You need to implement a `TBankAdapter` function and make it the default export

of your NPM module.

Users can then register it using the `registerAdapters` config option (see

`config.example.js`).

In your `peerDependencies` include `ynab-api-importer` and `ynab`;

For example:

```typescript

import { Page } from "puppeteer";

import {

  Adapters,

  Ynab,

  setupPage,

} from "ynab-api-importer";

import { SaveTransaction } from "ynab";

const export = (page: Page) => async (

  accountID: string,

  ynabAccountID: string,

): Promise => {

  // Add your implmentation here

  // This will be run once for every account

  // It needs to return an array of YNAB transactions

  const ofxString = await doSomethingWith(page);

  const transactions = await Ynab.ofxToSaveTransactions(

    ofxString,

    ynabAccountID,

  );

  return transactions;

}

const fancyBankAdapter: Adapters.TBankAdapter = async (options: any) =>{

  // You can login here, setup puppeteer etc.

  const { browser, page } = await setupPage();

  // Return two functions. First one exports the transactions. Second one does

  // cleanup.

  return [export(page), () => browser.close()];

}

export default fancyBankAdapter;

```