ExpandedToggleIcon        Connection Dialog

To connect to QuickBooks, you need to perform the following steps:

1.If you connect to QuickBooks sandbox, select the Sandbox check box.
2.Optionally select the Use custom OAuth App check box and specify the custom Client ID and Client Secret. You can obtain these parameters when registering an OAuth app in your QuickBooks developer account.
3.Click the Web Login button
4.In the opened Web Login dialog box sign in to your QuickBooks account.
5.Select a company to query data from (click the link with the corresponding company name).
6.Click Authorize.


Additionally you may configure Advanced connection options for more fine connection tuning. It is recommended to set the Token Server parameter there to avoid the need to perform Web Login again when Refresh Token expires.


ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:




Client ID

One of the pair of OAuth 2.0 credentials, that you can obtain when you register a client application at developer.intuit.com/myapps with your developer account.

Client Secret

The second one of the pair of OAuth 2.0 credentials, that you can obtain when you register a client application at developer.intuit.com/myapps with your developer account.

Company Id

A string that uniquely identifies a QuickBooks company. Filled automatically when you perform web login and authorization as described above.

Connection Lifetime

When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Failover Retries

The number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to QuickBooks API calls. In this case ll the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into Mailchimp API calls can be used. More complex SELECT statements will fail.

Max Pool Size

The maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Min Pool Size

The minimum number of connections allowed in the pool. The default value is 0.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.


If true, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

The port number of the proxy server. The default value is 3128.

Proxy User

The proxy server account name.


Indicates whether the connection is read-only (allows only SELECT statements).

Refresh Token

OAuth 2.0 refresh token for QuickBooks. Obtained automatically when you perform Web Login. Alternatively, you can receive it using QuickBooks OAuth 2.0 Playground to obtain the initial refresh token.

Token Server

Refresh Token may expire after just 24 hours. SSIS Data Flow Components for QuickBooks can query new tokens automatically and store them between sessions if you set this parameter. This parameter specifies the location to store new tokens between sessions. You can specify a file or a registry key to store tokens. For example, "file://D:\temp\oauth_token_1234.txt" or "reg://HKEY_CURRENT_USER\Software\Devart\dotConnect\OAuth_12345"


UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.