QuickBooks Online Query Authentication Guide

QuickBooks Online Query Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the QuickBooks Online Query connector for use in Matillion ETL.

Important Information

  • The QuickBooks Online Query connector uses an OAuth for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left of the screen, click ProjectManage OAuth.

    Please Note

    If a QuickBooks Online Query connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

    1. Click the connector icon to open the Properties panel at the bottom of the screen.
    2. Click ... next to the Authentication input, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth entry

  4. Click the Service dropdown menu and select QuickBooks Online. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    New Entry listed on Manage OAuth window

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the Intuit Developer website, then click Sign In on the right above the header of the screen. The browser will redirect to the Sign In screen. Enter valid credentials to continue.

    Intuit Developer website homepage

    Intuit Developer website homepage

  2. Once signed in, the browser will return to the homepage. Click My Apps on the header menu, to be taken to the Dashboard.

    QuickBooks Online landing page

    QuickBooks Online landing page

  3. On the dashboard, click + Create an app on the top right of the screen.

    My Apps Dashboard

    My Apps Dashboard

  4. Now, select QuickBooks Online and Payments on the Create app page.

    Select platform for new app

    Select platform for new app

  5. On the QuickBooks Online and Payments window, provide details for the following fields:

    • Give your app a name – provide an appropriate name for the app
    • Select a scope – select a scope for the APIs you would like to access, then click Create app

    Name and scope for app

    Name and scope for app

  6. The browser will then redirect to Develop your app tutorial. This can be skipped at the stage. Instead, click Production on the sidebar on the left of the screen.

  7. In the Production window, in the Terms of Service Links section, provide details for the following fields:

    • End User License Agreement Url – provide a link to the End User License Agreement associated with the app
    • Privacy Policy Url – provide a link to the Privacy Policy associated with the app, then click Save at the bottom of the window

    Terms of Service Links

    Terms of Service Links

  8. Next, click Keys & OAuth on the sidebar, and in the Keys section, copy the codes from both the Client ID and Client Secret fields as they will be required in Authorising for use in Matillion ETL.

    Please Note

    • Make sure to copy the Client Secret right away as it may appear only once.
    • Additionally, when copying the client secret, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
  9. Scroll down to the Redirect URIs section and paste the Callback URL (copied earlier from the Manage OAuth window in Matillion ETL) into the LINK field. Then, click Save at the bottom of the screen.

    Copy

    Copy codes and paste Redirect URI

  10. Now, on the top right of the screen, click Hello <Account name>Sandbox to go to the Manage sandbox companies page.

    Account menu

    Account menu

  11. On the Manage Sandbox companies page, find the name of the company that will associated with the app. Then, copy the code to the right of Company ID as it will be required in Authorising for use in Matillion ETL

    Copy the client ID and secret

    Copy the client ID and secret


Authorising for Use in Matillion ETL

  1. Return to the Manage OAuth window in Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Configure OAuth settings

    Configure OAuth settings

  2. Using the codes copied from the Intuit Developer website earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings

  3. The next window will have an Authorization link. Click the link to authorise Matillion ETL to use the acquired credentials.

    Authorization link

    Authorization link

  4. The browser will redirect to a QuickBooks screen requiring a company to be associated with the app. From the Search for a company dropdown menu, select the company with associated with the Company ID used previously, then click Next.

    Search for a company

    Search for a company

  5. Then another screen will appear requiring confirmation that the selected company is to be connected to the app. Click Connect to confirm.

    Connect to QuickBooks online data

    Connect to QuickBooks online data

  6. If all is successful, the browser will return to Matillion ETL with a window stating, "Authorization Successful".

    OAuth Authorization successful

    OAuth Authorization successful