QBLists Class

Properties   Methods   Events   Config Settings   Errors  

Used to add various List Items.

Syntax

QBLists

Remarks

This class is used to add various List Items into QuickBooks. The QBLists prodtype; can be used to add many different List Items, depending on what the ListType property is set.

Required Fields (Add): QBName. Some ListTypes will have additional required fields.

Supported Methods: Add, Get (Id), Cancel, Delete. Update is supported for SalesRep ItemTypes.

List Items supported:

Example QBLists1.ListType = ltVendorType QBLists1.QBName = "Sewage" QBLists1.ParentName = "Utility" '* (optional) QBLists1.Add '*: Item must already exist in QuickBooks.

The QBLists class supports a variety of other operations as well. The class's Get and Delete methods may be used to retrieve and delete the above list items.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

IsActive Property (QBLists Class)

Whether or not entity is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsActive();
int SetIsActive(int bIsActive);

Unicode (Windows)
BOOL GetIsActive();
INT SetIsActive(BOOL bIsActive);

int inqb_qblists_getisactive(void* lpObj);
int inqb_qblists_setisactive(void* lpObj, int bIsActive);

bool GetIsActive();
int SetIsActive(bool bIsActive);

Default Value

TRUE

Remarks

This property indicates whether this object is currently enabled for use by QuickBooks.

This property is allowed in Add operations, and the QBXMLVersion must be set to "3.0" or higher for this to be used in Update operations.

Data Type

Boolean

IsTaxable Property (QBLists Class)

Indicates whether sales tax is charged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIsTaxable();
int SetIsTaxable(int bIsTaxable);

Unicode (Windows)
BOOL GetIsTaxable();
INT SetIsTaxable(BOOL bIsTaxable);

int inqb_qblists_getistaxable(void* lpObj);
int inqb_qblists_setistaxable(void* lpObj, int bIsTaxable);

bool GetIsTaxable();
int SetIsTaxable(bool bIsTaxable);

Default Value

FALSE

Remarks

Indicates whether this sales-tax code is tracking taxable sales. For any particular sales-tax code, IsTaxable cannot be modified once the sales-tax code has been used in a transaction.

If the "Do You Charge Sales Tax?" preference is set to Yes within QuickBooks, the default value of IsTaxable is true. If the "Do You Charge Sales Tax?" preference is set to No, the default value of IsTaxable is false.

This property is only available when the ListType is set to ltSalesTaxCode. For any other ListType, this property will be ignored.

Data Type

Boolean

ListType Property (QBLists Class)

Indicates the type of List Object to add or query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListType();
int SetListType(int iListType);

Unicode (Windows)
INT GetListType();
INT SetListType(INT iListType);

LT_NOT_SET(0), 
LT_CLASS(1), 
LT_CUSTOMER_TYPE(2), 
LT_JOB_TYPE(3), 
LT_PAYMENT_METHOD(4), 
LT_PAYROLL_ITEM_WAGE(5), 
LT_SALES_TAX_CODE(6), 
LT_SHIP_METHOD(7), 
LT_SALES_REP(8), 
LT_VENDOR_TYPE(9), 
LT_VEHICLE(10), 
LT_STANDARD_TERMS(11), 
LT_DATE_DRIVEN_TERMS(12)

int inqb_qblists_getlisttype(void* lpObj);
int inqb_qblists_setlisttype(void* lpObj, int iListType);

int GetListType();
int SetListType(int iListType);

Default Value

0

Remarks

The types of List Objects are explained below.

Data Type

Integer

ParentId Property (QBLists Class)

Parent Id for this object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParentId();
int SetParentId(const char* lpszParentId);

Unicode (Windows)
LPWSTR GetParentId();
INT SetParentId(LPCWSTR lpszParentId);

char* inqb_qblists_getparentid(void* lpObj);
int inqb_qblists_setparentid(void* lpObj, const char* lpszParentId);

QString GetParentId();
int SetParentId(QString qsParentId);

Default Value

""

Remarks

A reference to the list object that is one level above this one. If either ParentName or ParentId is set to a nonempty string, then this object is a sub-object of its Parent.

This property is available for the following ListTypes: ltClass, ltCustomerType, ltJobType, and ltVendorType.

Data Type

String

ParentName Property (QBLists Class)

Parent Name for this object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParentName();
int SetParentName(const char* lpszParentName);

Unicode (Windows)
LPWSTR GetParentName();
INT SetParentName(LPCWSTR lpszParentName);

char* inqb_qblists_getparentname(void* lpObj);
int inqb_qblists_setparentname(void* lpObj, const char* lpszParentName);

QString GetParentName();
int SetParentName(QString qsParentName);

Default Value

""

Remarks

A reference to the list object that is one level above this one. If either ParentName or ParentId is set to a nonempty string, then this object is a sub-object of its Parent. For example, an Inventory Item with the QBName "Mustang" might have a ParentName of "AmericanCars:Ford".

This property is available for the following ListTypes: ltClass, ltCustomerType, ltJobType, and ltVendorType.

Data Type

String

PayrollAccountId Property (QBLists Class)

Expense account Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayrollAccountId();
int SetPayrollAccountId(const char* lpszPayrollAccountId);

Unicode (Windows)
LPWSTR GetPayrollAccountId();
INT SetPayrollAccountId(LPCWSTR lpszPayrollAccountId);

char* inqb_qblists_getpayrollaccountid(void* lpObj);
int inqb_qblists_setpayrollaccountid(void* lpObj, const char* lpszPayrollAccountId);

QString GetPayrollAccountId();
int SetPayrollAccountId(QString qsPayrollAccountId);

Default Value

""

Remarks

This property refers to the Id of an expense account, and is only available when the ItemType property is set to ltPayrollItemWage. For any other ListType, this property will be ignored.

Data Type

String

PayrollAccountName Property (QBLists Class)

Expense account Name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayrollAccountName();
int SetPayrollAccountName(const char* lpszPayrollAccountName);

Unicode (Windows)
LPWSTR GetPayrollAccountName();
INT SetPayrollAccountName(LPCWSTR lpszPayrollAccountName);

char* inqb_qblists_getpayrollaccountname(void* lpObj);
int inqb_qblists_setpayrollaccountname(void* lpObj, const char* lpszPayrollAccountName);

QString GetPayrollAccountName();
int SetPayrollAccountName(QString qsPayrollAccountName);

Default Value

""

Remarks

This property refers to the name of an expense account, and is only available when the ItemType property is set to ltPayrollItemWage. For any other ListType, this property will be ignored.

Data Type

String

PayrollWageType Property (QBLists Class)

Type type of pay.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayrollWageType();
int SetPayrollWageType(const char* lpszPayrollWageType);

Unicode (Windows)
LPWSTR GetPayrollWageType();
INT SetPayrollWageType(LPCWSTR lpszPayrollWageType);

char* inqb_qblists_getpayrollwagetype(void* lpObj);
int inqb_qblists_setpayrollwagetype(void* lpObj, const char* lpszPayrollWageType);

QString GetPayrollWageType();
int SetPayrollWageType(QString qsPayrollWageType);

Default Value

""

Remarks

The PayrollWageType property is only available when the ListType is set to ltPayrollItemWage;. For any other ListType, this property will be ignored.

Valid values include:

Data Type

String

QBConnectionString Property (QBLists Class)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBConnectionString();
int SetQBConnectionString(const char* lpszQBConnectionString);

Unicode (Windows)
LPWSTR GetQBConnectionString();
INT SetQBConnectionString(LPCWSTR lpszQBConnectionString);

char* inqb_qblists_getqbconnectionstring(void* lpObj);
int inqb_qblists_setqbconnectionstring(void* lpObj, const char* lpszQBConnectionString);

QString GetQBConnectionString();
int SetQBConnectionString(QString qsQBConnectionString);

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

Data Type

String

QBName Property (QBLists Class)

Name of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBName();
int SetQBName(const char* lpszQBName);

Unicode (Windows)
LPWSTR GetQBName();
INT SetQBName(LPCWSTR lpszQBName);

char* inqb_qblists_getqbname(void* lpObj);
int inqb_qblists_setqbname(void* lpObj, const char* lpszQBName);

QString GetQBName();
int SetQBName(QString qsQBName);

Default Value

""

Remarks

This property should contain the case-insensitive name of the object you are adding, not including the names of its ancestors.

When the ListType is set to ltSalesRep, the QBName property will correspond to the initials of a sales representative's name.

Data Type

String

QBRequestAggregate Property (QBLists Class)

The request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestAggregate();
int SetQBRequestAggregate(const char* lpszQBRequestAggregate);

Unicode (Windows)
LPWSTR GetQBRequestAggregate();
INT SetQBRequestAggregate(LPCWSTR lpszQBRequestAggregate);

char* inqb_qblists_getqbrequestaggregate(void* lpObj);
int inqb_qblists_setqbrequestaggregate(void* lpObj, const char* lpszQBRequestAggregate);

QString GetQBRequestAggregate();
int SetQBRequestAggregate(QString qsQBRequestAggregate);

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer class to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

Data Type

String

QBRequestId Property (QBLists Class)

The Id of the next message to be sent to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBRequestId();
int SetQBRequestId(const char* lpszQBRequestId);

Unicode (Windows)
LPWSTR GetQBRequestId();
INT SetQBRequestId(LPCWSTR lpszQBRequestId);

char* inqb_qblists_getqbrequestid(void* lpObj);
int inqb_qblists_setqbrequestid(void* lpObj, const char* lpszQBRequestId);

QString GetQBRequestId();
int SetQBRequestId(QString qsQBRequestId);

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

Data Type

String

QBRequestMode Property (QBLists Class)

Defines whether the request is made online or stored offline.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Unicode (Windows)
INT GetQBRequestMode();
INT SetQBRequestMode(INT iQBRequestMode);

RM_ONLINE(0), 
RM_OFFLINE(1)

int inqb_qblists_getqbrequestmode(void* lpObj);
int inqb_qblists_setqbrequestmode(void* lpObj, int iQBRequestMode);

int GetQBRequestMode();
int SetQBRequestMode(int iQBRequestMode);

Default Value

0

Remarks

This property defines the behavior of the class when calling a method. Possible values are:

The use of offline mode is required when using the QBWCServer class. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer class.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

Data Type

Integer

QBResponseAggregate Property (QBLists Class)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBResponseAggregate();
int SetQBResponseAggregate(const char* lpszQBResponseAggregate);

Unicode (Windows)
LPWSTR GetQBResponseAggregate();
INT SetQBResponseAggregate(LPCWSTR lpszQBResponseAggregate);

char* inqb_qblists_getqbresponseaggregate(void* lpObj);
int inqb_qblists_setqbresponseaggregate(void* lpObj, const char* lpszQBResponseAggregate);

QString GetQBResponseAggregate();
int SetQBResponseAggregate(QString qsQBResponseAggregate);

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

Data Type

String

QBXMLVersion Property (QBLists Class)

The version of QBXML used in the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQBXMLVersion();
int SetQBXMLVersion(const char* lpszQBXMLVersion);

Unicode (Windows)
LPWSTR GetQBXMLVersion();
INT SetQBXMLVersion(LPCWSTR lpszQBXMLVersion);

char* inqb_qblists_getqbxmlversion(void* lpObj);
int inqb_qblists_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

QString GetQBXMLVersion();
int SetQBXMLVersion(QString qsQBXMLVersion);

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Data Type

String

RefId Property (QBLists Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_qblists_getrefid(void* lpObj);

QString GetRefId();

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

This property is read-only and not available at design time.

Data Type

String

SalesRepEntityId Property (QBLists Class)

Sales representative's entity Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSalesRepEntityId();
int SetSalesRepEntityId(const char* lpszSalesRepEntityId);

Unicode (Windows)
LPWSTR GetSalesRepEntityId();
INT SetSalesRepEntityId(LPCWSTR lpszSalesRepEntityId);

char* inqb_qblists_getsalesrepentityid(void* lpObj);
int inqb_qblists_setsalesrepentityid(void* lpObj, const char* lpszSalesRepEntityId);

QString GetSalesRepEntityId();
int SetSalesRepEntityId(QString qsSalesRepEntityId);

Default Value

""

Remarks

Refers to the sales representative's full information on the Employee, Vendor, or OtherName list.

Data Type

String

SalesRepEntityName Property (QBLists Class)

Sales representative's entity name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSalesRepEntityName();
int SetSalesRepEntityName(const char* lpszSalesRepEntityName);

Unicode (Windows)
LPWSTR GetSalesRepEntityName();
INT SetSalesRepEntityName(LPCWSTR lpszSalesRepEntityName);

char* inqb_qblists_getsalesrepentityname(void* lpObj);
int inqb_qblists_setsalesrepentityname(void* lpObj, const char* lpszSalesRepEntityName);

QString GetSalesRepEntityName();
int SetSalesRepEntityName(QString qsSalesRepEntityName);

Default Value

""

Remarks

Refers to the sales representative's full information on the Employee, Vendor, or OtherName list.

Data Type

String

TaxCodeDescription Property (QBLists Class)

Longer explanation of QBName .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaxCodeDescription();
int SetTaxCodeDescription(const char* lpszTaxCodeDescription);

Unicode (Windows)
LPWSTR GetTaxCodeDescription();
INT SetTaxCodeDescription(LPCWSTR lpszTaxCodeDescription);

char* inqb_qblists_gettaxcodedescription(void* lpObj);
int inqb_qblists_settaxcodedescription(void* lpObj, const char* lpszTaxCodeDescription);

QString GetTaxCodeDescription();
int SetTaxCodeDescription(QString qsTaxCodeDescription);

Default Value

""

Remarks

This property is only available when the ListType is set to ltSalesTaxCode. For any other ListType, this property will be ignored.

Data Type

String

TermsDiscountDay Property (QBLists Class)

If the bill is paid within this period, a discount applies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTermsDiscountDay();
int SetTermsDiscountDay(int iTermsDiscountDay);

Unicode (Windows)
INT GetTermsDiscountDay();
INT SetTermsDiscountDay(INT iTermsDiscountDay);

int inqb_qblists_gettermsdiscountday(void* lpObj);
int inqb_qblists_settermsdiscountday(void* lpObj, int iTermsDiscountDay);

int GetTermsDiscountDay();
int SetTermsDiscountDay(int iTermsDiscountDay);

Default Value

0

Remarks

For the ltStandardTerms ListType, if payment is received within this number of days, then TermsDiscountPercent will apply to the payment. For the ltDateDrivenTerms ListType, if payment is made by this day of the month, then TermsDiscountPercent applies.

Data Type

Integer

TermsDiscountPercent Property (QBLists Class)

Discount that applies to a payment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTermsDiscountPercent();
int SetTermsDiscountPercent(const char* lpszTermsDiscountPercent);

Unicode (Windows)
LPWSTR GetTermsDiscountPercent();
INT SetTermsDiscountPercent(LPCWSTR lpszTermsDiscountPercent);

char* inqb_qblists_gettermsdiscountpercent(void* lpObj);
int inqb_qblists_settermsdiscountpercent(void* lpObj, const char* lpszTermsDiscountPercent);

QString GetTermsDiscountPercent();
int SetTermsDiscountPercent(QString qsTermsDiscountPercent);

Default Value

""

Remarks

If payment is received within the TermsDiscountDay period, then TermsDiscountPercent will apply to the payment. TermsDiscountPercent must be between 0 and 100.

Data Type

String

TermsDueDay Property (QBLists Class)

Indicates when payment is due.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTermsDueDay();
int SetTermsDueDay(int iTermsDueDay);

Unicode (Windows)
INT GetTermsDueDay();
INT SetTermsDueDay(INT iTermsDueDay);

int inqb_qblists_gettermsdueday(void* lpObj);
int inqb_qblists_settermsdueday(void* lpObj, int iTermsDueDay);

int GetTermsDueDay();
int SetTermsDueDay(int iTermsDueDay);

Default Value

0

Remarks

For the ltStandardTerms ListType, this property indicates the number of days until payment is due with no discount. For the ltDateDrivenTerms ListType, it indicates the day of the month payment is due with no discount.

Data Type

Integer

Add Method (QBLists Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_qblists_add(void* lpObj);

int Add();

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckRequestStatus Method (QBLists Class)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CheckRequestStatus(const char* lpszRequestId);

Unicode (Windows)
LPWSTR CheckRequestStatus(LPCWSTR lpszRequestId);

char* inqb_qblists_checkrequeststatus(void* lpObj, const char* lpszRequestId);

QString CheckRequestStatus(const QString& qsRequestId);

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CloseQBConnection Method (QBLists Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_qblists_closeqbconnection(void* lpObj);

int CloseQBConnection();

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the class will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (QBLists Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_qblists_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Delete Method (QBLists Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_qblists_delete(void* lpObj);

int Delete();

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Get Method (QBLists Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Get(const char* lpszId);

Unicode (Windows)
INT Get(LPCWSTR lpszId);

int inqb_qblists_get(void* lpObj, const char* lpszId);

int Get(const QString& qsId);

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any class, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetByName Method (QBLists Class)

Gets a single record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetByName(const char* lpszFullName);

Unicode (Windows)
INT GetByName(LPCWSTR lpszFullName);

int inqb_qblists_getbyname(void* lpObj, const char* lpszFullName);

int GetByName(const QString& qsFullName);

Remarks

GetByName may be used to retrieve a single object from QuickBooks, based on its full Name. For Employee and Vendor objects, and for most Customer objects, the full name is given by the Name (CustomerName, VendorName, or EmployeeName property. For Customer objects that represent jobs or sub-customers, the full name will include the parent objects' name(s), and is given by the FullName special field. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the class will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The full name of any class may be used for the parameter. So, for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.GetByName( Invoice.CustomerName )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose name is not known, or to perform more advanced searches the ObjSearch class may be used.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCustomField Method (QBLists Class)

Gets a custom field value from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomField(const char* lpszFieldName);

Unicode (Windows)
LPWSTR GetCustomField(LPCWSTR lpszFieldName);

char* inqb_qblists_getcustomfield(void* lpObj, const char* lpszFieldName);

QString GetCustomField(const QString& qsFieldName);

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ImportQBXML Method (QBLists Class)

Imports a QBXML response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportQBXML(const char* lpszXMLData);

Unicode (Windows)
INT ImportQBXML(LPCWSTR lpszXMLData);

int inqb_qblists_importqbxml(void* lpObj, const char* lpszXMLData);

int ImportQBXML(const QString& qsXMLData);

Remarks

This method imports a QBXML response aggregate. When called with a QBXML aggregate, such as a response from ObjSearch or QBWCServer the class will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

OpenQBConnection Method (QBLists Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_qblists_openqbconnection(void* lpObj);

int OpenQBConnection();

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the class communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (QBLists Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_qblists_reset(void* lpObj);

int Reset();

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the class may be reused as if it were newly created.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetCustomField Method (QBLists Class)

Sets a custom field value within QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetCustomField(const char* lpszFieldName, const char* lpszFieldValue);

Unicode (Windows)
INT SetCustomField(LPCWSTR lpszFieldName, LPCWSTR lpszFieldValue);

int inqb_qblists_setcustomfield(void* lpObj, const char* lpszFieldName, const char* lpszFieldValue);

int SetCustomField(const QString& qsFieldName, const QString& qsFieldValue);

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Update Method (QBLists Class)

Updates the entity object in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_qblists_update(void* lpObj);

int Update();

Remarks

This method is used to update entity (Customer, Vendor, and Employee) records in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The object represented by RefId will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

One condition must be met for an Update operation to succeed: QuickBooks checks a property called EditSequence. EditSequence is similar to RefId, but is changed every time the object is changed. When an Updateoperation is submitted, the server compares EditSequence with its own EditSequence for the object. If they match, this means that the client program has the latest copy of the object, and the Update operation is permitted. If they don't match, an error will be returned.

If this object represents a value returned from QuickBooks (i.e., a Get or Add call has been made, or the QBResponseAggregate property has been set), the EditSequence will be automatically set. Otherwise this value may be accessed through Config.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (QBLists Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(QBListsErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} QBListsErrorEventParams;


Unicode (Windows)
virtual INT FireError(QBListsErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} QBListsErrorEventParams;

#define EID_QBLISTS_ERROR 1

virtual INT INQB_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class QBListsErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(QBListsErrorEventParams *e);

// Or, subclass QBLists and override this emitter function.
virtual int FireError(QBListsErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (QBLists Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(QBListsSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} QBListsSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(QBListsSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} QBListsSSLServerAuthenticationEventParams;

#define EID_QBLISTS_SSLSERVERAUTHENTICATION 2

virtual INT INQB_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class QBListsSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(QBListsSSLServerAuthenticationEventParams *e);

// Or, subclass QBLists and override this emitter function.
virtual int FireSSLServerAuthentication(QBListsSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (QBLists Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(QBListsSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} QBListsSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(QBListsSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} QBListsSSLStatusEventParams;

#define EID_QBLISTS_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

class QBListsSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(QBListsSSLStatusEventParams *e);

// Or, subclass QBLists and override this emitter function.
virtual int FireSSLStatus(QBListsSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (QBLists Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(QBListsStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} QBListsStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(QBListsStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} QBListsStatusEventParams;

#define EID_QBLISTS_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

class QBListsStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(QBListsStatusEventParams *e);

// Or, subclass QBLists and override this emitter function.
virtual int FireStatus(QBListsStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (QBLists Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireWarning(QBListsWarningEventParams *e);

typedef struct {
  int Code;
  const char *Description;
  int reserved;
} QBListsWarningEventParams;


Unicode (Windows)
virtual INT FireWarning(QBListsWarningEventParams *e);

typedef struct {
  INT Code;
  LPCWSTR Description;
  INT reserved;
} QBListsWarningEventParams;

#define EID_QBLISTS_WARNING 5

virtual INT INQB_CALL FireWarning(INT &iCode, LPSTR &lpszDescription);

class QBListsWarningEventParams {
public:
  int Code();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Warning(QBListsWarningEventParams *e);

// Or, subclass QBLists and override this emitter function.
virtual int FireWarning(QBListsWarningEventParams *e) {...}

Remarks

The Warning event is fired when the class has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the class. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Unlisted QuickBooks warnings will cause the class to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

Config Settings (QBLists Class)