QuickBooks Connector OAuth 2.0 Create an Endpoint¶

Before beginning the steps on this page, you should have already completed these setup activities to allow Harmony access to your QuickBooks Online instance:

• QuickBooks Connector OAuth 2.0 - Create QuickBooks App
• Installing Jitterbit Design Studio on Windows or Installing Jitterbit Design Studio on macOS
• Installing a Harmony Windows Agent or Installing a Harmony Linux Agent

At this point, you should have all the information you need to start working in Harmony. This page describes how to use the Harmony QuickBooks Connector to create an endpoint within Harmony Design Studio.

Testing Endpoint¶

1. Open the Design Studio application, version 8.29.2 or later. Sign in using the credentials created when you joined your Organization during the signup process through the Harmony website.

2. The Getting Started screen should display, where you may choose to do a variety of tasks. For the purpose of this walk through, we will create a new project. In the bottom tab portion of the Getting Started screen, click on New Project.

   1. Choose an appropriate name for your new project and then select other settings that are appropriate for your Organization. For purposes of this example we will call our project "QuickBooks New OAuth 2."
   2. If this is the first time that you have used Design Studio you may accept all of the default values.
   3. If you have used Design Studio previously, then you may want to change the selected settings as appropriate.

   4. Click the Create button.

      

3. Once your new project has been created, your screen should be similar to the image shown below. The far left-hand side of the Design Studio shows the different parts of your integration: Operations, Transformations, etc. On the left-hand side, scroll down until you see the Connectors category. Double-click the QuickBooks Connector so that the underlying activities are visible.

   

4. Then right-click on QuickBooks Endpoints as seen in the image below and select New QuickBooks Endpoint from the list.

   

5. On the right-hand side of the screen, you should see a new tab in your workspace called QuickBooks Endpoints. This is where you will set up the ability to connect Harmony to your QuickBooks sandbox instance using the values that were obtained previously in this documentation.

   

   1. Enter an appropriate name for the endpoint in the Name field. For purposes of this example we will call our endpoint "New QuickBooks Endpoint."
   2. Select the OAuth2 radio button. The tab will now display the specific data fields required to create a QuickBooks OAuth 2.0 endpoint.
   3. Realm ID: The Realm ID is generated within the QuickBooks OAuth 2.0 Playground as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • Copy the Realm ID from the browser window and paste into the Realm ID field within the New QuickBooks Endpoint tab in Design Studio as shown in the image above.
   4. *Authorization Code: *The Authorization Code is generated within the QuickBooks OAuth 2.0 Playground as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • Copy the Authorization Code from the browser window and paste into the Authorization Code field within the New QuickBooks Endpoint tab in Design Studio as shown in the image above.
   5. Client ID: The client ID is generated during the creation of the QuickBooks app as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • In the menu at the top of the page, click My Apps.
      • Select the app you created during the testing and development stage specifically to set up the Harmony QuickBooks Connector.
      • Click the Keys tab.
      • The Development Keys display at the top of the page.
      • Click the Copy button to the right of the Client ID within the Keys tab and paste into the Client ID field within the New QuickBooks Endpoint tab in Design Studio as shown in the image above.
   6. Client Secret: The client secret is generated during the creation of the QuickBooks app as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the Development Keys.
      • Click the Copy button to the right of the Client Secret within the Keys tab and paste into the Client Secret field within the New QuickBooks Endpoint tab in Design Studio as shown in the image above.
   7. URL: This value is the URL of either the QuickBooks sandbox environment or the QuickBooks production environment, depending on which you are using. It can be copied and pasted into your URL text field as shown in the image above:
      • Sandbox Environment: https://sandbox-quickbooks.api.intuit.com/v3/company
   8. Once all of the necessary values have been supplied, click the Save** icon in the toolbar in Design Studio.
   9. The connection should be tested to verify that everything is set up correctly. To do so, click the Test Connection button. The following popup should be displayed once Harmony has successfully connected to QuickBooks.
   10. The above message confirms that the newly created sandbox connection is valid and is working. If the connection is not successful, the provided values should be double checked to ensure that there are no additional spaces, or a value was not fully copied and pasted into one of the connection properties.

Configuring the Connection to QuickBooks Sandbox on Multiple Agents¶

If your private agent group contains more than one private agent, complete these steps:

1. QuickBooks creates this file when the connection is successful: "C:\ProgramData\qbdata\qbdata.properties". This file is created on only one of the private agents in the agent group, but the file is necessary for QuickBooks to communicate with each agent.
2. Search each private agent within the agent group to determine on which agent the "qbdata.properties" file resides.
3. Copy the entire "\qbdata" folder into the "c:\ProgramData" folder on each of the remaining agents within the agent group. This allows every agent within the agent group to communicate with QuickBooks.

Next Step: Once your Harmony endpoint has successfully connected to your QuickBooks sandbox instance, your next step is to create the appropriate activities to integrate your QuickBooks Online instance with other programs and applications.

QuickBooks Connector - Query Activities

QuickBooks Connector - Create Activities

QuickBooks Connector - Update Activities

QuickBooks Connector - Delete Activities

Production Endpoint¶

When you are ready to bring your integration to a production environment, follow the steps below to create a production endpoint in Design Studio.

1. Open the Design Studio application, version 8.29.2 or later. Select an existing QuickBooks project in the Recent Projects tab and click on the Open button, or click on the New Project tab and create a new project.
2. On the left-hand side of the Design Studio, scroll down until you see the Connectors category. Double-click the QuickBooks Connector so that the underlying activities are visible.
3. Right-click on QuickBooks Endpoints and select New QuickBooks Endpoint from the list.
4. On the right-hand side of the screen, you should see a new tab in your workspace called QuickBooks Endpoints. This is where you will set up the ability to connect Harmony to your production QuickBooks instance using the values that were obtained previously in this documentation.
   1. Enter an appropriate name for the endpoint in the Name field. For purposes of this example we will call our endpoint "QuickBooks Production."
   2. Select the** OAuth2** radio button. The tab will now display the specific data fields required to create a QuickBooks OAuth 2.0 endpoint.
   3. Realm ID: The Realm ID is generated within the QuickBooks OAuth 2.0 Playground as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • Copy the Realm ID from the browser window and paste into the Realm ID field within the QuickBooks Endpoint tab in Design Studio as shown in the image above.
   4. Authorization Code: The Authorization Code is generated within the QuickBooks OAuth 2.0 Playground as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • Copy the Authorization Code from the browser window and paste into the Authorization Code field within the QuickBooks Endpoint tab in Design Studio as shown in the image above.
   5. Client ID: The client ID is generated during the creation of the QuickBooks app as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the OAuth 2.0 Playground page.
      • In the menu at the top of the page, click My Apps.
      • Select the app you created during the testing and development stage specifically to set up the Harmony QuickBooks Connector.
      • Click the Keys tab.
      • Scroll down to the Production Keys section.
      • Click the Show button to the right of the Client ID within the Keys tab. The client ID is displayed.
      • Click the Copy button to the right of the Client ID and paste into the Client ID field within the QuickBooks Endpoint tab in Design Studio as shown in the image above.
   6. Client Secret: The client secret is generated during the creation of the QuickBooks app as described in QuickBooks Connector OAuth 2.0 - Create QuickBooks App.
      • Return to the open browser window displaying the Production Keys section.
      • Click the Show button to the right of the Client Secret within the Keys tab. The client secret is displayed.
      • Click the Copy button to the right of the Client Secret and paste into the Client Secret field within the QuickBooks Endpoint tab in Design Studio as shown in the image above.
   7. URL: This value is the URL of either the QuickBooks sandbox environment or the QuickBooks production environment, depending on which you are using. It can be copied and pasted into your URL text field as shown in the image above:
5. Production Environment: https://quickbooks.api.intuit.com/v3/company
6. Once all of the necessary values have been supplied, click the Save** icon in the toolbar in Design Studio.
7. The connection should be tested to verify that everything is set up correctly. To do so, click the Test Connection button. The following popup should be displayed once Harmony has successfully connected to QuickBooks.
8. The above message confirms that the newly created production connection is valid and is working. If the connection is not successful, the provided values should be double checked to ensure that there are no additional spaces, or a value was not fully copied and pasted into one of the connection properties.

Configuring the Connection to QuickBooks Production on Multiple Agents¶

If your private agent group contains more than one private agent, complete these steps:

1. QuickBooks creates this file when the connection is successful: "C:\ProgramData\qbdata\qbdata.properties". This file is created on only one of the private agents in the agent group, but the file is necessary for QuickBooks to communicate with each agent.
2. Search each private agent within the agent group to determine on which agent the "qbdata.properties" file resides.
3. Copy the entire "\qbdata" folder into the "c:\ProgramData" folder on each of the remaining agents within the agent group. This allows every agent within the agent group to communicate with QuickBooks.