/n software QuickBooks qbobject Component : qbobject OCX, qbobject .NET Component, qbobject Class, qbobject Bean, qbobject Object

Available in: QUICKBOOKS

QBObject Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

QBObject is implemented for extensibility, and allows the user to extend the functionality of the component set. The component 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 component does not implement any knowledge of QuickBooks business rules, and simply constructs QBXML based on ObjectName, ObjectType, and the calls to AddProperty. If the component is unable to construct valid QBXML it will typically fail with an uninformative error. In this case, the QBAddRequestAggregate or QBUpdateRequestAggregate properties can be used to inspect the QBXML that is being sent.

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 component with short descriptions. Click on the links for complete descriptions.


ObjectName	The name of the object.
ObjectType	The type of the object - generally List or Txn.
QBAddRequestAggregate	Request aggregate for an Add.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate	Request aggregate for an Update.
QBXMLVersion	The version of QBXML used in the outgoing message.
ResultAggregate	A list of responses from QuickBooks, filled after calling ProcessQueue.
ResultCount	Number of results returned from Quickbooks after calling ProcessQueue.
ResultObjName	Indicates which component is used to parse the corresponding ResultAggregate.
XChildren	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 component with short descriptions. Click on the links for complete descriptions.


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 component 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.
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 component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector