Skip to main content
Clear Books
Previewv0.1.0
44 actions · 1 auth method

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0

Requires registering a confidential OAuth application in the Clear Books developer portal, which can only be accessed on…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
44 actions
Action
Description
Required scopes
List Account Codes
List all account codes for a business.
Create Account Code
Create an account code for a business.
Get Account Code
Retrieve a single account code.
Update Account Code
Update the details of an existing account code.
Delete Account Code
Permanently remove an account code from the business.
List Allocations
List payment and credit-note allocations for sales or purchases.
Create Allocation
Allocate a payment or credit note against an invoice.
Get Allocation
Retrieve a single allocation by its identifier.
Delete Allocation
Remove an allocation between a payment or credit note and an invoice.
List Bank Accounts
List all bank accounts configured for a business.
Create Bank Account
Create a new bank account within a business.
Get Bank Account
Retrieve a single bank account by its identifier.
Update Bank Account
Update the details of an existing bank account.
Delete Bank Account
Permanently remove a bank account from the business.
List Businesses
List all businesses the authenticated user can access.
Get Business
Retrieve a single business by its identifier.
Update Business
Update the details of an existing business.
List Customers
List all customers belonging to a business.
Create Customer
Create a new customer record in a business.
Get Customer
Retrieve a single customer by its identifier.
Update Customer
Update the details of an existing customer.
Delete Customer
Permanently remove a customer from the business.
List Payments
List all payments recorded for a business.
Create Payment
Record a new payment against a contact.
Get Payment
Retrieve a single payment by its identifier.
Update Payment
Update the details of an existing payment.
Delete Payment
Permanently remove a payment from the business.
List Purchase Documents
List purchase documents of a given type for a business.
Create Purchase Document
Create a purchase document of the given type.
Get Purchase Document
Retrieve a single purchase document by its identifier.
Update Purchase Document
Update an existing purchase document.
Delete Purchase Document
Permanently remove a purchase document from the business.
List Sales Documents
List sales documents of a given type for a business.
Create Sales Document
Create a sales document of the given type.
Get Sales Document
Retrieve a single sales document by its identifier.
Update Sales Document
Update an existing sales document.
Delete Sales Document
Permanently remove a sales document from the business.
List Suppliers
List all suppliers belonging to a business.
Create Supplier
Create a new supplier record in a business.
Get Supplier
Retrieve a single supplier by its identifier.
Update Supplier
Update the details of an existing supplier.
Delete Supplier
Permanently remove a supplier from the business.
List VAT Treatments
List the available VAT treatments for sales or purchases.
List VAT Rates
List the available VAT rates for sales or purchases.