QuickBooks Desktop SmartSync integration prerequisites

Modified on Wed, 14 Dec 2022 at 02:47 PM

Beanworks connects to your ERP using our data synchronization tool, SmartSync. SmartSync allows us to access the data needed so that you to accomplish your workflow needs. There are specific installation requirements to ensure this SmartSytnc integrates seamlessly for you. This document will walk you through the necessary setup required for SmartSync.

General Requirements

Server Requirements

Typical Environment

Required .NET


Minimum Requirements

ERPs Supported

  • Windows Server 2012 R2

  • Windows Server 2016

  • Windows Server 2019

  • Windows 10

  • Windows 7.8.1

4.8 (528372)



Intuit Products:

  • QuickBooks Desktop Premier 2014 and above

  • QuickBooks Desktop Enterprise 2014 and above

.NET Version requirements

SmartSync requires a .NET version of 4.8 or above to run successfully. To check your .NET version, run Windows Powershell on your server, and then run the following command:

(Get-ItemProperty "HKLM:SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full").Release

Verify your six-digit string below to ensure you are on the correct .NET version.


Typical Environment

.NET version 4.8 release DWORD

Windows 11/Windows Server 2022


Windows 10 - May 2020 Update/October 2020 Update/May 2021 Update


Windows 10 - May 2019/November 2019 Update


All other OS versions


You must upgrade your server before your Integration meeting if you are not on .NET version 4.8 or higher. The update will require a server restart. Here is the link to upgrade your .NET version: http://go.microsoft.com/fwlink/?linkid=863265.

Windows User

We require a dedicated Windows Logon user for SmartSync. Specifically, this ensures that the SmartSync apps and services are run by a user with full access to all relevant areas of the server. This user must be able to lock their session as opposed to logging in and out.

●       has Full Control on C:\ProgramData\BeanworksSyncTool

●       has Full Control on the path(s) to your Company File(s)

For ease of use, we recommend including keywords like ‘SmartSync’ or ‘Beanworks’ in the user name so it can be easily located & verified.

You can refer to the following article in our Help Centre to add a local user to your system.

Firewall Setup

SmartSync is both an SFTP client (data transfer) and an HTTPS client (authentication). Connections are initiated by the client, reaching out from your server to our infrastructure. Please ensure that the following traffic is allowed through your firewall, so SmartSync can send & receive data to our cloud infrastructure.

If your firewall is local to the installation machine, you may be able to whitelist using the combination of application name and port, or domain and port. If your firewall is at the perimeter, you may need to use the combination of machine name and port.

Domain or Service Name

Port or Traffic Type



22000 (SFTP)

Port 22000 is specific to Beanworks


4333 (HTTPS Outbound traffic)

These authorizations are needed to allow SmartSync to do the following:

  • login to http://beanworks.com

  • retrieve and acknowledge sync requests 

  • to complete the data transfer to the ERP

Windows Executables:

  • SmartSync Manager

  • SmartSync Connector

Windows Services:

  • SmartSync Connector Service

  • SmartSync Polling Service

SmartSync Auto-Updater

SmartSync receives periodical updates through our Auto-Updater. Please ensure that the following IP Addresses are whitelisted in your firewall to allow these updates:

  • "ip_prefix":""
  • "ip_prefix":""
  • "ip_prefix":""

These are the IP addresses for AWS services within Canada (ca-central-1). All requests from the Auto-Updater to our servers are port 443 (HTTPS Traffic) Outbound.

Company File naming convention

The QuickBooks Desktop Company File filename should follow these naming best practices:

  • the filename should contain only alphanumeric characters and underscores

  • the filename must not contain special characters, such as /, –. ( ) < > | [ ] { }? etc. 

  • the filename should not contain a space

  • the filename must contain no more than 64 characters including .qbw

  • there must be only one .qbw in the filename, as the last 4 characters

If you make any changes to your company filename, run the QuickBooks database manager to rescan the folder where the file is stored, to reflect the new filename.

Enable Diagnostics Mode

Follow the information contained in this article to enable diagnostics mode for QuickBooks. This will allow us to gather any information we need to troubleshoot issues related to not getting the integration started: https://help.developer.intuit.com/s/article/QBD-QBSDK-Logging 

QuickBooks Administrator

The QuickBooks Admin user is required to grant third-party authorization to SmartSync when integrating with Beanworks. This is Intuit’s recommended approach for any third-party integration installation. It is recommended to book your Integration call at a time when you can run QuickBooks in single-user mode. This will help minimize chances for errors and unexpected behaviour during the integration call.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article