API Reference

Using the Clear Books Developer API

To send a request you must post an XML request to: 

https://secure.clearbooks.co.uk/api/soap/

The WSDL url for the SOAP interface is at:

https://secure.clearbooks.co.uk/api/wsdl/

The content type of the request must be text/xml. This can be done by setting the request HTTP header:

Content-Type: text/xml

The SOAP API currently supports the following actions:

Action Description
createEntity Creates a customer, supplier or both
createInvoice Creates an invoice
voidInvoice Voids a sent invoice
listInvoices Lists invoices
createPayment Creates a new payment
updateEntity Updates an existing customer, supplier or both
deleteEntity Deletes an existing customer, supplier or both
listEntities Lists customers and suppliers
listAccountCodes Lists account codes

If you would like additional functionality, please get in touch with us to suggest the features you would like and we will take them into consideration.

All requests require you to include an api key for your account, which you can view from Settings > Organisation.

To do this, include a SOAP header:

<env:Header>
	<cb:authenticate apiKey="yourApiKey" />
</env:Header>