Integration Store & Connectors
      Back to home
      1. Help Center
      2. Automation and Integrations
      3. Integration Store & Connectors

      ClearBooks Connector

      Step by step guide to set up your ClearBooks connector.

      Overview

      ClearBooks, puts you in control of invoicing by making it easy to create and send branded invoices.

      With this connector, Buyers and Suppliers using ClearBooks can send and receive invoices and credit notes automatically in the system.


      Connector details

      Name

      ClearBooks

      Category

      Accounting

      Availability

      Trade Enterprise

      Document format

      JSON

      Document types

      Invoice, Credit Note

      Connection method

      API


      Version history

      1.0.0

      Initial release

      Triggers

      Scheduled

      Runs on a specified time interval

      Actions

      Get Invoices

      Send/Receive invoices and credit notes from your accounting system into the ShipServ platform.

       

      Once in the ShipServ platform, you and your Buyers will be able to access them through Trade and download using integration via the Invoicing API.


      Configurations

      Connector Name

      Set a friendly name for your connector.

      ClearBooks

      Select your ClearBooks account.

      Schedule

      Set the time interval.

      Action

      Select if the connector should:

      • Upload - for suppliers to send invoice and credit notes.

      • Download - for buyers to receive invoices and credit notes.

      TNID

      ShipServ TradeNet ID that will connect to ClearBooks.

      Trade Username 

      Enter your Trade user that will be used for the connector.

      Trade Password

      Enter your Trade password.

      How does it work?

      The integration between your accounting system and the ShipServ platform is done by an integration connector.

      A connector is a cloud service that runs within the ShipServ platform. When configured, it will run based on the specified Trigger and perform the selected Action. To see the list of supported Triggers and Actions, please check out the tables below.

      To perform the selected Action, the connector will need to have access to your accounting system which you or your IT Administrator must Authorize.

      Figure 1.0 Integration high-level diagram


      How to’s

      Setup

      Configuring an integration connector is a straightforward and can be easily done by following the steps shown below:

      1. Log in to Trade using your administrator account.

      2. Navigate to "Apps and Automation" > Integrations

        Image 1. Open integration store

      3. In the "Integrations" tab, choose chose "ClearBooks" connector..

        Image 2. ClearBooks connector

      4. Click to configure, fill-in the required information and save.

        Image 3. Configure connection

      5. Your newly created integration will show up under "My Integrations" tab. Click the "Start" button to start.

        Image 4. View all integrations

      Start, Pause or Delete

      Control whether you want the connectors to run or pause the connectors if needed by using the Start/Pause buttons.

      • To Start a connector, click the Start button.

      • To Pause a connector, click the Stop button.

      • To Remove a connector, click the Delete button.

         

      Image 11. Start, Stop or Delete a connection

      View Logs

      Go to My Integrations > Click on Details > Click on the Logs tab

      Image 12. Logs Tab