Getting Started

Getting Started #

Microbooks is a purely API based system that relies on JWT tokens to both authenticate and authorize registered users. To get access, sign up at microbooks.io: every plan starts with a free trial, and you can create API tokens from the dashboard straight away.

Not a developer?
You don’t need to write code to use Microbooks. Connect an AI assistant through the MCP server and follow Keeping your own books instead.

Quickstart #

Once registered, you can start off by following the quickstart guide that is tailored for as many languages as possible.

Missing Language
If we have missed creating a quickstart for your favourite language, feel free to send a request email to quickstarts@microbooks.io and we’ll try to create create one to help you and your favourite dev community get started with microbooks.

Conventions #

Before writing an integration, read the Conventions that every endpoint follows: the error envelope and its detail codes, dry runs, idempotency keys, pagination and filtering, rate limits, and the /meta endpoint that publishes all of them at run time.

How To Guides #

The Bookkeeping resources that are available on the microbooks platform are described in detail in the How To Guides. These provide a step by step instruction on how to create, manipulate and manage the models and entities so as to accomplish Bookkeeping goals.

Cookbooks #

When developing a non-trivial integration or application, often you will encounter scenarios that are common accross jurisdictions. With cookbook section, we attempt to provide examples of how to solve several cases using the service.

Corner Cases
By the way, if you have a scenario that is not covered by the How To Guides, drop us an email at corner.case@microbooks.io and we’ll create it just for you!

API Reference #

For the most comprehensive documentation of all the API endpoints, parameters, requests and responses, take a look at the API Reference.