Support · API

Build on Clear Books with our API.

Our API lets third-party applications exchange information with Clear Books, so you can connect your account to the rest of your stack and automate the steps you'd rather not do by hand.

What you can do

Automate the everyday, straight from your systems.

The most commonly used Clear Books functions are available through the API.

Invoices

  • Add sales and purchase invoices
  • Void added invoices

Payments

  • Record payments
  • Allocate payments to invoices

Customers & suppliers

  • Add customers and suppliers
  • Update their information
  • Delete customers and suppliers

Need something that isn't listed here? Get in touch and we'll be happy to talk it through.

Choosing an API

Two APIs, one recommendation.

Recommended · current

RESTful API

The modern service for accessing Clear Books via API. It's available via our self-service developer portal, with developer documentation covering the endpoints and examples you need to get started.

Legacy · discontinued

SOAP API: the SOAP API has been discontinued and no new applications will be approved for it. If you have an existing integration and need the documentation or code examples, please get in touch and we'll help.

Getting started

Up and running in three steps.

1

Secure your account

Sign up for a trial if you don't already have an account, and switch on multi-factor authentication (which is mandatory for developers).

2

Get your API credentials

Head to the developer portal to register your application and generate your API keys.

3

Build your integration

Explore the developer documentation and start pushing invoices, recording payments and managing customers straight from your own systems.

Common questions

API questions, answered.

How do I get access to the API?
The RESTful API is now available through our self-service developer portal. If you don't have an account, sign up for a trial first and ensure you switch on multi-factor authentication.
Where can I find the API documentation?
Developer documentation for the RESTful API is available at api-docs.clearbooks.co.uk.
What can the API do?
You can add sales and purchase invoices, void invoices, record payments and allocate them to invoices, and add, update or delete customers and suppliers. The most commonly used Clear Books functions are available.
Do you still support the SOAP API?
The SOAP API has been discontinued and no new applications will be approved for it. If you have an existing integration and need the documentation or code examples, please get in touch and we'll help.
Can the API do something that isn't listed?
The most commonly used Clear Books functions are available via the API. If you need something else, get in touch and we'll be happy to discuss it.
For developers

Ready to build on Clear Books?

Access the developer portal to get your API keys and connect Clear Books to the tools you already use.