MoneyBird API

The API of MoneyBird enables you to access the information inside a MoneyBird account. The API is RESTfull and uses XML for the data representation. On this page you can find all information about the API.

Don't hesitate to contact us with your questions on info@moneybird.nl. We strongly prefer to answer specific api questions via e-mail and kindly ask you not to call us. We answer most questions within a short timeframe during office hours.

Libraries

There are several libraries available to access the MoneyBird API in different programming languages:

• ActiveResource for Ruby
• MoneyBird API for PHP

Authentication

To connect to the MoneyBird API, you always use the subdomain of the MoneyBird account you want to access, for example https://company.moneybird.com. Make sure you always use https! If you use http, your request will be redirected (302 http status code) to the https location. There are two authorization methods for accessing information inside a MoneyBird account:

• HTTP Basic Authentication
  You should log in with an existing user, for which we advise you to create a seperate API user in your MoneyBird account. The authencation is estabilished with HTTP Basic Authentication. An URL inside the API looks like: https://api:password@company.moneybird.com.
• OAuth
  This technique has the advantage that you don't need to store the user credentials in your application, because the complete authentication is handled by OAuth. OAuth is mandatory for applications allowing many users to access the API. To start using OAuth, you should register your application inside MoneyBird. Inside your MoneyBird account, visit the url /oauth_clients/new to register your application and start using OAuth.

Requests

XML is used to represent the information coming from the API. Besides XML, you will receive HTTP response codes with information about your request. To start using the API, you should make clear to the API you are expecting an XML response. To accomplish this, you should change the Accept and Content-Type headers to the following:

Accept: application/xml
Content-Type: application/xml

The MoneyBird API uses HTTP Response Codes to inform you about the success or failure of your request. The following response status codes can be expected:

Rate limits

In order to provide our web users with the best service, we limit the number of API requests to our services to 350 requests/hour. Please make sure your implementation respects these limits. The X-RateLimit-Limit and X-RateLimit-Remaining HTTP response headers contain information about the limit you are bound to. When you exceed the limit you will receive a 403 HTTP response code.

Examples

There are several examples available to give you an idea about the power of the MoneyBird API.

ActiveResource examples (Ruby): Import contacts from CSV, Create invoice, Find contact by customer id.

Examples of the MoneyBird PHP API can be found on the Github wiki page.

Push API

In some cases it can be necessary to store information about invoices in MoneyBird in your own database. To allow easy synchronisation of the information in your database, it is possible to receive a HTTP push when the state of an invoice is changed in MoneyBird. The HTTP push is a regular HTTP POST request and contains the id of the invoice and the new state of the invoice. To enable push messages in a MoneyBird account, please contact us!

If you want to test a push message, the following CURL call simulates a push from the MoneyBird servers:

curl -X POST -d "invoice_id=1&state=paid" -H "MoneyBird (Push API)" http://yourwebsite.com/script_for_push.php