PriceLevel Class

Properties   Methods   Events   Config Settings   Errors  

A PriceLevel is used to specify custom pricing.

Syntax

PriceLevel

Remarks

The PriceLevel class may be used to specify custom pricing for specific customers, however you must have QuickBooks 2005 or greater to use Price Levels. Once you create a price level for a customer, QuickBooks will automatically use the custom price in new invoices, sales receipts, sales orders or credit memos for that customer (you can override this automatic feature, however, when you create the invoices, sales receipts, etc).

With QBXMLVersion set to "4.0" or higher, users can now specify a price level (either added with this component or through QuickBooks) on line items in the following classs: Invoice, SalesReceipt, CreditMemo, and SalesOrder. Please see those classs for more information.

Required Fields (Add): PriceLevelName, PriceLevelFixedPercentage.

Supported Methods: Add, Update, Get (Id), Cancel, Delete

Example PriceLevel1.PriceLevelName = "Employee Discount" PriceLevel1.FixedPercentage = "-15.0" PriceLevel1.Add()

Price Levels may also be added on a per-item basis using the ItemName/ItemId, ItemCustomPrice, ItemCustomPricePercent, ItemAdjustPercentage, and/or ItemAdjustRelativeTo properties. However, this functionality is only supported in the Premier and Enterprise editions of QuickBooks 2005 and greater.

The PriceLevel class supports a variety of other operations as well. The class's Get, Update, Cancel, and Delete methods may be used to retrieve, modify, cancel, and delete PriceLevels, respectively. The ObjSearch Class may be used to search for PriceLevels in the QuickBooks database.

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.

FixedPercentage Property (PriceLevel Class)

Fixed price level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFixedPercentage();
int SetFixedPercentage(const char* lpszFixedPercentage);

Unicode (Windows)
LPWSTR GetFixedPercentage();
INT SetFixedPercentage(LPCWSTR lpszFixedPercentage);

char* inqb_pricelevel_getfixedpercentage(void* lpObj);
int inqb_pricelevel_setfixedpercentage(void* lpObj, const char* lpszFixedPercentage);

QString GetFixedPercentage();
int SetFixedPercentage(QString qsFixedPercentage);

Default Value

""

Remarks

When you create a price level, you must specify whether it is a fixed percentage or a per item price level. Once you create the price level, you cannot change this. QuickBooks Pro and greater versions support fixed percentages, but only QuickBooks Premier and Enterprise support the per item price level.

Where is this discount applied if Price Levels are enabled in QuickBooks preferences? The discount is applied to the sales price of the item. If the price level is applied to a customer, it automatically adjusts the Rate and Amount columns for applicable line items in a QuickBooks Sales Order form, Invoice form, etc. for that customer. The QuickBooks user could still select a different price level. However, the customer price level simply establishes a default price.

If no price level is applied to the customer, then the QuickBooks user can apply a price level by clicking the dropdown list of price levels that appears next to the Rate column. The default in this case is simply the sales price established for the item.

Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%.

Data Type

String

IsActive Property (PriceLevel 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_pricelevel_getisactive(void* lpObj);
int inqb_pricelevel_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

ItemCount Property (PriceLevel Class)

The number of records in the Item arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemCount();
int SetItemCount(int iItemCount);

Unicode (Windows)
INT GetItemCount();
INT SetItemCount(INT iItemCount);

int inqb_pricelevel_getitemcount(void* lpObj);
int inqb_pricelevel_setitemcount(void* lpObj, int iItemCount);

int GetItemCount();
int SetItemCount(int iItemCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAdjustPercentage
• ItemAdjustRelativeTo
• ItemCustomPrice
• ItemCustomPricePercent
• ItemId
• ItemName

The array indices start at 0 and end at ItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemAdjustPercentage Property (PriceLevel Class)

Percentage to adjust price for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemAdjustPercentage(int iItemIndex);
int SetItemAdjustPercentage(int iItemIndex, const char* lpszItemAdjustPercentage);

Unicode (Windows)
LPWSTR GetItemAdjustPercentage(INT iItemIndex);
INT SetItemAdjustPercentage(INT iItemIndex, LPCWSTR lpszItemAdjustPercentage);

char* inqb_pricelevel_getitemadjustpercentage(void* lpObj, int itemindex);
int inqb_pricelevel_setitemadjustpercentage(void* lpObj, int itemindex, const char* lpszItemAdjustPercentage);

QString GetItemAdjustPercentage(int iItemIndex);
int SetItemAdjustPercentage(int iItemIndex, QString qsItemAdjustPercentage);

Default Value

""

Remarks

Percentage to adjust price for this item.

If you don't want to apply a custom price, you can apply an adjusted price discount using the pair of fields ItemAdjustPercentage and ItemAdjustRelativeTo. You specify the price discount in the ItemAdjustPercentagefield and the price to be discounted (standard item price, item cost, or the item's current custom price) in the ItemAdjustRelativeTo field.

Notice that this value supports both positive and negative values. For example, a value of 20 would increase the price by 20% and value of -10 would decrease the price by 10%.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemAdjustRelativeTo Property (PriceLevel Class)

Pricelevel percentage is adjusted relative to this property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemAdjustRelativeTo(int iItemIndex);
int SetItemAdjustRelativeTo(int iItemIndex, int iItemAdjustRelativeTo);

Unicode (Windows)
INT GetItemAdjustRelativeTo(INT iItemIndex);
INT SetItemAdjustRelativeTo(INT iItemIndex, INT iItemAdjustRelativeTo);

A_NOT_SET(0), 
A_STANDARD_PRICE(1), 
A_COST(2), 
A_CURRENT_CUSTOM_PRICE(3)

int inqb_pricelevel_getitemadjustrelativeto(void* lpObj, int itemindex);
int inqb_pricelevel_setitemadjustrelativeto(void* lpObj, int itemindex, int iItemAdjustRelativeTo);

int GetItemAdjustRelativeTo(int iItemIndex);
int SetItemAdjustRelativeTo(int iItemIndex, int iItemAdjustRelativeTo);

Default Value

0

Remarks

Pricelevel percentage is adjusted relative to this property.

When you create a price level, you have the option to create it with a flat custom price (flat amount or percentage) or you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item.

You specify the price discount in the ItemAdjustPercentage field and the price to be discounted (standard item price, item cost, or the item's current custom price) in the ItemAdjustRelativeTo field.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemCustomPrice Property (PriceLevel Class)

Fixed price for this item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCustomPrice(int iItemIndex);
int SetItemCustomPrice(int iItemIndex, const char* lpszItemCustomPrice);

Unicode (Windows)
LPWSTR GetItemCustomPrice(INT iItemIndex);
INT SetItemCustomPrice(INT iItemIndex, LPCWSTR lpszItemCustomPrice);

char* inqb_pricelevel_getitemcustomprice(void* lpObj, int itemindex);
int inqb_pricelevel_setitemcustomprice(void* lpObj, int itemindex, const char* lpszItemCustomPrice);

QString GetItemCustomPrice(int iItemIndex);
int SetItemCustomPrice(int iItemIndex, QString qsItemCustomPrice);

Default Value

""

Remarks

Fixed price for this item.

When you create a price level, you have the option to create it with a custom price that is either a fixed amount (ItemCustomPrice) or a fixed discount percentage (ItemCustomPricePercent).

Alternatively, instead of a flat custom price or discount, you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The amount should be formatted as a string in dollars.

If the ItemCustomPrice property is left empty, no custom price will be sent to QuickBooks.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCustomPricePercent Property (PriceLevel Class)

Discount percentage for each item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemCustomPricePercent(int iItemIndex);
int SetItemCustomPricePercent(int iItemIndex, const char* lpszItemCustomPricePercent);

Unicode (Windows)
LPWSTR GetItemCustomPricePercent(INT iItemIndex);
INT SetItemCustomPricePercent(INT iItemIndex, LPCWSTR lpszItemCustomPricePercent);

char* inqb_pricelevel_getitemcustompricepercent(void* lpObj, int itemindex);
int inqb_pricelevel_setitemcustompricepercent(void* lpObj, int itemindex, const char* lpszItemCustomPricePercent);

QString GetItemCustomPricePercent(int iItemIndex);
int SetItemCustomPricePercent(int iItemIndex, QString qsItemCustomPricePercent);

Default Value

""

Remarks

Discount percentage for each item.

When you create a price level, you have the option to create it with a custom price that is either a fixed amount (ItemCustomPrice) or a fixed discount percentage (ItemCustomPricePercent).

Alternatively, instead of a flat custom price or discount, you could apply a price discount based on either the current custom price, the standard price of the item, or the cost of the item.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemId Property (PriceLevel Class)

Reference to the item this PriceLevel pertains to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemId(int iItemIndex);
int SetItemId(int iItemIndex, const char* lpszItemId);

Unicode (Windows)
LPWSTR GetItemId(INT iItemIndex);
INT SetItemId(INT iItemIndex, LPCWSTR lpszItemId);

char* inqb_pricelevel_getitemid(void* lpObj, int itemindex);
int inqb_pricelevel_setitemid(void* lpObj, int itemindex, const char* lpszItemId);

QString GetItemId(int iItemIndex);
int SetItemId(int iItemIndex, QString qsItemId);

Default Value

""

Remarks

Reference to the item this PriceLevel pertains to.

Price Level line items represent price adjustments on individual items. The ItemId or ItemName represents which item the Price Level is acting on.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (PriceLevel Class)

Reference to the item this PriceLevel pertains to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, const char* lpszItemName);

Unicode (Windows)
LPWSTR GetItemName(INT iItemIndex);
INT SetItemName(INT iItemIndex, LPCWSTR lpszItemName);

char* inqb_pricelevel_getitemname(void* lpObj, int itemindex);
int inqb_pricelevel_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

Default Value

""

Remarks

Reference to the item this PriceLevel pertains to.

Price Level line items represent price adjustments on individual items. The ItemId or ItemName represents which item the Price Level is acting on.

When you create a price level, you must specify whether it is a FixedPercentage or a per item price level. Once you create the price level, you cannot change this. Currently, only QuickBooks Premier and Enterprise support the per item price level.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

PriceLevelName Property (PriceLevel Class)

The name of this price level.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPriceLevelName();
int SetPriceLevelName(const char* lpszPriceLevelName);

Unicode (Windows)
LPWSTR GetPriceLevelName();
INT SetPriceLevelName(LPCWSTR lpszPriceLevelName);

char* inqb_pricelevel_getpricelevelname(void* lpObj);
int inqb_pricelevel_setpricelevelname(void* lpObj, const char* lpszPriceLevelName);

QString GetPriceLevelName();
int SetPriceLevelName(QString qsPriceLevelName);

Default Value

""

Remarks

The unique, case-insensitive name of the PriceLevel.

Data Type

String

PriceLevelType Property (PriceLevel Class)

Indicates the type of PriceLevel returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPriceLevelType();
int SetPriceLevelType(int iPriceLevelType);

Unicode (Windows)
INT GetPriceLevelType();
INT SetPriceLevelType(INT iPriceLevelType);

T_UNSPECIFIED(0), 
T_FIXED_PERCENTAGE(1), 
T_PER_ITEM(2)

int inqb_pricelevel_getpriceleveltype(void* lpObj);
int inqb_pricelevel_setpriceleveltype(void* lpObj, int iPriceLevelType);

int GetPriceLevelType();
int SetPriceLevelType(int iPriceLevelType);

Default Value

0

Remarks

Indicates the type of price level returned in the response - fixed percentage type or per item type (per item types are only supported in Premier or Enterprise).

Data Type

Integer

QBConnectionString Property (PriceLevel 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_pricelevel_getqbconnectionstring(void* lpObj);
int inqb_pricelevel_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

QBRequestAggregate Property (PriceLevel 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_pricelevel_getqbrequestaggregate(void* lpObj);
int inqb_pricelevel_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 (PriceLevel 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_pricelevel_getqbrequestid(void* lpObj);
int inqb_pricelevel_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 (PriceLevel 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_pricelevel_getqbrequestmode(void* lpObj);
int inqb_pricelevel_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 (PriceLevel 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_pricelevel_getqbresponseaggregate(void* lpObj);
int inqb_pricelevel_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 (PriceLevel 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_pricelevel_getqbxmlversion(void* lpObj);
int inqb_pricelevel_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

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

Default Value

"4.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 6.0 for QuickBooks 2007. 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. adhere to a different version of the QuickBooks SDK. These versions are updated with less frequency than the U.S. SDK:

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 (PriceLevel Class)

An alphanumerical identifier generated by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefId();

Unicode (Windows)
LPWSTR GetRefId();

char* inqb_pricelevel_getrefid(void* lpObj);

QString GetRefId();

Default Value

""

Remarks

A RefId 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 required in Update operations, and not used in Add operations.

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

Data Type

String

Add Method (PriceLevel Class)

Adds the record into QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Add();

Unicode (Windows)
INT Add();

int inqb_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel Class)

Closes a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseQBConnection();

Unicode (Windows)
INT CloseQBConnection();

int inqb_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel Class)

Deletes the record from QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Delete();

Unicode (Windows)
INT Delete();

int inqb_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel Class)

Opens a persistent connection to QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int OpenQBConnection();

Unicode (Windows)
INT OpenQBConnection();

int inqb_pricelevel_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 (PriceLevel Class)

Resets all properties to their defaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_pricelevel_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 (PriceLevel 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_pricelevel_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 (PriceLevel Class)

Updates the entity object in QuickBooks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Update();

Unicode (Windows)
INT Update();

int inqb_pricelevel_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 (PriceLevel Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PRICELEVEL_ERROR 1

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

class PriceLevelErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass PriceLevel and override this emitter function.
virtual int FireError(PriceLevelErrorEventParams *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 (PriceLevel Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PRICELEVEL_SSLSERVERAUTHENTICATION 2

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

class PriceLevelSSLServerAuthenticationEventParams {
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(PriceLevelSSLServerAuthenticationEventParams *e);

// Or, subclass PriceLevel and override this emitter function.
virtual int FireSSLServerAuthentication(PriceLevelSSLServerAuthenticationEventParams *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 (PriceLevel Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PRICELEVEL_SSLSTATUS 3

virtual INT INQB_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Status Event (PriceLevel Class)

Shows the progress of the QuickBooks connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PRICELEVEL_STATUS 4

virtual INT INQB_CALL FireStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Warning Event (PriceLevel Class)

Fired when a warning occurs.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_PRICELEVEL_WARNING 5

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

class PriceLevelWarningEventParams {
public:
  int Code();

  const QString &Description();

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

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

// Or, subclass PriceLevel and override this emitter function.
virtual int FireWarning(PriceLevelWarningEventParams *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 (PriceLevel Class)

Trappable Errors (PriceLevel Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

PriceLevel Errors

	101   String too long.
	103   Invalid date format (YYYY-MM-DD is standard).
	104   Invalid value for enumerated field.
	105   Invalid integer.
	106   Invalid dollar amount.
	107   Invalid boolean value (must be 'true' or 'false').
	108   Invalid number.
	111   Invalid special characters in string.
	112   Invalid special field syntax.
	181   Could not load certificate file.
	201   Required field unspecified.
	211   Unsupported field specified.
	301   Array line count must be nonnegative.
	302   Array index out of bounds.
	303   Invalid field index.
	401   Field not accessible as a special field.
	402   Write access attempted of readonly field.
	403   Read access attempted of writeonly field.
	421   The object cannot be modified.
	511   The QBRequestId has been previously used. Please generate a new one.
	601   Could not access QuickBooks.
	602   Could not open specified file.
	603   The version of QuickBooks currently being used is not supported.
	604   QuickBooks has not been installed properly.
	605   The specified file was of an incorrect version.
	606   Could not start QuickBooks.
	607   QuickBooks is open in a mode different than the one requested.
	608   QuickBooks cannot currently be accessed.
	609   An application name must be specified.
	610   A file name must be specified if one is not currently open in QuickBooks.
	611   Access denied.
	612   QuickBooks is busy and cannot open your application in the mode requested.
	699   The connection to QuickBooks has failed for an unknown reason.
	702   The object requested does not exist in QuickBooks.
	751   Unsupported QBXML version.
	752   The QBXMLVersion chosen is insufficient to execute the request.
	801   A QuickBooks internal error has occurred.
	802   QuickBooks is not available due to a system-related problem.
	803   The Id specified is invalid.
	804   Invalid object name.
	805   The name already exists in QuickBooks.
	807   An object could not be found in QuickBooks.
	808   A reference did not refer to an object that exists in QuickBooks.
	809   The object is currently in use by the QuickBooks end user.
	810   The object may not be added.
	811   The object may not be updated because it is obsolete.
	812   The address is invalid.
	813   Permission to perform this operation is not granted.
	814   The request has not been processed.
	815   Time creation mismatch.
	816   The feature is turned off or not enabled.
	817   Permission level configured is insufficient for access.
	818    The item specified was of an unknown type.
	819   The object may not be changed.
	820   An internal QuickBooks error has occurred.
	821   An attempt was made to use a connection that was not properly initiated.
	822   An attempt was made to use a connection that is invalid or was previously closed.
	823   Not enough memory.
	824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861   Server error on WebExport (details follow).
	862   The WebExport is impossible: an HTTP context was not found.
	871   You may not set the value of QBConnectionTicket. This value is readonly.
	880   Interrupted by the user.
	881   An error has occurred connecting to a remote machine.
	899   An unknown QuickBooks error has occurred. The message contains more details.
	901   XML Parser Error. Should not occur under normal circumstances.