QuickBooks Integration

Document created by rich_patterson Employee on Feb 26, 2016Last modified by chris_stevens on Apr 11, 2016
Version 8Show Document
  • View in full screen mode

The QuickBooks connector enables you to move data into and out of QuickBooks financial software. The connector connects directly to the QuickBooks company data file (*.qbw) or online account. The connector enables you to query, add, modify, and delete various types of records including accounts, customers, sales orders, invoices, and many more.


Reference Guide Articles

Here are some links to our Reference Guide, which you may find useful when using and configuring [Core Concept].




Is QB online REST API edition available?

The Quickbooks online API edition ( version 2 ) is no longer available.  Instead, Intuit has a new version , V3 available. It is sometimes called the QuickBooks Online “Harmony” edition.

Here is the link to Intuit site :



Do you have more information about the QuickBooks SalesTaxCountry element?

Some QuickBooks elements are specific to particular countries.

  • SalesTaxCountry element is supported by the SDK for Australia, the UK and Canada only.
  • This element will not be included in the response data for US versions of QuickBooks.
  • This element will be part of the profile import for all countries as it is a possible element.


How do I enable custom fields from Quickbooks, such as SalesforceAccount, in Boomi?

In order to follow the instructions from the quickbooks integration best practice:


If your transaction or list items have custom fields or "Data Extensions", the custom fields typically will not be extracted by default. To get these fields you should set the Owner ID field to "0" (zero) in the request. To accommodate multiple custom fields you will need to modify the response XML Profile and create additional DataExtRet elements (with child elements) for each custom field. Next, add a constraint to each DataExtRet element, setting Element = DataExtName, Type = "Value", and Value = the name of a specific custom field.


Here is an example on how it can be done:

  1. Add constraint
    1. Click on the “Types” tab
    2. Select DataExtRet/DataExtName
    3. Go to Qualifiers/Add Qualifier where qualifier is the name of the custom fieldQuickbooks Boomi custom fields
  2. Add Identifier Instance
    1. Go to “Data Elements” tab
    2. Click blue triangle next to DataExtRet, choose Add Identifier Instance
    3. See screenshot below – choose the qualifier set in prev step
    4. Repeat step 2 as needed to add additional fields.
      User-added image



How do I upgrading QuickBooks On-Premise on a local atom machine?

QuickBooks needs to be upgraded on a machine that hosts the a local Boomi atom with processes that integrate with a QuickBooks company file.

The following are Best Practices for upgrading the QuickBooks version to minimize impacts to the Boomi processes:


Highly recommended pre-requisite:

  1. Identify a test machine
  2. Install the new QB version on the test machine
  3. Install a new 32-bit atom on the test machine
  4. Make a backup and a copy of the QB company file to a different location accessible from the test machine
  5. Make a copy of a production process that performs a query against QuickBooks. Disconnect all downstream targets in the copied process. Modify the QuickBooks connection component to point to the copied company file at the different location
  6. Execute the copied and modified test process to query against the copied company file using the new version of QuickBooks.
  7. Verify that the results are as expected. If possible extend the test case scenario to perform an insert or update against the copied company file.


Recommended steps for the QB upgrade:

  1. Backup all company file(s) to a separate machine/disk. Verify no one is working in QuickBooks during this upgrade (plan ahead for a downtime window)
  2. In AtomSphere -> Manage -> Atom Management, select the atom and Stop the Schedule(s) for processes that integrate with QuickBooks
  3. On the atom machine, perform a complete uninstall of the current version of QuickBooks. Perform a complete reboot of the machine. Verify that QuickBooks is completely uninstalled.
  4. On the atom machine, install the new version of QuickBooks. This will likely require a reboot of the machine and restart of the atom.
  5. In Manage -> Process Reporting -> execute the processes that integrate with QuickBooks manually at least once to verify the are working
  6. In Manage -> Atom Management -> Resume schedules for the processes


The reason for steps above is that if an upgrade was attempted on top of an older version of QuickBooks, stale libraries or references could be left behind. These steps ensure a clean un-install of the old version removes all libraries and references, and then allows a clean install of the new version.


Regarding the processes, the XML profiles should be backwards compatible, so we wouldn’t expect any updates to the operations.

but if connection details or file paths are different, then those changes may be required. If any new features in the new QuickBooks version are going to be used and are identified as requiring integration, they may require new changes to the processes.

1 person found this helpful