QBObject Component [QuickBooks Integrator V5]
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 GetQBAddRequestAggregate or
GetQBUpdateRequestAggregate methods 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 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. |
| QBRequestId | The Id of the next message to be sent to QuickBooks. |
| QBResponseAggregate | The last XML 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 component 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 component with short
descriptions. Click on the links for further details.
Event List
The following is the full list of the events fired by the component 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. |
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
