A generic QuickBooks object, allowing users to extend the product's functionality.
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 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()
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.|
|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.|
The following is the full list of the methods of the component 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.|
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.|
The following is a list of configuration settings for the component 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 Remote Connector.|
|SSLAcceptServerCertFile||The SSL certificate file being used by the 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 component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|