QuickBooks Enterprise Authenticate an Element

QuickBooks Enterprise Versioning Note

Intuit has made a change in the latest version of QuickBooks Desktop (aka QuickBooks Enterprise - QBE) such that if you or your customers choose to update your on-prem QuickBooks installation, the existing versions of the Ground2Cloud (G2C) QB Connector will no longer function. This Intuit update supports SDK 14 as the default version, but Cloud Elements still leverages SDK 13.0 and was depending on the returned version from QB to make its decision. This is breaking the existing connector as the existing QB connector is built with version 13 of the SDK.

The solution is to install the new QB Connector bundled in G2C version 0.6.32 (https://github.com/cloud-elements/g2c-releases/releases/tag/v0.6.32) that caps the SDK version; Cloud Elements will release a longer-term solution that allows you to use the correct versions. Note that if the Intuit/QuickBooks update is installed with an old QB Connector, then any element request attempts will fail with a 500 response indicating "Unsupported qbXML version".

You can authenticate with QuickBooks to create your own instance of the QuickBooks Enterprise element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the QuickBooks Enterprise platform.

Authenticate Through the UI

Use the UI to authenticate with QuickBooks Enterprise and create an element instance as described in Authenticate an Element Instance (UI). In addition to the base authentication parameters, you will need the credentials that you identified in API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is as simple as providing the necessary authentication parameters in the request body in order to Authenticate the element instance.

Authenticating the Element Instance

Use the /instances endpoint to authenticate with QuickBooks Enterprise and create an element instance. If you are configuring events, see the Events section.

To create an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "quickbooksonprem"
     },
     "configuration": {
       "filter.response.nulls": "true",
       "app.name": "<APP_NAME>",
       "host.ip": "<HOST_IP>"
     },
     "tags": [
       "<Add_Your_Tag>"
     ],
     "name": "<INSTANCE_NAME>"
   }
   

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances
   

   Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "quickbooksonprem"
  },
  "configuration": {
    "filter.response.nulls": "true",
    "app.name": "<APP_NAME>",
    "host.ip": "<HOST_IP>"
  },
  "tags": [
    "QuickBooks"
  ],
  "name": "QuickBooks Enterprise"
}'

Parameters

API parameters not shown in Cloud Elements are in code formatting.

Example Response

{
    "id": 1,
    "name": "QuickBooks Enterprise",
    "createdDate": "2017-06-06T19:08:52Z",
    "token": "pIHuafNc/17ADfEjcqIsFZ9eNNk58dXSEdqhC5QnQBk=",
    "element": {
        "id": 195,
        "name": "QuickBooks Enterprise",
        "hookName": "QuickBooksEnterprise",
        "key": "quickbooksonprem",
        "description": "Add a QuickBooks Enterprise Instance to connect your existing QuickBooks Enterprise account to the Finance Hub, allowing you to manage your customers, employees, invoices, purchase orders etc. across multiple Finance elements. You will need your QuickBooks Enterprise account information to add an instance.",
        "image": "elements/provider_quickbooks.png",
        "active": true,
        "deleted": false,
        "typeOauth": true,
        "trialAccount": false,
        "configDescription": "QuickBooks Desktop Element",
        "defaultTransformations": [{"...": "..."}]
  },
  "elementId": 195,
"provisionInteractions": [],
"valid": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"configuration": {
  "bulk.add_metadata": "false",
  "event.notification.subscription.id": null,
  "bulk.query.field_name": "TimeModified",
  "event.vendor.type": "polling",
  "bulk.query.operator": ">=",
  "filter.response.nulls": "true",
  "bulk.query.date_mask": "yyyy-MM-dd'T'HH:mm:ssXXX",
  "host.ip": "<HOST_IP>",
  "bulk.query.download_format": "json",
  "bulk.attribute.created_time": "TimeCreated",
  "bulk.relations": "{}",
  "event.poller.refresh_interval": "15",
  "event.notification.callback.url": null,
  "event.notification.signature.key": null,
  "bulk.attribute.modified_time": "TimeModified",
  "event.poller.urls": null,
  "event.poller.configuration": "...",
  "app.name": "<APP_NAME>",
  "event.notification.enabled": "false"
},
"eventsEnabled": false,
"traceLoggingEnabled": false,
"cachingEnabled": false,
"externalAuthentication": "none",
"user": {
  "id": "..."
}