> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clear Books

> How to set up the Clear Books connector, plus the actions that are available.

![Clear Books](https://stackone-logos.com/api/clearbooks/filled/svg)

v1.0.0[See changelog](https://docs.stackone.com/connectors/clearbooks/changelog.md)

[44 actions](#actions) · 1 auth method

Accounting

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/clearbooks/guides/connector-profile/oauth-2-0.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/clearbooks/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounting.account\_codes:read

accounting.account\_codes:write

accounting.allocations:read

accounting.allocations:write

accounting.bank\_accounts:read

accounting.bank\_accounts:write

accounting.customers:read

accounting.customers:write

accounting.payments:read

accounting.payments:write

accounting.purchases:read

accounting.purchases:write

accounting.sales:read

accounting.sales:write

accounting.suppliers:read

accounting.suppliers:write

accounting.vat:read

businesses:read

businesses:write

No scopes found

44 actions

ActionDescriptionRequired scopes

List Account Codes`clearbooks_list_account_codes`

List all account codes for a business.

`accounting.account_codes:read`

Create Account Code`clearbooks_create_account_code`

Create an account code for a business.

`accounting.account_codes:write`

Get Account Code`clearbooks_get_account_code`

Retrieve a single account code.

`accounting.account_codes:read`

Update Account Code`clearbooks_update_account_code`

Update the details of an existing account code.

`accounting.account_codes:write`

Delete Account Code`clearbooks_delete_account_code`

Permanently remove an account code from the business.

`accounting.account_codes:write`

List Allocations`clearbooks_list_allocations`

List payment and credit-note allocations for sales or purchases.

`accounting.allocations:read`

Create Allocation`clearbooks_create_allocation`

Allocate a payment or credit note against an invoice.

`accounting.allocations:write`

Get Allocation`clearbooks_get_allocation`

Retrieve a single allocation by its identifier.

`accounting.allocations:read`

Delete Allocation`clearbooks_delete_allocation`

Remove an allocation between a payment or credit note and an invoice.

`accounting.allocations:write`

List Bank Accounts`clearbooks_list_bank_accounts`

List all bank accounts configured for a business.

`accounting.bank_accounts:read`

Create Bank Account`clearbooks_create_bank_account`

Create a new bank account within a business.

`accounting.bank_accounts:write`

Get Bank Account`clearbooks_get_bank_account`

Retrieve a single bank account by its identifier.

`accounting.bank_accounts:read`

Update Bank Account`clearbooks_update_bank_account`

Update the details of an existing bank account.

`accounting.bank_accounts:write`

Delete Bank Account`clearbooks_delete_bank_account`

Permanently remove a bank account from the business.

`accounting.bank_accounts:write`

List Businesses`clearbooks_list_businesses`

List all businesses the authenticated user can access.

`businesses:read`

Get Business`clearbooks_get_business`

Retrieve a single business by its identifier.

`businesses:read`

Update Business`clearbooks_update_business`

Update the details of an existing business.

`businesses:write`

List Customers`clearbooks_list_customers`

List all customers belonging to a business.

`accounting.customers:read`

Create Customer`clearbooks_create_customer`

Create a new customer record in a business.

`accounting.customers:write`

Get Customer`clearbooks_get_customer`

Retrieve a single customer by its identifier.

`accounting.customers:read`

Update Customer`clearbooks_update_customer`

Update the details of an existing customer.

`accounting.customers:write`

Delete Customer`clearbooks_delete_customer`

Permanently remove a customer from the business.

`accounting.customers:write`

List Payments`clearbooks_list_payments`

List all payments recorded for a business.

`accounting.payments:read`

Create Payment`clearbooks_create_payment`

Record a new payment against a contact.

`accounting.payments:write`

Get Payment`clearbooks_get_payment`

Retrieve a single payment by its identifier.

`accounting.payments:read`

Update Payment`clearbooks_update_payment`

Update the details of an existing payment.

`accounting.payments:write`

Delete Payment`clearbooks_delete_payment`

Permanently remove a payment from the business.

`accounting.payments:write`

List Purchase Documents`clearbooks_list_purchases_by_type`

List purchase documents of a given type for a business.

`accounting.purchases:read`

Create Purchase Document`clearbooks_create_purchase`

Create a purchase document of the given type.

`accounting.purchases:write`

Get Purchase Document`clearbooks_get_purchase_document`

Retrieve a single purchase document by its identifier.

`accounting.purchases:read`

Update Purchase Document`clearbooks_update_purchase_document`

Update an existing purchase document.

`accounting.purchases:write`

Delete Purchase Document`clearbooks_delete_purchase_document`

Permanently remove a purchase document from the business.

`accounting.purchases:write`

List Sales Documents`clearbooks_list_sales_by_type`

List sales documents of a given type for a business.

`accounting.sales:read`

Create Sales Document`clearbooks_create_sales`

Create a sales document of the given type.

`accounting.sales:write`

Get Sales Document`clearbooks_get_sales_document`

Retrieve a single sales document by its identifier.

`accounting.sales:read`

Update Sales Document`clearbooks_update_sales_document`

Update an existing sales document.

`accounting.sales:write`

Delete Sales Document`clearbooks_delete_sales_document`

Permanently remove a sales document from the business.

`accounting.sales:write`

List Suppliers`clearbooks_list_suppliers`

List all suppliers belonging to a business.

`accounting.suppliers:read`

Create Supplier`clearbooks_create_supplier`

Create a new supplier record in a business.

`accounting.suppliers:write`

Get Supplier`clearbooks_get_supplier`

Retrieve a single supplier by its identifier.

`accounting.suppliers:read`

Update Supplier`clearbooks_update_supplier`

Update the details of an existing supplier.

`accounting.suppliers:write`

Delete Supplier`clearbooks_delete_supplier`

Permanently remove a supplier from the business.

`accounting.suppliers:write`

List VAT Treatments`clearbooks_list_vat_treatments`

List the available VAT treatments for sales or purchases.

`accounting.vat:read`

List VAT Rates`clearbooks_list_vat_rates`

List the available VAT rates for sales or purchases.

`accounting.vat:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.