Connecting

Preparation

When your user goes to connect the Agent to their QuickBooks Desktop, they'll need to make sure of a few things. Be sure to communicate this to your users in your own guides, and feel free to use our content to help you.

Before connecting to their QuickBooks, your users should make sure:

  • The branded Agent you gave them is installed and running on their desired machine
  • They have entered their agentToken and clicked Save
  • The Agent shows as Connected in dark blue text.
  • QuickBooks is open to the desired Company file
  • QuickBooks is in single user mode, logged in as the QuickBooks admin (not just a user with admin rights)
  • No more than 1 company file is open

These precautions are only necessary on initial connection to a company file. Once they have connected successfully, they can return to normal use (i.e. multi-user mode).

📘

QuickBooks Sample Companies

Unfortunately, sample company files from QuickBooks aren't supported by the API. Create your own company to start your testing.

Connecting

You should give your users a way to initiate the connection to their QuickBooks - often this is a dedicated Connect button, or perhaps when they click Next on particular page in a wizard. This is when you should call Autofy to connect.

When you call /manage/company with POST, the Autofy platform immediately calls down to the Agent and attempts to connect to QuickBooks. The end user will need to authorize the Agent with the QuickBooks Company file they currently have open.

In QuickBooks, your end user will see a modal asking to authorize Autofy. They should give it access even if QuickBooks isn't running. This gives you the greatest possible availability to work with their data.

Once successful, you'll see a JSON response giving you the endpointID for that company. Store this value on your end to make calls for that company.

{
  "Meta":{
    "StatusCode":0,
    "Severity":null,
    "Message":null
  },
  "company":{
    "companyName":"Test",
    "dateTimeCreated":"2016-09-16T13:41:30.2156102-05:00",
    "dateTimeLastAccess":"2016-09-16T13:41:37.1445599-05:00",
    "fullPath":"D:\\Programs\\QuickBooks Enterprise 16\\Company Files\\Test.qbw",
    "id":"d1228a71de104b3494482d15f8b09f7c",
    "isActive":true,
    "userId":"28bb12f7393944a7be956888900d1f05",
    "externalId":"",
    "endpoint":"qbd",
    "endpointId":"c67e83e28abe40e59164fbe5888a178b"
  }
}

Connection Overview

  1. Agent is installed on user's machine
  2. User token is entered on Agent
  3. Agent shows as Connected
  4. Make IsActive call to Agent to confirm connection
  5. User is logged into QuickBooks as QuickBooks Administrator (QB Admin) and in Single User Mode
  6. Make provisioning call
  7. User accepts permissions certificate in QuickBooks
  8. JSON response is returned with endpointId. Store this value.
  9. User may go back to Multi User Mode and use QB normally after the company file has been provisioned.

Did this page help you?