QBObject Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class 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 object_name to the name of the object being implemented; for example, "ItemService". Then, set object_type to the type of object: "List" for a list item, or "Txn" for a transaction item. Then, specify each property in order using the add_property method. Finally, invoke add.

To get an object, set object_name and object_type as before, and then invoke get. The object's property values may then be inspected using get_property. 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 object_name, object_type, and the calls to add_property. 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()