QuickBooksV2 (On-Premise) Connector Guide > QuickBooks Connections > QuickBooks Connection Properties
  

QuickBooks Connection Properties

When you set up a QuickBooksV2 connection, you must configure the connection properties.
The following table describes the QuickBooksV2 connection properties:
Connection Property
Description
Username
Username of the QuickBooks account.
Password
Password of the QuickBooks Account.
Connection URL
The Connection URL to connect to the QuickBooks Application.
Schema
Schema is set to default automatically.
QBXML version
You can use the QBXML version to send message. The default QBXML Version is 6.0. A corresponding version of the QuickBooks SDK released for the release of QuickBooks.
Enable Logging
When you enable logging you can see the session log for the tasks.

Knowing QBXML Version

The following information helps you to understand QBXML version required to be mentioned while creating a connection.
With each release of QuickBooks, a corresponding version of the QuickBooks SDK has also been released.
Each release of QuickBooks continues to support all earlier versions of the SDK, meaning that, requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks.
For example, With QuickBooks 2009 version, a corresponding version of the QuickBooks SDK has also been released: 8.0.
It is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are using.
Different QBXML versions
QuickBooks Version
QBXML Version
QuickBooks 2002
1.0, 1.1
QuickBooks 2003
2.0
QuickBooks 2004
3.0
QuickBooks 2005
4.0, 4.1
QuickBooks 2006
5.0
QuickBooks 2007
6.0
QuickBooks 2008
7.0
QuickBooks 2009 and 2010
8.0
QuickBooks 2017
12.0
See Also: Suggested QBXML Versions for Few Objects.

Connection Parameters

Before creating a QuickBookV2 connection, you can modify/edit a number of connection parameters present in the connectionparameters.ini file.
The connectionparameters.ini file needs to be modified in two locations.
    1. <Secure Agent installation directory>\downloads\<latest connector zip package>\package\plugins\<Plugin ID>
    2. <Secure Agent installation directory>\downloads\<latest connector zip package>\package\rdtm\javalib\<Plugin ID>
Note: It is suggested to modify connection parameters at one file location and then copy the modified file to other location.
The following parameters are present in the connectionparameters.ini file.
Parameters
Description
Remarks
ApplicationId
Enter the assigned application ID by Intuit.
ApplicationId is obtained, when you register the application at http://appreg.quickbooks.com.
ApplicationName
Enter the application name. The application name appears when the application first connects to QuickBooks.
QuickBooks displays the name and prompt the user to grant or refuse access to the application.
CompanyFile
Enter the company file name to be used in connection.
Do not set CompanyFile when QuickBooks is open. It is mandatory to assign the CompanyFile property in Remote Connector, if QuickBooks is connected through the remote connector.
ConnectionTicket
Enter the connection ticket. The ticket is applicable for QuickBooks Online Edition.
ConnectionTicket is permanently valid. If user has not enabled session authentication ("login security"), it is enough to specify the ConnectionTicket, ApplicationName, and OnlineLogin.
DelayAfterClose
Mention the delay in milliseconds, to be applied each time a connection to QuickBooks is closed.
When you get internal errors, setting this delay to a positive value may solve the problem.
FirewallPassword
Enter the password, if authentication is required to connect through firewall.
When FirewallServer is specified, it is mandatory to specify the FirewallUser and FirewallPassword properties to authenticate the firewall.
FirewallPort
Mention the TCP port for the firewall port server. Example, FirewallPort : 400
QuickBooks connector sets the FirewallPort to default port associated with the specified FirewallType.
FirewallServer
Enter the Firewall server IP address to authenticate connection.
When Firewall server is set to a domain name, a DNS request is initiated and the name is translated to the corresponding IP address.
FirewallType
Enter the type of firewall required for connection. See Firewall Types.
NA
FirewallUser
Enter the Firewall user name.
When FirewallServer is specified, it is mandatory to specify the FirewallUser and FirewallPassword properties to authenticate the firewall.
Parameters
Description
Remarks
IncludeLineItems
By default “False” is selected. Select “True” to request Line Item responses.
You can select whether to request LineItem responses or not, when retrieving base transaction, such as Invoices. Setting this value to false will typically result in better performance.
IncludeLinkedTxns
By default “False” is selected. Select “True” to request Linked Transactions.
You can select whether to request LinkedTransactions responses or not, when retrieving base transaction, such as Invoices. Setting this value to false will typically result in better performance.
OnlineLogin
Enter your user login for QuickBooks online edition. Example, OnlineLogin : AABSC
The OnlineLogin is applicable only QuickBooks Online Edition.
Other
A semicolon-separated list of name-value pairs used in connection parameters specific to a data source. See Other Property.
Parameters that connect to data source. Example, username and password, when applicable.
ProxyAuthScheme
Enter the proxy server authorization scheme.
The value may be BASIC, DIGEST, NONE, NTLM, or PROPRIETARY
ProxyAutoDetect
Enter “True” to use the default system proxy settings. Otherwise enter “False” to use custom proxy settings.
Indicate whether to use the default system proxy settings or not.
ProxyPassword
Enter the proxy password, if authenticating the connector using proxy server.
When you use ProxyServer, the ProxyUser and ProxyPassword properties are required to authenticate against the firewall.
ProxyPort
Mention the TCP port for the proxy Proxy Server. The default value is set at 80.
NA
ProxyServer
If you mention the proxy server address, then the HTTP request is sent to the proxy instead of the server otherwise specified.
When ProxyServer is set to a domain name, a DNS request is initiated and the name is translated to the corresponding IP address.
Parameters
Description
Remarks
ProxySSLType
Mention the SSL type to use while connecting to proxy server. The value may be AUTO, ALWAYS, NEVER, or TUNNEL.
NA
ProxyUser
Enter proxy username, if authentication is required over proxy.
When you specify ProxyServer, the ProxyUser and ProxyPassword properties are required to authenticate against the firewall.
SessionTicket
Enter the session ticket for a single session. Note: this value is optional.
Session ticket is valid only for sixty minutes after its last use. If you require session authentication, you must obtain the value offline before connecting to QuickBooks.
SSLAcceptCertServer
Mention SSL certificate used by remote connector
The Base-64-encoded certificate used by the Remote Connector.
SSLCert
Mention the certificate to be accepted from the server when connecting using SSL.
When using an SSL connection, SSLCert used to specify the SSL certificate to be accepted from the server
Timeout
Mention the time-out in seconds. Default is 30 seconds.
When Timeout is set to 0, task operations do not time out and complete successfully or encounter an error condition.

Firewall Types

Type
Firewall Port
TUNNEL
80
SOCKS4
1080
SOCKS5
1080

Other Property

Name
Value
Description
CachePartial
True/False
Select “True”, to cache only a subset of columns which you can specify in your query. Otherwise select “False”.
QueryPassthrough
True/False
Select “True”, to pass the query to the cache database allowing you to use the full syntax of the cache database. Otherwise select “False”.
RecordToFile
Filename
Records the underlying socket data transfer to the specified file.

Connection Parameters Format in INI File

Parameter
Parameter Format in INI File
Value
ApplicationId
ApplicationId=<Value>
Any String
ApplicationName
ApplicationName=<Value>
Any String
CompanyFile
CompanyFile=<Value>
Any String
ConnectionTicket
ConnectionTicket=<Value>
Any String
DelayAfterClose
DelayAfterClose=<Value>
Any Time
FirewallPassword
FirewallPassword=<Value>
Any String
FirewallPort
FirewallPort=<Value>
Any String
FirewallServer
FirewallServer=<Value>
Any String
FirewallType
FirewallType=<Value>
FirewallUser
FirewallUser=<Value>
Any String
IncludeLineItems
IncludeLineItems=<Value>
True/False
IncludeLinkedTxns
IncludeLinkedTxns=<Value>
True/False
OnlineLogin
OnlineLogin=<Value>
Any String
Other
Other=<Value>
ProxyAuthScheme
ProxyAuthScheme=<Value>
BASIC, DIGEST, NONE, NTLM, or PROPRIETARY.
ProxyAutoDetect
ProxyAutoDetect=<Value>
True/False
ProxyPassword
ProxyPassword=<Value>
Any String
ProxyPort
ProxyPort=<Value>
Default is 80.
ProxyServer
ProxyServer=<Value>
Any String
ProxySSLType
ProxySSLType=<Value>
AUTO, ALWAYS, NEVER, or TUNNEL.
ProxyUser
ProxyUser=<Value>
Any String
SessionTicket
SessionTicket=<Value>
Any String
SSLAcceptCertServer
SSLAcceptCertServer=<Value>
Any String
SSLCert
SSLCert=<Value>
Any String
Timeout
Timeout=<Value>
Default is 30 (secs)
See Also: Connection Parameters
The following figure represents connection parameters.ini file.