Skip to main content

​
Prerequisites

Clear Books requires multi-factor authentication to be enabled on your account before you can open the developer portal. Complete this one-time setup before creating an OAuth application.

1

Sign in to Clear Books

Sign in to your Clear Books account.

  • Enter your Email and click Continue, then enter your password.
  • The developer portal is only available to the account owner or a user with access to the business.
The Clear Books Log in screen with the Email field and Continue button
2

Open your account menu

Clear Books requires multi-factor authentication before you can open the developer portal. Click the account icon in the top-right corner of any page, then select Security.

The account menu open with the Security link highlighted
3

Enable multi-factor authentication

On the Security page, select Multi-factor authentication, and make sure Authenticator app is enabled.

  • If it is not already enabled, expand Authenticator app, scan the QR code with an authenticator app, and enter the generated code to turn it on.
  • Without multi-factor authentication, Clear Books blocks access to the developer portal.
The Security page with Multi-factor authentication selected and Authenticator app enabled

​
Create an OAuth application

Clear Books uses OAuth 2.0. You create a confidential OAuth application in the Clear Books developer portal to obtain a Client ID and Client Secret, then paste them into the StackOne Connector profile.

1

Create a new app

Open the Clear Books developer portal and, on the My apps page, click New app.

The My apps page in the developer portal with the New app button highlighted
2

Enter the app details

Complete the App details form, set the Redirect URL, and click Save.

  • App name — a name for the application, such as StackOne Integration.
  • App description — a short description of the integration.
  • Responsible company or individual name and Contact email address — your company name and a contact email.
  • Set the Redirect URL to the Callback URL from your Connector Profile.
  • Only confidential clients using the authorization code grant are supported.
The New app form with the Redirect URL field and Save button highlighted
3

Copy your Client ID and Client Secret

After you save, Clear Books displays your Client ID and Client secret. Copy both and paste them into the Client ID and Client Secret fields in the StackOne Connector profile.

  • The Client secret is only displayed once and cannot be retrieved later, so store it securely for use later.
  • You can find the Client ID again later on the app’s Manage app page.
The developer portal banner shown after saving, with the Client ID and Client secret masked
4

Regenerate the client secret

If you lose the Client Secret, open the app’s Manage app page and click Regenerate client secret to generate a new one.

  • Regenerating the secret causes all token exchange and refresh attempts to fail until you update the connection with the new secret.
The Client secret section of the Manage app page with Regenerate client secret highlighted

​
Permissions

When you connect, StackOne requests the Clear Books permissions its actions need. You can narrow this set using the optional Scopes field in the StackOne Connector profile; leave it blank to request the full set below.

1

Grant the required permissions

Enables actions: Create Account Code, Create Allocation, Create Bank Account, Create Customer, Create Payment, Create Purchase Document, Create Sales Document, Create Supplier, Delete Account Code, Delete Allocation, Delete Bank Account, Delete Customer, Delete Payment, Delete Purchase Document, Delete Sales Document, Delete Supplier, Get Account Code, Get Allocation, Get Bank Account, Get Business, Get Customer, Get Payment, Get Purchase Document, Get Sales Document, Get Supplier, List Account Codes, List Allocations, List Bank Accounts, List Businesses, List Customers, List Payments, List Purchase Documents, List Sales Documents, List Suppliers, List VAT Rates, List VAT Treatments, Update Account Code, Update Bank Account, Update Business, Update Customer, Update Payment, Update Purchase Document, Update Sales Document, Update Supplier

Authorize the following permissions so the connector can read and write account codes, allocations, bank accounts, businesses, customers, payments, purchase documents, sales documents, suppliers, and VAT reference data.

​
Create the StackOne Connector Profile

1

Create a Connector Profile

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
2

Link an Account

Once the Connector Profile is created, continue to link an account.