QBObject Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

inqb.Qbobject

Remarks

QBObject is implemented for extensibility, and allows the user to extend the functionality of the class set. The class 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 class does not implement any knowledge of QuickBooks business rules, and simply constructs QBXML based on ObjectName, ObjectType, and the calls to AddProperty. If the class 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 class 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.
Results	A list of responses from QuickBooks, filled after calling ProcessQueue .
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 class 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 class 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 class 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.
BuildInfo	Information about the product's build.
GUIAvailable	Tells the class whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

ObjectName Property (QBObject Class)

The name of the object.

Syntax

public String getObjectName();


public void setObjectName(String objectName);

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.

ObjectType Property (QBObject Class)

The type of the object - generally List or Txn.

Syntax

public String getObjectType();


public void setObjectType(String objectType);

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.

QBConnectionString Property (QBObject Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

public String getQBConnectionString();


public void setQBConnectionString(String QBConnectionString);

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 class 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 class'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 class 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 class throws an exception.
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 class throws an exception.
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 class binds.
UseRDS	Whether to connect using Remote Data Sharing (RDS). If set to True, the class 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.

QBRequestAggregate Property (QBObject Class)

The request aggregate.

Syntax

public String getQBRequestAggregate();


public void setQBRequestAggregate(String QBRequestAggregate);

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 class to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

QBRequestId Property (QBObject Class)

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

Syntax

public String getQBRequestId();


public void setQBRequestId(String QBRequestId);

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.

QBRequestMode Property (QBObject Class)

Defines whether the request is made online or stored offline.

Syntax

public int getQBRequestMode();


public void setQBRequestMode(int QBRequestMode);


Enumerated values:
  public final static int rmOnline = 0;
  public final static int rmOffline = 1;

Default Value

0

Remarks

This property defines the behavior of the class 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 class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

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

QBResponseAggregate Property (QBObject Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

public String getQBResponseAggregate();


public void setQBResponseAggregate(String QBResponseAggregate);

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 class 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.

QBXMLVersion Property (QBObject Class)

The version of QBXML used in the outgoing message.

Syntax

public String getQBXMLVersion();


public void setQBXMLVersion(String QBXMLVersion);

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.

Results Property (QBObject Class)

A list of responses from QuickBooks, filled after calling ProcessQueue .

Syntax

public QBObjectResultList getResults();

Remarks

The QBObject class can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other classs 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. The ObjName collection will contain the name of the component required to process each Aggregate.

Note that setting the QBResponseAggregate will also fill out the Results property.

This property is read-only.

XChildCount Property (QBObject Class)

Number of children for the current element.

Syntax

public int getXChildCount();

Default Value

0

Remarks

The current element is specified via the XPath property.

This property is read-only.

XElement Property (QBObject Class)

The name of the current element.

Syntax

public String getXElement();


public void setXElement(String XElement);

Default Value

""

Remarks

The current element is specified via the XPath property.

XPath Property (QBObject Class)

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

Syntax

public String getXPath();


public void setXPath(String XPath);

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.

XText Property (QBObject Class)

The text of the current element.

Syntax

public String getXText();


public void setXText(String XText);

Default Value

""

Remarks

The current element is specified via the XPath property.

Add Method (Qbobject Class)

Adds the record into QuickBooks.

Syntax

public void 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 Class)

Sets the value of the specified property.

Syntax

public void addProperty(String propertyName, String 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 Class)

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

Syntax

public String checkRequestStatus(String 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 Class)

Closes a persistent connection to QuickBooks.

Syntax

public void closeQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class 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 Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

Deletes the record from QuickBooks.

Syntax

public void 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 Class)

Gets a single record from QuickBooks.

Syntax

public void get(String 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 class 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 class, 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 class may be used.

GetByName Method (Qbobject Class)

Gets a single record from QuickBooks.

Syntax

public void getByName(String 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 class 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 class 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 class may be used.

GetProperty Method (Qbobject Class)

Gets the value of the specified property.

Syntax

public String getProperty(String 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 Class)

Determines whether a specific element exists in the document.

Syntax

public boolean hasXPath(String 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 Class)

Opens a persistent connection to QuickBooks.

Syntax

public void 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 class 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 Class)

Processes the current queue of transactions.

Syntax

public void processQueue();

Remarks

The QBObject class can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other classs 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 collection , the ObjName will contain the name of the component required to process each Aggregate.

Queue Method (Qbobject Class)

Adds a transaction to the queue.

Syntax

public void queue(String aggregate);

Remarks

The QBObject class can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other classs in QBObject, and then call ProcessQueue to send them to QuickBooks. The results will appear in the Results collection in the same order they were inserted into the Queue. The XML aggregate will be stored in Aggregate, and the ObjName field will indicate the name of the class required to process each Aggregate.

Reset Method (Qbobject Class)

Resets all properties to their defaults.

Syntax

public void reset();

Remarks

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

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

ResetQueue Method (Qbobject Class)

Resets the transaction queue.

Syntax

public void 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 Class)

Sends the provided XML string to the QBXML Request Processor.

Syntax

public String sendRawXML(String 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 Class)

Updates the entity object in QuickBooks.

Syntax

public void 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 Class)

Information about errors during data delivery.

Syntax

public class DefaultQbobjectEventListener implements QbobjectEventListener {
  ...
  public void error(QbobjectErrorEvent e) {}
  ...
}

public class QbobjectErrorEvent {
  public int errorCode;
  public String description;
}

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 Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultQbobjectEventListener implements QbobjectEventListener {
  ...
  public void SSLServerAuthentication(QbobjectSSLServerAuthenticationEvent e) {}
  ...
}

public class QbobjectSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

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 Class)

Shows the progress of the secure connection.

Syntax

public class DefaultQbobjectEventListener implements QbobjectEventListener {
  ...
  public void SSLStatus(QbobjectSSLStatusEvent e) {}
  ...
}

public class QbobjectSSLStatusEvent {
  public String message;
}

Remarks

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

Status Event (Qbobject Class)

Shows the progress of the QuickBooks connection.

Syntax

public class DefaultQbobjectEventListener implements QbobjectEventListener {
  ...
  public void status(QbobjectStatusEvent e) {}
  ...
}

public class QbobjectStatusEvent {
  public String message;
}

Remarks

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

Warning Event (Qbobject Class)

Fired when a warning occurs.

Syntax

public class DefaultQbobjectEventListener implements QbobjectEventListener {
  ...
  public void warning(QbobjectWarningEvent e) {}
  ...
}

public class QbobjectWarningEvent {
  public int code;
  public String description;
}

Remarks

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

Warnings may be generated by QuickBooks or the class. 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 class 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.

QBObjectResult Type

Results of a transaction made with the QBOBJECT class.

Remarks

This type contains a single result after issuing a search with the ObjSearch class. The Aggregate field contains the XML result aggregate, and ObjName indicates the class you must use to parse it.

Fields

Aggregate String	One response XML aggregate returned from QuickBooks. The result to a transaction made with the QBObject class. The ObjName field will indicate which class must be used to parse this Aggregate.
ObjName String	Indicates which component is used to parse the corresponding Aggregate. The ObjName field will contain the name of the component required to process the corresponding Aggregate.

Constructors

public QBObjectResult();

Config Settings (Qbobject Class)

The class 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 class, 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 class 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 class 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 class 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 class 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 class 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

BuildInfo:   Information about the product's build. When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the class whether or not a message loop is available for processing events. In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server). Last Valid Build: The last valid build number for which the license will work.

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 true to mask sensitive data. The default is true. This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseDaemonThreads:   Whether threads created by the class are daemon threads. If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. This setting is set to false by default on all platforms.

Trappable Errors (Qbobject Class)

Errors

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

QBObject Errors

	101   String too long.
	103   Invalid date format (YYYY-MM-DD is standard).
	104   Invalid value for enumerated field.
	105   Invalid integer.
	106   Invalid dollar amount.
	107   Invalid boolean value (must be 'true' or 'false').
	108   Invalid number.
	111   Invalid special characters in string.
	112   Invalid special field syntax.
	181   Could not load certificate file.
	201   Required field unspecified.
	211   Unsupported field specified.
	301   Array line count must be nonnegative.
	302   Array index out of bounds.
	303   Invalid field index.
	401   Field not accessible as a special field.
	402   Write access attempted of readonly field.
	403   Read access attempted of writeonly field.
	421   The object cannot be modified.
	511   The QBRequestId has been previously used. Please generate a new one.
	601   Could not access QuickBooks.
	602   Could not open specified file.
	603   The version of QuickBooks currently being used is not supported.
	604   QuickBooks has not been installed properly.
	605   The specified file was of an incorrect version.
	606   Could not start QuickBooks.
	607   QuickBooks is open in a mode different than the one requested.
	608   QuickBooks cannot currently be accessed.
	609   An application name must be specified.
	610   A file name must be specified if one is not currently open in QuickBooks.
	611   Access denied.
	612   QuickBooks is busy and cannot open your application in the mode requested.
	699   The connection to QuickBooks has failed for an unknown reason.
	702   The object requested does not exist in QuickBooks.
	751   Unsupported QBXML version.
	752   The QBXMLVersion chosen is insufficient to execute the request.
	801   A QuickBooks internal error has occurred.
	802   QuickBooks is not available due to a system-related problem.
	803   The Id specified is invalid.
	804   Invalid object name.
	805   The name already exists in QuickBooks.
	807   An object could not be found in QuickBooks.
	808   A reference did not refer to an object that exists in QuickBooks.
	809   The object is currently in use by the QuickBooks end user.
	810   The object may not be added.
	811   The object may not be updated because it is obsolete.
	812   The address is invalid.
	813   Permission to perform this operation is not granted.
	814   The request has not been processed.
	815   Time creation mismatch.
	816   The feature is turned off or not enabled.
	817   Permission level configured is insufficient for access.
	818    The item specified was of an unknown type.
	819   The object may not be changed.
	820   An internal QuickBooks error has occurred.
	821   An attempt was made to use a connection that was not properly initiated.
	822   An attempt was made to use a connection that is invalid or was previously closed.
	823   Not enough memory.
	824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861   Server error on WebExport (details follow).
	862   The WebExport is impossible: an HTTP context was not found.
	871   You may not set the value of QBConnectionTicket. This value is readonly.
	880   Interrupted by the user.
	881   An error has occurred connecting to a remote machine.
	899   An unknown QuickBooks error has occurred. The message contains more details.
	901   XML Parser Error. Should not occur under normal circumstances.
	899   An XML or other QuickBooks error has occurred.