QuickBooks Integrator 2020 .NET Edition

Questions / Feedback?

QBObject Component

Properties   Methods   Events   Configuration Settings   Errors  

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")
  "<AccountRef><FullName>Account name here</FullName></AccountRef>")

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

ObjectNameThe name of the object.
ObjectTypeThe type of the object - generally List or Txn.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
ResultsA list of responses from QuickBooks, filled after calling ProcessQueue .
XChildCountNumber of children for the current element.
XElementThe name of the current element.
XPathProvides a way to point to a specific element in the document.
XTextThe 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.

AddAdds the record into QuickBooks.
AddPropertySets the value of the specified property.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetByNameGets a single record from QuickBooks.
GetPropertyGets the value of the specified property.
HasXPathDetermines whether a specific element exists in the document.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ProcessQueueProcesses the current queue of transactions.
QueueAdds a transaction to the queue.
ResetResets all properties to their defaults.
ResetQueueResets the transaction queue.
SendRawXMLSends the provided XML string to the QBXML Request Processor.
UpdateUpdates 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 further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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.

AuthFlagsConnection Flags (use for QuickBooks Simple Start).
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SSLAcceptServerCertThe SSL certificate being used by the QuickBooks Gateway (aka Remote Connector).
SSLAcceptServerCertFileThe SSL certificate file being used by the QuickBooks Gateway (aka Remote Connector).
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 4D Payments Inc. - All rights reserved.
QuickBooks Integrator 2020 .NET Edition - Version 20.0 [Build 8076]