QuickBooks V2 Connector > QuickBooks V2 Connections > QuickBooks V2 Connection Properties
  

QuickBooks V2 Connection Properties

When you set up a QuickBooks V2 connection, you must configure the connection properties.
The following table describes the QuickBooks V2 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
The value of Schema is set to default automatically.
QBXML version
QBXML version of the QuickBooks. The default QBXML version is 6.0.
For more information on QBXML version, see QBXML Version
Enable Logging
Enable logging to see the session logs of tasks.

QBXML Version

You require a QBXML version while creating a connection.
A corresponding version of the QuickBooks SDK is released with each release of QuickBooks. For example, with QuickBooks 2009 version, a corresponding 8.0 version of the QuickBooks SDK was also released.
Each release of QuickBooks support all earlier versions of the SDK, which means, requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks.
It is recommended that you set the QBXMLVersion property to the corresponding version of QuickBooks you are using.
The following table shows the QBXML versions and their corresponding QuickBooks version:
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
For more information on QBXML versions, see Recommended QBXML Versions for Objects.

Connection Parameters

Before creating a QuickBooks V2 connection, you can modify the connection parameters in the connectionparameters.ini file.
You can modify the connectionparameters.ini file in the following locations:
Note: Modify the connection parameters at one file location, and copy the modified file to other location.
The following table describes the parameters in the connectionparameters.ini file:
Parameters
Description
ApplicationId
Enter the assigned application ID by Intuit.
You have to register the application at http://appreg.quickbooks.com to obtain the ApplicationId.
ApplicationName
Enter the application name.
QuickBooks displays the name and prompts the user to grant or refuse access to the application.
CompanyFile
Enter the company file name.
Do not set CompanyFile when QuickBooks is open.
Note: It is mandatory to assign the CompanyFile property in Remote Connector if QuickBooks is connected through 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
Enter 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
Enter 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. For more information, see Firewall Types.
FirewallUser
Enter the Firewall user name.
When FirewallServer is specified, it is mandatory to specify the FirewallUser and FirewallPassword properties to authenticate the firewall.
IncludeLineItems
Select “True” to request Line Item responses. By default “False” is selected.
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
Select “True” to request Linked Transactions. By default “False” is selected.
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. For example, OnlineLogin : AABSC.
The OnlineLogin is applicable only in QuickBooks Online Edition.
Other
A semicolon-separated list of name-value pairs used in connection parameters specific to a data source. For more information, 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 you are authenticating the connector using proxy server.
When you use ProxyServer, the ProxyUser and ProxyPassword properties are required to authenticate against the firewall.
ProxyPort
Enter the TCP port for the Proxy Server. The default value is set to 80.
ProxyServer
If you enter 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.
ProxySSLType
Enter the SSL type to use while connecting to proxy server. The value may be AUTO, ALWAYS, NEVER, or TUNNEL.
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 value 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

The following table shows the firewall types:
Type
Firewall Port
TUNNEL
80
SOCKS4
1080
SOCKS5
1080

Other Property

The following table shows the other connection properties:
Name
Value
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 in INI File

The following table shows the connection parameters and their values:
Parameter Name
Value
ApplicationId
String
ApplicationName
String
CompanyFile
String
ConnectionTicket
String
DelayAfterClose
Time
FirewallPassword
String
FirewallPort
String
FirewallServer
String
FirewallType
Firewall Types. For more information, see Firewall Types.
FirewallUser
String
IncludeLineItems
True/False
IncludeLinkedTxns
True/False
OnlineLogin
String
Other
Other Property. For more information, see Other Property.
ProxyAuthScheme
BASIC, DIGEST, NONE, NTLM, or PROPRIETARY.
ProxyAutoDetect
True/False
ProxyPassword
String
ProxyPort
Default value is 80.
ProxyServer
String
ProxySSLType
AUTO, ALWAYS, NEVER, or TUNNEL.
ProxyUser
String
SessionTicket
String
SSLAcceptCertServer
String
SSLCert
String
Timeout
Default value is 30 (secs)
Note: You can create a connection parameter in the following format: <Parameter_Name>=<Value>. For example, IncludeLineItems=True/False.
For more information, see Connection Parameters.