QBObject Control

Properties Methods Events Config Settings Errors

A generic QuickBooks object, allowing users to extend the product's functionality.

Syntax

QBObject

Remarks

QBObject is implemented for extensibility, and allows the user to extend the functionality of the control set. The control handles the XML parsing and QuickBooks connection, and leaves it to the user to specify the list of properties to include.

QBObject may be used to implement any object supported by version 1.1 of the QuickBooks SDK. For example, it could be used to implement a transaction line item. The full list of objects and their properties is in the SDK documentation; users of QBObject should download and refer to the SDK documentation for this information.

To add an object to QuickBooks, first set ObjectName to the name of the object being implemented; for example, "ItemService". Then, set ObjectType to the type of object: "List" for a list item, or "Txn" for a transaction item. Then, specify each property in order using the AddProperty method. Finally, invoke Add.

To get an object, set ObjectName and ObjectType as before, and then invoke Get. The object's property values may then be inspected using GetProperty. The object may also be deleted by invoking Delete.

The control does not implement any knowledge of QuickBooks business rules, and simply constructs QBXML based on ObjectName, ObjectType, and the calls to AddProperty. If the control is unable to construct valid QBXML it will fail with an error.

The following pseudocode shows how to add a service line item to QuickBooks.

QBObject1.ObjectName = "ItemService" QBObject1.ObjectType = "Txn" QBObject1.AddProperty("Name", "Item name here") QBObject1.AddProperty("SalesOrPurchase", "<AccountRef><FullName>Account name here</FullName></AccountRef>") QBObject1.Add()

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.


ObjectName	The name of the object.
ObjectType	The type of the object - generally List or Txn.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBRequestAggregate	The request aggregate.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBRequestMode	Defines whether the request is made online or stored offline.
QBResponseAggregate	The last QBXML response aggregate received from QuickBooks.
QBXMLVersion	The version of QBXML used in the outgoing message.
ResultCount	The number of records in the Result arrays.
ResultAggregate	One response XML aggregate returned from QuickBooks.
ResultObjName	Indicates which control is used to parse the corresponding Aggregate .
XChildCount	Number of children for the current element.
XElement	The name of the current element.
XPath	Provides a way to point to a specific element in the document.
XText	The text of the current element.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.


Add	Adds the record into QuickBooks.
AddProperty	Sets the value of the specified property.
CheckRequestStatus	Checks whether or not the specified request was processed by QuickBooks.
CloseQBConnection	Closes a persistent connection to QuickBooks.
Config	Sets or retrieves a configuration setting.
Delete	Deletes the record from QuickBooks.
Get	Gets a single record from QuickBooks.
GetByName	Gets a single record from QuickBooks.
GetProperty	Gets the value of the specified property.
HasXPath	Determines whether a specific element exists in the document.
OpenQBConnection	Opens a persistent connection to QuickBooks.
ProcessQueue	Processes the current queue of transactions.
Queue	Adds a transaction to the queue.
Reset	Resets all properties to their defaults.
ResetQueue	Resets the transaction queue.
SendRawXML	Sends the provided XML string to the QBXML Request Processor.
Update	Updates the entity object in QuickBooks.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.


AuthFlags	Connection Flags (use for QuickBooks Simple Start).
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersion	Returns the version of the QB Request Processor that is installed on your system.
GetSupportedVersions	Returns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnly	This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPref	Whether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionMode	The mode of connection to QuickBooks.
QBFileStatus	The status of the company file as it pertains to accepting connections.
QBOpenCompanyFile	The file currently open in QuickBooks.
SSLAcceptServerCert	The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFile	The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnError	Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.
UnattendedModePref	Whether connecting while QuickBooks is closed is required or optional for the user.
WarningCodes	A comma-separated list of QuickBooks warning codes that should not result in an exception.
CodePage	The system code page used for Unicode to Multibyte translations.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

ObjectName Property (QBObject Control)

The name of the object.

Syntax

qbobjectcontrol.ObjectName[=string]

Default Value

Remarks

The name of the object, exactly as found in the QuickBooks SDK documentation. Failure to set this property will result in an XML parser error.

Data Type

String

ObjectType Property (QBObject Control)

The type of the object - generally List or Txn.

Syntax

qbobjectcontrol.ObjectType[=string]

Default Value

Remarks

The type of the object: "List" for list items, or "Txn" for transaction items. Note that the name of the object's Id property determines the object type: List items have a "ListID" property, and transaction items have a "TxnID" property.

Failure to set this property will result in an XML parser error.

Data Type

String

QBConnectionString Property (QBObject Control)

An aggregate consisting of various QuickBooks connection properties.

Syntax

qbobjectcontrol.QBConnectionString[=string]

Default Value

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:


ApplicationName	The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFile	The name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used. This setting is not applicable when communicating with QB Connector.
URL	The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the control will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the control's request to QuickBooks, and return the response.
User	A username for the Remote Connector connection (if required on the Connector side)
Password	A password for the Remote Connector connection (if required on the Connector side)
Timeout	A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the control will generate an exception instead of hanging.
DelayAfterClose	A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.
FirewallHost	Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
FirewallPassword	Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
FirewallPort	Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.
FirewallType	Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.
FirewallUser	Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
ProxyAuthorization	Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.
ProxyPassword	Contains a password if authentication is to be used for the proxy.
ProxyPort	Contains the TCP port for a ProxyServer; (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.
ProxyServer	If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.
ProxyUser	Contains a user name, if authentication is to be used for the proxy.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the control binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the control will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.

Data Type

String

QBRequestAggregate Property (QBObject Control)

The request aggregate.

Syntax

qbobjectcontrol.QBRequestAggregate[=string]

Default Value

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer control to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (QBObject Control)

The Id of the next message to be sent to QuickBooks.

Syntax

qbobjectcontrol.QBRequestId[=string]

Default Value

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (QBObject Control)

Defines whether the request is made online or stored offline.

Syntax

qbobjectcontrol.QBRequestMode[=integer]

Possible Values

rmOnline(0), 
rmOffline(1)

Default Value

Remarks

This property defines the behavior of the control when calling a method. Possible values are:


0 (rmOnline - default)	The request is made normally.
1 (rmOffline)	The request is generated but not sent, and QBRequestAggregate is populated.

The use of offline mode is required when using the QBWCServer control. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer control.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (QBObject Control)

The last QBXML response aggregate received from QuickBooks.

Syntax

qbobjectcontrol.QBResponseAggregate[=string]

Default Value

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the control will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (QBObject Control)

The version of QBXML used in the outgoing message.

Syntax

qbobjectcontrol.QBXMLVersion[=string]

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, 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. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:


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	8.0
QuickBooks 2010	9.0
QuickBooks 2011	10.0
QuickBooks 2012	11.0
QuickBooks 2013	12.0
QuickBooks 2014	13.0
QuickBooks 2015	14.0
QuickBooks 2016	15.0

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:


QuickBooks Canadian 2003	CA2.0
QuickBooks Canadian 2004 to 2007	CA3.0
QuickBooks UK 2003	UK2.0
QuickBooks UK 2004 to 2007	UK3.0
QuickBooks Australian 2003	OZ2.0
QuickBooks Australian 2004 to 2007	AU3.0

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Data Type

String

ResultCount Property (QBObject Control)

The number of records in the Result arrays.

Syntax

qbobjectcontrol.ResultCount

Default Value

Remarks

This property controls the size of the following arrays:

ResultAggregate
ResultObjName

The array indices start at 0 and end at ResultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ResultAggregate Property (QBObject Control)

One response XML aggregate returned from QuickBooks.

Syntax

qbobjectcontrol.ResultAggregate(ResultIndex)

Default Value

Remarks

One response XML aggregate returned from QuickBooks.

The QBObject control can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other controls in QBObject, and then call ProcessQueue to send them to QuickBooks. The results will appear in the ResultAggregate array property in the same order they were inserted into the Queue. The number of results returned is indicated by the ResultCount property. The ResultObjName array property will contain the name of the component required to process each ResultAggregate.

The ResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.

This property is read-only and not available at design time.

Data Type

String

ResultObjName Property (QBObject Control)

Indicates which control is used to parse the corresponding Aggregate .

Syntax

qbobjectcontrol.ResultObjName(ResultIndex)

Default Value

Remarks

Indicates which component is used to parse the corresponding ResultAggregate.

The ResultObjName property will contain the name of the component required to process the corresponding ResultAggregate at each ResultIndex.

The ResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResultCount property.

This property is read-only and not available at design time.

Data Type

String

XChildCount Property (QBObject Control)

Number of children for the current element.

Syntax

qbobjectcontrol.XChildCount

Default Value

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

Integer

XElement Property (QBObject Control)

The name of the current element.

Syntax

qbobjectcontrol.XElement[=string]

Default Value

Remarks

The current element is specified via the XPath property.

Data Type

String

XPath Property (QBObject Control)

Provides a way to point to a specific element in the document.

Syntax

qbobjectcontrol.XPath[=string]

Default Value

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML response.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name.
[i]	The i-th subelement of the current element, starting at index 1.
..	the parent of the current element.

When XPath is set to a valid path, XElement points to the name of the element, with XChildren and XText providing other properties of the element.

Example (Setting XPath)


Document root	QBObjectControl.XPath = "/"
Specific Element	QBObjectControl.XPath = "/root/SubElement1/SubElement2/"
i-th Child	QBObjectControl.XPath = "/root/[i]"

You may use the HasXPath method to determine if an xpath exists before setting the XPath property.

This property is not available at design time.

Data Type

String

XText Property (QBObject Control)

The text of the current element.

Syntax

qbobjectcontrol.XText[=string]

Default Value

Remarks

The current element is specified via the XPath property.

Data Type

String

Add Method (QBObject Control)

Adds the record into QuickBooks.

Syntax

qbobjectcontrol.Add

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

AddProperty Method (QBObject Control)

Sets the value of the specified property.

Syntax

qbobjectcontrol.AddProperty PropertyName, PropertyValue

Remarks

This method should be used to specify the object's property values, before invoking Add.

The properties should be specified one by one, in the same order that they are listed in the SDK documentation. All property values should be formatted as a string; aggregate properties should be formatted with XML tags, as appropriate.

The following pseudocode shows how to add a service line item to QuickBooks.

GenericQBObject1.ObjectName = "ItemService" GenericQBObject1.ObjectType = "Txn" GenericQBObject1.AddProperty("Name", "Item name here") GenericQBObject1.AddProperty("SalesOrPurchase", "<AccountRef><FullName>Account name here</FullName></AccountRef>") GenericQBObject1.Add()

CheckRequestStatus Method (QBObject Control)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

qbobjectcontrol.CheckRequestStatus RequestId

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

CloseQBConnection Method (QBObject Control)

Closes a persistent connection to QuickBooks.

Syntax

qbobjectcontrol.CloseQBConnection

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the control will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Config Method (QBObject Control)

Sets or retrieves a configuration setting.

Syntax

qbobjectcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Delete Method (QBObject Control)

Deletes the record from QuickBooks.

Syntax

qbobjectcontrol.Delete

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by the Id. This property may be assigned using AddProperty, by calling Get, or by assigning the value of QBResponseAggregate.

A typical example:

Object.Get("Floor plans") 'this will assign the Id Object.Delete()

Deleting list objects requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Get Method (QBObject Control)

Gets a single record from QuickBooks.

Syntax

qbobjectcontrol.Get Id

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the control will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any control, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch control may be used.

GetByName Method (QBObject Control)

Gets a single record from QuickBooks.

Syntax

qbobjectcontrol.GetByName FullName

Remarks

GetByName may be used to retrieve a single object from QuickBooks, based on its full Name. For Employee and Vendor objects, and for most Customer objects, the full name is given by the Name (CustomerName, VendorName, or EmployeeName property. For Customer objects that represent jobs or sub-customers, the full name will include the parent objects' name(s), and is given by the FullName special field. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the control will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The full name of any control may be used for the parameter. So, for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.GetByName( Invoice.CustomerName )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose name is not known, or to perform more advanced searches the ObjSearch control may be used.

GetProperty Method (QBObject Control)

Gets the value of the specified property.

Syntax

qbobjectcontrol.GetProperty PropertyName

Remarks

This method returns the value of the specified property. If the property value has not been specified, an empty string will be returned.

HasXPath Method (QBObject Control)

Determines whether a specific element exists in the document.

Syntax

qbobjectcontrol.HasXPath xpath

Remarks

The XPath property implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML response.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

Setting the XPath property to an xpath that does not exist will cause an error. You can use the HasXPath method to determine if a particular xpath exists before setting it with XPath.

OpenQBConnection Method (QBObject Control)

Opens a persistent connection to QuickBooks.

Syntax

qbobjectcontrol.OpenQBConnection

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the control communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

ProcessQueue Method (QBObject Control)

Processes the current queue of transactions.

Syntax

qbobjectcontrol.ProcessQueue

Remarks

The QBObject control can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other controls in QBObject, and then call ProcessQueue to send them to QuickBooks. The results will appear in the Results in the same order they were inserted into the Queue. In the Results array properties, the ResultObjName will contain the name of the component required to process each ResultAggregate.

Queue Method (QBObject Control)

Adds a transaction to the queue.

Syntax

qbobjectcontrol.Queue Aggregate

Remarks

The QBObject control can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other controls in QBObject, and then call ProcessQueue to send them to QuickBooks. The results will appear in the ResultAggregate property in the same order they were inserted into the Queue. The number of results returned is indicated by the ResultCount property. The ResultObjName array property will contain the name of the control required to process each ResultAggregate.

Reset Method (QBObject Control)

Resets all properties to their defaults.

Syntax

qbobjectcontrol.Reset

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the control may be reused as if it were newly created.

ResetQueue Method (QBObject Control)

Resets the transaction queue.

Syntax

qbobjectcontrol.ResetQueue

Remarks

Transactions may be added to the queue via the Queue method. However, once added these transactions cannot be modified. If you wish to make a change you must reset the queue and start over again.

SendRawXML Method (QBObject Control)

Sends the provided XML string to the QBXML Request Processor.

Syntax

qbobjectcontrol.SendRawXML XMLString

Remarks

SendRawXML sends the provided XML string to the QuickBooks request processor, and returns the raw, unparsed response. The QB properties determine the parameters of the QuickBooks connection; all other property values will be ignored.

Error checking is performed at the communications (COM) level but not at the QuickBooks level. Use this method with caution, as it will not indicate whether or not the data was successfully processed.

Update Method (QBObject Control)

Updates the entity object in QuickBooks.

Syntax

qbobjectcontrol.Update

Remarks

This method is used to update entity (Customer, Vendor, and Employee) records in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The object represented by RefId will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

One condition must be met for an Update operation to succeed: QuickBooks checks a property called EditSequence. EditSequence is similar to RefId, but is changed every time the object is changed. When an Updateoperation is submitted, the server compares EditSequence with its own EditSequence for the object. If they match, this means that the client program has the latest copy of the object, and the Update operation is permitted. If they don't match, an error will be returned.

If this object represents a value returned from QuickBooks (i.e., a Get or Add call has been made, or the QBResponseAggregate property has been set), the EditSequence will be automatically set. Otherwise this value may be accessed through Config.

Error Event (QBObject Control)

Information about errors during data delivery.

Syntax

Sub qbobjectcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (QBObject Control)

Fired after the server presents its certificate to the client.

Syntax

Sub qbobjectcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (QBObject Control)

Shows the progress of the secure connection.

Syntax

Sub qbobjectcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (QBObject Control)

Shows the progress of the QuickBooks connection.

Syntax

Sub qbobjectcontrol_Status(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (QBObject Control)

Fired when a warning occurs.

Syntax

Sub qbobjectcontrol_Warning(Code As Integer, Description As String)

Remarks

The Warning event is fired when the control has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the control. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.


510*	Object added successfully, but cannot now be read.
520*	Insufficient permissions to get all data.
801	Unable to update field (name).
802	Unable to parse name.

Unlisted QuickBooks warnings will cause the control to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

Config Settings (QBObject Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

QBObject Config Settings

AuthFlags: Connection Flags (use for QuickBooks Simple Start).

Since 2006, QuickBooks has allowed AuthFlags to be set before connecting to QuickBooks. By default, the control can connect to Pro, Premier, and Enterprise editions of QuickBooks. However, because QuickBooks Simple Start contains only a subset of the functionality that other desktop versions provide, Intuit does not allow COM connection to Simple Start unless these AuthFlags explicitly indicate you wish to support it.

A list of allowable AuthFlags is provided below.


"" or 0	Do not send any auth flags
0x01	Support QB Simple Start
0x02	Support QB Pro
0x04	Support QB Premier
0x08	Support QB Enterprise
0x80000000	Force Auth Dialog

To specify support for multiple editions, OR together the values for each edition.

NOTE: If the version of QuickBooks being used does not support AuthFlags, the contents of this config will be ignored. However, if QuickBooks does support this feature, setting "AuthFlags=1" (Support for Simple Start only) on a machine running QuickBooks 2013 Pro will result in an error message indicating that the Request Processor cannot be found.

EnforceMaxLength: Indicates whether to enforce max lengths for QB Fields.

If you change this setting to False, the control will no longer check (or error) when the length of a property exceeds the maximum length specified in the QuickBooks SDK.

GetHighestVersion: Highest QBXMLVersion supported by the installed instance of QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve the highest QBXMLVersion that may be used for sending transactions to QuickBooks.

GetRequestProcessorDLLVersion: Returns the version of the QB Request Processor that is installed on your system.

GetSupportedVersions: Returns a list of QBXMLVersions that are supported by QuickBooks.

If QuickBooks is installed on the system, this setting will retrieve a list of all supported QBXMLVersions that may be used for sending transactions to QuickBooks. While GetHighestVersion config returns only the highest QBXMLVersion supported, this config returns ALL supported QBXMLVersions. The list is delimited with '\n' (linefeed) characters.

IsReadOnly: This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.

The default value is false.

PersonalDataPref: Whether the connecting application will require access to personal data such as SSN or credit card information.

This setting allows you to let the user know immediately whether your application requires access to personal data or not.

A list of available values is provided below.


pdpOptional	Causes the QuickBooks authorization dialog to display a checkbox for user selection asking whether the user wants to allow the application to access personal data.
pdpRequired	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display a warning that the application needs to access personal data.
pdpNotNeeded	Causes the QuickBooks authorization dialog to not display the personal information checkbox for user selection, and instead display an informational message that the application will NOT access personal data.

The default value is pdpOptional.

QBConnectionMode: The mode of connection to QuickBooks.

Specifies whether the integrated application logs in using single-user or multi-user mode.

The following values are permitted:


0	Don't Care
1	Single-User Mode
2	Multi-User Mode

About Single-User and Multi-User Modes

If the connection to QuickBooks is made in single-user mode, QuickBooks will give exclusive access to the connecting application. It will lock out all other integrated applications; if QuickBooks and the company file are not already open in single-user mode by the QuickBooks user, the user will be locked out as well.

If the connection is made in multi-user mode, QuickBooks will allow all other integrated applications access. QuickBooks end users on other machines will also be allowed to access the file. However, if the application (rather than the end user) starts QuickBooks automatically, end users on the same machine will still be locked out.

If cmDontCare is specified, an appropriate connection mode will be chosen automatically. If a company file is open in either single-user or multi-user mode, the integrated application will accept that connection mode. If no company file is open, QuickBooks will login automatically in multi-user mode.

About Integrated and Automatic Login

Note that your application's login to QuickBooks might be either automatic or interactive. Interactive login is used when QuickBooks is already open. Access will be shared between the integrated application and the QuickBooks end user, and if multi-user mode is specified, other applications and users will have access as well. When a connection is made, QuickBooks will show a dialog window to the user, and ask the user if he/she wants to permit the connection.

Automatic login is used when QuickBooks is not already open. QuickBooks will be opened in the background, and will run until your application has finished its connection with QuickBooks. The QuickBooks user interface will not be displayed, and end-users on the same machine will be locked out. End-users on other machines, however, will be allowed access if multi-user mode is specified.

By default integrated applications do not have permission to login automatically. The first time an application interacts with QuickBooks, it must do so interactively, with QuickBooks and the company file open. The QuickBooks end user may then grant automatic login permission through Edit Preferences - Integrated Applications in the QuickBooks user interface. Click on the name of the application and then "Properties", and you may allow the application to login automatically.

For automatic login the CompanyFile must be specified. CompanyFile, ApplicationName, and other properties relating to the QuickBooks connection may be edited through QBConnectionString.

QBFileStatus: The status of the company file as it pertains to accepting connections.

This setting may be queried before attempting to connect to QuickBooks to determine the current company file status. When queried the control will attempt to determine whether a subsequent connection using the provided QBConnectionString value would succeed. Possible return values are:


0	The company file will accept the connection. This indicates that no company file is open, or the desired company file is already open.
1	The company file will not accept the connection. This indicates a different company file is already open.

QBOpenCompanyFile: The file currently open in QuickBooks.

The name of the file currently open in QuickBooks, specified completely with the path. This field is read-only.

A query is submitted to QuickBooks when the value of this property is read. The empty string will be returned if no file is open, if QuickBooks is open in an access mode incompatible with QBConnectionMode, or if an error occurs.

If the value of this property is nonempty, the control may interact exclusively with the open file.

SSLAcceptServerCert: The SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).

The Base-64 encoded certificate being used by the Remote Connector (you may get this certificate from the Remote Connector by going to the Security tab, and clicking Export.)

This is only necessary if using a self-signed certificate, or any other certificate that has not been signed by a Certificate Authority (CA) trusted by the system.

SSLAcceptServerCertFile: The SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).

If your public key certificate is stored in a file, you may set this configuration setting to the full path of the certificate, and it will be immediately read from disk and stored in SSLAcceptServerCert. Equivalent to setting SSLAcceptServerCert to file contents.

Reading the value of this setting will return an empty string.

StopOnError: Specifies how QuickBooks is to proceed if an error occurs in processing of the current request.

If StopOnError is True (default), QuickBooks will stop processing when an error occurs. Requests that have already been processed will not be rolled back. An error is returned for the operation that caused the error condition. If StopOnError is False, QuickBooks will continue processing the remaining requests if an error occurs.

UnattendedModePref: Whether connecting while QuickBooks is closed is required or optional for the user.

This setting allows you to let the user know immediately whether your application requires the ability to access QuickBooks while QuickBooks is closed.

A list of available values is provided below.


umpOptional	Causes the QuickBooks authorization dialog to display its default selections and let the user pick. Use this setting if you do not need unattended mode.
umpRequired	Causes the QuickBooks authorization dialog to display only the selection choices of "No" (no authorization) or "Yes, allow access even if QuickBooks is not running" (authorize unattended mode).

The default value is umpOptional.

WarningCodes: A comma-separated list of QuickBooks warning codes that should not result in an exception.

By default, the control will throw an exception when a status code with severity "Warn" is returned in a QuickBooks response. Set this field to a comma-separated list of status codes that should not throw an exception if returned. Note that the QuickBooks response code is not necessarily the same as the exception code from the resulting exception.

Base Config Settings

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Tells the control whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (QBObject Control)

Errors

The following errors may be generated by the control. Note that frequently the error message will contain more specific information than what is listed here.

QBObject Errors

20102    String too long.
20104    Invalid date format (YYYY-MM-DD is standard).
20105    Invalid value for enumerated field.
20106    Invalid integer.
20107    Invalid dollar amount.
20108    Invalid boolean value (must be 'true' or 'false').
20109    Invalid number.
20112    Invalid special characters in string.
20113    Invalid special field syntax.
20182    Could not load certificate file.
20202    Required field unspecified.
20212    Unsupported field specified.
20302    Array line count must be nonnegative.
20303    Array index out of bounds.
20304    Invalid field index.
20402    Field not accessible as a special field.
20403    Write access attempted of readonly field.
20404    Read access attempted of writeonly field.
20422    The object cannot be modified.
20512    The QBRequestId has been previously used. Please generate a new one.
20602    Could not access QuickBooks.
20603    Could not open specified file.
20604    The version of QuickBooks currently being used is not supported.
20605    QuickBooks has not been installed properly.
20606    The specified file was of an incorrect version.
20607    Could not start QuickBooks.
20608    QuickBooks is open in a mode different than the one requested.
20609    QuickBooks cannot currently be accessed.
20610    An application name must be specified.
20611    A file name must be specified if one is not currently open in QuickBooks.
20612    Access denied.
20613    QuickBooks is busy and cannot open your application in the mode requested.
20700    The connection to QuickBooks has failed for an unknown reason.
20703    The object requested does not exist in QuickBooks.
20752    Unsupported QBXML version.
20753    The QBXMLVersion chosen is insufficient to execute the request.
20802    A QuickBooks internal error has occurred.
20803    QuickBooks is not available due to a system-related problem.
20804    The Id specified is invalid.
20805    Invalid object name.
20806    The name already exists in QuickBooks.
20808    An object could not be found in QuickBooks.
20809    A reference did not refer to an object that exists in QuickBooks.
20810    The object is currently in use by the QuickBooks end user.
20811    The object may not be added.
20812    The object may not be updated because it is obsolete.
20813    The address is invalid.
20814    Permission to perform this operation is not granted.
20815    The request has not been processed.
20816    Time creation mismatch.
20817    The feature is turned off or not enabled.
20818    Permission level configured is insufficient for access.
20819     The item specified was of an unknown type.
20820    The object may not be changed.
20821    An internal QuickBooks error has occurred.
20822    An attempt was made to use a connection that was not properly initiated.
20823    An attempt was made to use a connection that is invalid or was previously closed.
20824    Not enough memory.
20825    Unable to lock the necessary information to allow this application access to the company file. Try again later.
20851    An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
20852    The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
20862    Server error on WebExport (details follow).
20863    The WebExport is impossible: an HTTP context was not found.
20872    You may not set the value of QBConnectionTicket. This value is readonly.
20881    Interrupted by the user.
20882    An error has occurred connecting to a remote machine.
20900    An unknown QuickBooks error has occurred. The message contains more details.
20902    XML Parser Error. Should not occur under normal circumstances.
20900    An XML or other QuickBooks error has occurred.


	20102 String too long.
	20104 Invalid date format (YYYY-MM-DD is standard).
	20105 Invalid value for enumerated field.
	20106 Invalid integer.
	20107 Invalid dollar amount.
	20108 Invalid boolean value (must be 'true' or 'false').
	20109 Invalid number.
	20112 Invalid special characters in string.
	20113 Invalid special field syntax.
	20182 Could not load certificate file.
	20202 Required field unspecified.
	20212 Unsupported field specified.
	20302 Array line count must be nonnegative.
	20303 Array index out of bounds.
	20304 Invalid field index.
	20402 Field not accessible as a special field.
	20403 Write access attempted of readonly field.
	20404 Read access attempted of writeonly field.
	20422 The object cannot be modified.
	20512 The QBRequestId has been previously used. Please generate a new one.
	20602 Could not access QuickBooks.
	20603 Could not open specified file.
	20604 The version of QuickBooks currently being used is not supported.
	20605 QuickBooks has not been installed properly.
	20606 The specified file was of an incorrect version.
	20607 Could not start QuickBooks.
	20608 QuickBooks is open in a mode different than the one requested.
	20609 QuickBooks cannot currently be accessed.
	20610 An application name must be specified.
	20611 A file name must be specified if one is not currently open in QuickBooks.
	20612 Access denied.
	20613 QuickBooks is busy and cannot open your application in the mode requested.
	20700 The connection to QuickBooks has failed for an unknown reason.
	20703 The object requested does not exist in QuickBooks.
	20752 Unsupported QBXML version.
	20753 The QBXMLVersion chosen is insufficient to execute the request.
	20802 A QuickBooks internal error has occurred.
	20803 QuickBooks is not available due to a system-related problem.
	20804 The Id specified is invalid.
	20805 Invalid object name.
	20806 The name already exists in QuickBooks.
	20808 An object could not be found in QuickBooks.
	20809 A reference did not refer to an object that exists in QuickBooks.
	20810 The object is currently in use by the QuickBooks end user.
	20811 The object may not be added.
	20812 The object may not be updated because it is obsolete.
	20813 The address is invalid.
	20814 Permission to perform this operation is not granted.
	20815 The request has not been processed.
	20816 Time creation mismatch.
	20817 The feature is turned off or not enabled.
	20818 Permission level configured is insufficient for access.
	20819 The item specified was of an unknown type.
	20820 The object may not be changed.
	20821 An internal QuickBooks error has occurred.
	20822 An attempt was made to use a connection that was not properly initiated.
	20823 An attempt was made to use a connection that is invalid or was previously closed.
	20824 Not enough memory.
	20825 Unable to lock the necessary information to allow this application access to the company file. Try again later.
	20851 An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	20852 The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	20862 Server error on WebExport (details follow).
	20863 The WebExport is impossible: an HTTP context was not found.
	20872 You may not set the value of QBConnectionTicket. This value is readonly.
	20881 Interrupted by the user.
	20882 An error has occurred connecting to a remote machine.
	20900 An unknown QuickBooks error has occurred. The message contains more details.
	20902 XML Parser Error. Should not occur under normal circumstances.
	20900 An XML or other QuickBooks error has occurred.