wallet-budgetbakers-import

4.2.1 • Public • Published

Node.js module to import a CSV file with transactions to BudgetBakers' Wallet.

Installation

Install the package using npm:

npm install wallet-budgetbakers-import

After installing, import it into your project:

import wallet from 'wallet-budgetbakers-import';

Example

Importing a CSV file:

import wallet from 'wallet-budgetbakers-import';
try {
    await wallet.login('your-email@provider.com', 'YourPassword123456');
    const result = await wallet.importFile({
        file: 'path/to/file/2022-03-20T16-20.csv',
        email: 'account-email@imports.budgetbakers.com'  
    });   
    console.log(result);    
} catch(err) {
    console.error(err);
}

Methods

login

Logs in with the provided credentials.

wallet.login('your-email@provider.com', 'YourPassword123456');

getImports

Retrieves an array of imported files.

wallet.getImports('-Account_00000000-0000-0000-0000-000000000000');

By providing an account identification, the result will be filtered accordingly. The id can be found in the URL, when navigating to the account detail, in Wallet's web app.

importFile

Imports an CSV file.

wallet.importFile({
    file: 'path/to/file/2022-03-20T16-20.csv',
    email: 'account-email@imports.budgetbakers.com',
    accountId: '-Account_00000000-0000-0000-0000-000000000000',
    newRecordsOnly: false
}); 
Property Definition
file Path to the file to import
email Account's import e-mail. You can find it in your account's settings
accountId Optional; specifies to which account the transactions will be imported
newRecordsOnly Defaults to true; only new transactions will be imported. For it to work properly, make sure your file's name has the YYYY-MM-DDTHH-MM format, for example: 2022-03-20T16-20

File with transactions must have the following format (date in ISO 8601):

date,note,amount,expense
2023-03-15T10:30:00.000Z,Supermarket,0,1.99
2023-03-07T15:00:00.000Z,Income,200.00,0

Package Sidebar

Install

npm i wallet-budgetbakers-import

Weekly Downloads

10

Version

4.2.1

License

MIT

Unpacked Size

12.9 kB

Total Files

5

Last publish

Collaborators

  • josecoelhomelo