node-moneybird

A promise based API wrapper for Moneybird.com in Node

Install

npm install moneybird --save

What do I need?

To make these calls work you'll have to obtain a token and the administrationId. The administrationId can be found browsing on moneybird.com being logged in, the first numeric value in the URL is your administrationId. Take note to not use this as a numeric value within JS as it exceeds the JS integer value.

Obtain a moneybird token

To obtain a moneybird token go to https://moneybird.com/user/applications/new and choose "Personal use". The next page will provide you with the token, please store the token in a secure manner.

What about the OAuth flow?

There are plenty of packages available or you probably already use some if you're doing OAuth anyway. Currently there is no reason to rebuild something existing that doesn't really fit the main purpose: easy & fast promise based API communication. The accesstoken resulting from a proper OAuth flow can already be used with this wrapper (TOKEN in the example code).

Example create contact

import { Client } from 'moneybird'

const moneyBirdClient = new Client('TOKEN', 'ADMINISTRATION_ID');
moneyBirdClient.post('contacts', {
  'contact': {
    'company_name': 'DualDev'
  }
}).then(res => {
  console.log('created!', res);
}).catch(err => {
  console.log('Whoops, something went wrong!', err);
});

Example create contact with fields error

import { Client } from 'moneybird'

const moneyBirdClient = new Client('TOKEN', 'ADMINISTRATION_ID');
moneyBirdClient.post('contacts', {
  'contact': { }
}).then(res => {
  console.log('created!', res);
}).catch(err => {
  console.log('Whoops, something went wrong!', err);
  if (err.message === 'invalid body') {
    console.log(JSON.stringify(err.fields, 4, '  '));
  }
});

Example get contacts

import { Client } from 'moneybird'

const moneyBirdClient = new Client('TOKEN', 'ADMINISTRATION_ID');
moneyBirdClient.get('contacts').then(res => {
  console.log('all contacts', res);
}).catch(err => {
  console.log('Whoops, something went wrong!', err);
});

Example get contacts with additional query

import { Client } from 'moneybird'

const moneyBirdClient = new Client('TOKEN', 'ADMINISTRATION_ID');
moneyBirdClient.get('contacts', {}, {
  'query': 'company_name'
}).then(res => {
  console.log('all contacts', res);
}).catch(err => {
  console.log('Whoops, something went wrong!', err);
});

How do I make other calls?

This promise based API wrapper is not call-specific, allowing it to be more flexible to future API changes. The following methods are available for use.

API

Client(Token, AdministrationId, [version=v2])

.get('resource_path')

.put('resource_path', body)

.patch('resource_path', body)

.create('resource_path', body)

.delete('resource_path')

Does this package depends upon other packages?

No, this package doesn't use any dependencies besides dev-dependencies for testing and building.