Set up the QuickBooks Online integration

Explore our API integration with QuickBooks Online.

Video walkthrough:


Before you can access data from customers who use QuickBooks Online for their accounting, you need to set up the QuickBooks Online integration.

You'll need to:

  1. Create an app in the Intuit Developer Portal.
  2. Before production use, you need to enter some details about your app and complete the App Assessment Questionnaire provided by Intuit. For help, see QBO app assessment questionnaire in the Codat Support portal.
  3. Intuit reviews your questionnaire to ensure your app meets their platform requirements.
  4. If your app is approved, you can access its production keys for use with the production integration.
  5. Add your secure keys to Codat.

🚧

App keys

Your app development keys and production keys are not interchangeable. Development keys do not work with live QuickBooks Online accounts.

Before you begin, make sure you understand the different QuickBooks Online environments.

QuickBooks Online environments

QuickBooks Online provides two separate environments:

  • A sandbox company containing sample data for development and testing purposes. You automatically get one when you create a QBO developer account. See Create and test with a sandbox company in Intuit developer.
  • A live QuickBooks account (including free trials).

Sandbox companies can only connect to a QuickBooks Online app using the app's development keys. Live accounts can only connect to a QuickBooks Online app using the app's production keys.

To support these environments, you'll find two separate integrations in the Codat Portal:

  • QuickBooks Online Sandbox: for development and testing.
  • QuickBooks Online: for production use.

This page explains how to configure both integrations.

Create a QuickBooks Online app configured for sandbox

Create and register a QuickBooks Online app in the Intuit Developer Portal and configure it for use with the sandbox integration. The app has two sets of keys: development and production. You access the development keys in the Development Settings section of your Dashboard.

Perform these steps in the Intuit Developer Portal.

  1. Select Dashboard from the top navigation bar.
  2. Click Create an app.
  3. Click QuickBooks Online and Payments then enter your app name.
  4. Under Select a scope, select com.intuit.quickbooks.accounting.
  5. Click Create app.
  6. Configure the application to connect to the sandbox integration:
    1. In the left menu, select Development Settings > Keys & credentials.
    2. In the Redirect URIs section, click Add URI.
    3. In the top Link box, enter the Codat Sandbox URI: https://quickbooksonlinesandbox.codat.io/oauth2/callback
  7. Click Save.
  8. Your development keys are displayed in the Keys section at the top of the page (the Client Id and Client Secret).

Next, add your development keys to the QuickBooks Online Sandbox integration, as described in Add your secure keys to Codat.

Alternatively, get your app's production keys as explained in the next procedure.

Get production keys and configure app for production

Before you can access your app's production keys, you must complete the requirements described in this procedure. You can reuse the app you created in the above procedure.

When the production keys are available, configure the app for use with the production integration.

Perform these steps in the Intuit Developer Portal.

  1. In the left menu, select Production Settings > Keys & credentials.
    The Get your app's production keys page is displayed.
  2. Provide the information requested in the Add details about your app checklist:
867867

📘

Help with the app details checklist

Provide the following information:

  • Host domain: URL of the domain host of your website or app.
  • Launch URL: Initial URL for your app's authorization flow. If using no-code Link, provide the generic Link URL, which you can access in the Codat Portal.
  • Disconnect URL: Link to the process for deauthorizing your app's access to QuickBooks Online. You can provide the URL of the Disconnect a data source from a company endpoint. If you don't have a disconnect URL, provide a link to your website or app instead.

For app hosting details, see QBO app hosting in the Codat Support Portal.

  1. Complete the App Assessment Questionnaire as described below.

  2. When you've completed all the requirements and your questionnaire responses have been approved by Intuit, the page updates to display the production keys for your app (the Client Id and Client Secret).

  3. In Production Settings > Keys & credentials, configure your application to connect to Codat:

    1. In the Redirect URIs section, click Add URI.
    2. In the top Link box, enter the Codat Production URI: https://quickbooksonline.codat.io/oauth2/callback
  4. Click Save.

Next, add your production keys to the QuickBooks Online integration, as described in Add your secure keys to Codat, below.

Completing the App Assessment Questionnaire

Before you can access your app's production keys, you must complete an App Assessment Questionnaire. Intuit will review your answers to make sure your app meets their publishing requirements and guidelines.

As a Codat client, you will be automatically linked to a shortened version of the App Assessment Questionnaire. Existing users should have received an email from Intuit with a link to the questionnaire. For recommended answers to the questions pertaining to Codat, see QBO App Assessment Questionnaire in the Codat Support Portal.

To access the questionnaire from the Intuit Developer Portal:

  1. Select Dashboard from the top navigation bar.
  2. Select Production Settings.
  3. Click Go to the app assessment questionnaire at the bottom of the page.
  4. Enter your answers then submit the questionnaire to Intuit.

Add your secure keys to Codat

After you've created and configured a QuickBooks Online app, add the app's development or production keys to the corresponding QuickBooks Online integration. When you're ready, enable the integration.

Perform these steps in the Codat Portal.

  1. On the navigation bar, select Settings > Accounting.
  2. Find the QuickBooks Online Sandbox or QuickBooks Online integration, then select Manage.
  3. Select One-off or Continuous to choose what type of access to company data the integration will have.
  4. Enter the Client Id and Client Secret from your QuickBooks Online app.
    • For the sandbox integration, enter your app's development keys.
    • For the production integration, enter your app's production keys.
  5. Click Save.
  6. Return to Settings > Accounting.
  7. Enable the integration by setting the toggle from Disabled to Enabled.

You can also enable the integration directly from its Integration settings page.