LineItemGroups Class

Properties Methods Events Config Settings Errors

Generates a group aggregate for use in another class's Update request.

Syntax

LineItemGroups

Remarks

There is not exposed a way to directly edit the contents of a line item group when submitting an Update request with a class from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups class is used to parse a line item group aggregate. You may then make changes to the individual line items, and then call the GetGroupUpdateAggregate to return an xml aggregate containing your changes. This is then set to the Aggregate field of the line you wish to modify in your Update.

For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.

Bill.Get("123456"); for (int i = 0; i < Bill1.LineItems.Count; i++) { if (!Bill.LineItems[i].GroupName.Equals("")) { // this is a group line LineItemGroups.GroupType = gtBill; LineItemGroups.ParseAggregate(Bill.LineItems[0].Aggregate); for (int j = 0; j < LineItemGroups.LineItems.Count) { LineItemGroups.LineItems[j].BillableStatus = bsHasBeenBilled; } LineItemGroups.QBXMLVersion = Bill.QBXMLVersion; // so that the proper fields are included in the update aggregate. Bill1.LineItems[i].Aggregate = LineItemGroups.GetGroupUpdateAggregate(); } else { // regular line item Bill.LineItems[i].BillableStatus = bsHasBeenBilled; } } Bill.Update();

Property List

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


Description	A string description of the item group specified by GroupName or GroupId .
GroupId	Reference to a group of line items.
GroupName	Reference to a group of line items.
GroupType	The type of line item group aggregate to create.
LineId	Identification number of the transaction line group, used for Updates.
LineItems	Collection of line items contained in this group.
PrintItemsInGroup	Indicates whether line items will be shown on printed forms.
QBXMLVersion	The version of QBXML used to generate the update aggregate.
Quantity	The quantity of this line item group.
TotalAmount	The total amount of this group of line items.
UnitOfMeasure	Unit of measure describing the Quantity .

Method List

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


Config	Sets or retrieves a configuration setting.
GetGroupUpdateAggregate	Generates a group aggregate for use in another class's Update request.
ParseAggregate	Parses the aggregate returned from another class's ItemAggregate property.
Reset	Resets this class to its default state.

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.


Error	Information about errors during data delivery.

Config Settings

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


BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Description Property (LineItemGroups Class)

A string description of the item group specified by GroupName or GroupId .

Syntax

ANSI (Cross Platform)
char* GetDescription();

Unicode (Windows)
LPWSTR GetDescription();

char* inqb_lineitemgroups_getdescription(void* lpObj);

QString GetDescription();

Default Value

Remarks

This property will contain the description of the group as returned by QuickBooks.

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

Data Type

String

GroupId Property (LineItemGroups Class)

Reference to a group of line items.

Syntax

ANSI (Cross Platform)
char* GetGroupId();
int SetGroupId(const char* lpszGroupId);

Unicode (Windows)
LPWSTR GetGroupId();
INT SetGroupId(LPCWSTR lpszGroupId);

char* inqb_lineitemgroups_getgroupid(void* lpObj);
int inqb_lineitemgroups_setgroupid(void* lpObj, const char* lpszGroupId);

QString GetGroupId();
int SetGroupId(QString qsGroupId);

Default Value

Remarks

Line item groups represent sets of items that are grouped together.

A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.

When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular properties (total Amount, Quantity, and Description), but the line items returned are not normally accessible. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field of the original\ object to use in an Update transaction.

Data Type

String

GroupName Property (LineItemGroups Class)

Reference to a group of line items.

Syntax

ANSI (Cross Platform)
char* GetGroupName();
int SetGroupName(const char* lpszGroupName);

Unicode (Windows)
LPWSTR GetGroupName();
INT SetGroupName(LPCWSTR lpszGroupName);

char* inqb_lineitemgroups_getgroupname(void* lpObj);
int inqb_lineitemgroups_setgroupname(void* lpObj, const char* lpszGroupName);

QString GetGroupName();
int SetGroupName(QString qsGroupName);

Default Value

Remarks

Line item groups represent sets of items that are grouped together.

Data Type

String

GroupType Property (LineItemGroups Class)

The type of line item group aggregate to create.

Syntax

ANSI (Cross Platform)
int GetGroupType();
int SetGroupType(int iGroupType);

Unicode (Windows)
INT GetGroupType();
INT SetGroupType(INT iGroupType);

Possible Values

GT_STANDARD_GROUP(0), 
GT_CREDIT_MEMO(1), 
GT_ESTIMATE(2), 
GT_INVOICE(3), 
GT_PURCHASE_ORDER(4), 
GT_SALES_ORDER(5), 
GT_SALES_RECEIPT(6)

int inqb_lineitemgroups_getgrouptype(void* lpObj);
int inqb_lineitemgroups_setgrouptype(void* lpObj, int iGroupType);

int GetGroupType();
int SetGroupType(int iGroupType);

Default Value

Remarks

This property will be automatically filled after a call to ParseAggregate. The following values are permitted:


gtStandardGroup (0)	Used for the Bill, CCCharge, CCCredit, Check, VendorCredit, and ItemReceipt classs.
gtCreditMemo (1)	Corresponds to the CreditMemo class.
gtEstimate (2)	Corresponds to the Estimate class.
gtInvoice (3)	Corresponds to the Invoice class.
gtPurchaseOrder (4)	Corresponds to the PurchaseOrder class.
gtSalesOrder (5)	Corresponds to the SalesOrder class.
gtSalesReceipt (6)	Corresponds to the SalesReceipt class.

Data Type

Integer

LineId Property (LineItemGroups Class)

Identification number of the transaction line group, used for Updates.

Syntax

ANSI (Cross Platform)
char* GetLineId();
int SetLineId(const char* lpszLineId);

Unicode (Windows)
LPWSTR GetLineId();
INT SetLineId(LPCWSTR lpszLineId);

char* inqb_lineitemgroups_getlineid(void* lpObj);
int inqb_lineitemgroups_setlineid(void* lpObj, const char* lpszLineId);

QString GetLineId();
int SetLineId(QString qsLineId);

Default Value

Remarks

If you need to add a new transaction line group in a transaction Update request, you can do so by setting the LineId to -1.

Data Type

String

LineItems Property (LineItemGroups Class)

Collection of line items contained in this group.

Syntax

InQBList<InQBLineItem>* GetLineItems();
int SetLineItems(InQBList<InQBLineItem>* val);

int inqb_lineitemgroups_getitemcount(void* lpObj);
int inqb_lineitemgroups_setitemcount(void* lpObj, int iItemCount);

char* inqb_lineitemgroups_getitemaggregate(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemaggregate(void* lpObj, int itemindex, const char* lpszItemAggregate);

char* inqb_lineitemgroups_getitemamount(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemamount(void* lpObj, int itemindex, const char* lpszItemAmount);

int inqb_lineitemgroups_getitembillablestatus(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitembillablestatus(void* lpObj, int itemindex, int iItemBillableStatus);

char* inqb_lineitemgroups_getitemclassid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemclassid(void* lpObj, int itemindex, const char* lpszItemClassId);

char* inqb_lineitemgroups_getitemclassname(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemclassname(void* lpObj, int itemindex, const char* lpszItemClassName);

char* inqb_lineitemgroups_getitemcost(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemcost(void* lpObj, int itemindex, const char* lpszItemCost);

char* inqb_lineitemgroups_getitemcustomerid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemcustomerid(void* lpObj, int itemindex, const char* lpszItemCustomerId);

char* inqb_lineitemgroups_getitemcustomername(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemcustomername(void* lpObj, int itemindex, const char* lpszItemCustomerName);

char* inqb_lineitemgroups_getitemdescription(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

char* inqb_lineitemgroups_getitemid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemid(void* lpObj, int itemindex, const char* lpszItemId);

char* inqb_lineitemgroups_getitemname(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

char* inqb_lineitemgroups_getitemlineid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemlineid(void* lpObj, int itemindex, const char* lpszItemLineId);

int inqb_lineitemgroups_getitemmanuallyclosed(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemmanuallyclosed(void* lpObj, int itemindex, int iItemManuallyClosed);

char* inqb_lineitemgroups_getitemother1(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemother1(void* lpObj, int itemindex, const char* lpszItemOther1);

char* inqb_lineitemgroups_getitemother2(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemother2(void* lpObj, int itemindex, const char* lpszItemOther2);

char* inqb_lineitemgroups_getitemoverrideaccountid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemoverrideaccountid(void* lpObj, int itemindex, const char* lpszItemOverrideAccountId);

char* inqb_lineitemgroups_getitemoverrideaccountname(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemoverrideaccountname(void* lpObj, int itemindex, const char* lpszItemOverrideAccountName);

char* inqb_lineitemgroups_getitempricelevelid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitempricelevelid(void* lpObj, int itemindex, const char* lpszItemPriceLevelId);

char* inqb_lineitemgroups_getitempricelevelname(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitempricelevelname(void* lpObj, int itemindex, const char* lpszItemPriceLevelName);

char* inqb_lineitemgroups_getitemquantity(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemquantity(void* lpObj, int itemindex, const char* lpszItemQuantity);

char* inqb_lineitemgroups_getitemrate(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemrate(void* lpObj, int itemindex, const char* lpszItemRate);

char* inqb_lineitemgroups_getitemratepercent(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemratepercent(void* lpObj, int itemindex, const char* lpszItemRatePercent);

char* inqb_lineitemgroups_getitemservicedate(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemservicedate(void* lpObj, int itemindex, const char* lpszItemServiceDate);

char* inqb_lineitemgroups_getitemtaxcodeid(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemtaxcodeid(void* lpObj, int itemindex, const char* lpszItemTaxCodeId);

char* inqb_lineitemgroups_getitemtaxcodename(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemtaxcodename(void* lpObj, int itemindex, const char* lpszItemTaxCodeName);

char* inqb_lineitemgroups_getitemunitofmeasure(void* lpObj, int itemindex);
int inqb_lineitemgroups_setitemunitofmeasure(void* lpObj, int itemindex, const char* lpszItemUnitOfMeasure);

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

QString GetItemAggregate(int iItemIndex);
int SetItemAggregate(int iItemIndex, QString qsItemAggregate);

QString GetItemAmount(int iItemIndex);
int SetItemAmount(int iItemIndex, QString qsItemAmount);

int GetItemBillableStatus(int iItemIndex);
int SetItemBillableStatus(int iItemIndex, int iItemBillableStatus);

QString GetItemClassId(int iItemIndex);
int SetItemClassId(int iItemIndex, QString qsItemClassId);

QString GetItemClassName(int iItemIndex);
int SetItemClassName(int iItemIndex, QString qsItemClassName);

QString GetItemCost(int iItemIndex);
int SetItemCost(int iItemIndex, QString qsItemCost);

QString GetItemCustomerId(int iItemIndex);
int SetItemCustomerId(int iItemIndex, QString qsItemCustomerId);

QString GetItemCustomerName(int iItemIndex);
int SetItemCustomerName(int iItemIndex, QString qsItemCustomerName);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

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

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

QString GetItemLineId(int iItemIndex);
int SetItemLineId(int iItemIndex, QString qsItemLineId);

int GetItemManuallyClosed(int iItemIndex);
int SetItemManuallyClosed(int iItemIndex, int iItemManuallyClosed);

QString GetItemOther1(int iItemIndex);
int SetItemOther1(int iItemIndex, QString qsItemOther1);

QString GetItemOther2(int iItemIndex);
int SetItemOther2(int iItemIndex, QString qsItemOther2);

QString GetItemOverrideAccountId(int iItemIndex);
int SetItemOverrideAccountId(int iItemIndex, QString qsItemOverrideAccountId);

QString GetItemOverrideAccountName(int iItemIndex);
int SetItemOverrideAccountName(int iItemIndex, QString qsItemOverrideAccountName);

QString GetItemPriceLevelId(int iItemIndex);
int SetItemPriceLevelId(int iItemIndex, QString qsItemPriceLevelId);

QString GetItemPriceLevelName(int iItemIndex);
int SetItemPriceLevelName(int iItemIndex, QString qsItemPriceLevelName);

QString GetItemQuantity(int iItemIndex);
int SetItemQuantity(int iItemIndex, QString qsItemQuantity);

QString GetItemRate(int iItemIndex);
int SetItemRate(int iItemIndex, QString qsItemRate);

QString GetItemRatePercent(int iItemIndex);
int SetItemRatePercent(int iItemIndex, QString qsItemRatePercent);

QString GetItemServiceDate(int iItemIndex);
int SetItemServiceDate(int iItemIndex, QString qsItemServiceDate);

QString GetItemTaxCodeId(int iItemIndex);
int SetItemTaxCodeId(int iItemIndex, QString qsItemTaxCodeId);

QString GetItemTaxCodeName(int iItemIndex);
int SetItemTaxCodeName(int iItemIndex, QString qsItemTaxCodeName);

QString GetItemUnitOfMeasure(int iItemIndex);
int SetItemUnitOfMeasure(int iItemIndex, QString qsItemUnitOfMeasure);

Remarks

One or more line items describe the contents of a line item group. Line item groups represent sets of items that are grouped together. A line item group is a predefined shortcut within QuickBooks. For example, a "Cheeseburger Meal" might consist of a cheeseburger, an order of french fries, and a soft drink. To include an item group in a transaction one should simply set the value of ItemGroup, and optionally, of ItemQuantity. QuickBooks will automatically expand the group into its constituent items. This will send an ItemGroup instead of a regular Item on for this index.

When an ItemGroup is returned from QuickBooks it contains xml aggregates of all of the items in the group you specified. You may access the group's regular fields (total Amount, Quantity, and Description), but the line items returned are not accessible with this object. However, you may parse the returned line items by passing the contents of the Aggregate field to the LineItemGroups class. You may use the LineItemGroups class to view or change the contents of the line items, and then pass the xml aggregate generated by the class back to the Aggregate field to use in an Update transaction.

This property is not available at design time.

Data Type

InQBLineItem

PrintItemsInGroup Property (LineItemGroups Class)

Indicates whether line items will be shown on printed forms.

Syntax

ANSI (Cross Platform)
int GetPrintItemsInGroup();

Unicode (Windows)
BOOL GetPrintItemsInGroup();

int inqb_lineitemgroups_getprintitemsingroup(void* lpObj);

bool GetPrintItemsInGroup();

Default Value

FALSE

Remarks

If true, a list of this group's individual items their amounts will appear on printed forms.

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

Data Type

Boolean

QBXMLVersion Property (LineItemGroups Class)

The version of QBXML used to generate the update aggregate.

Syntax

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

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

char* inqb_lineitemgroups_getqbxmlversion(void* lpObj);
int inqb_lineitemgroups_setqbxmlversion(void* lpObj, const char* lpszQBXMLVersion);

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

Default Value

"3.0"

Remarks

This should match the QBXMLVersion of the class you're generating a group line update aggregate for.

This property is not available at design time.

Data Type

String

Quantity Property (LineItemGroups Class)

The quantity of this line item group.

Syntax

ANSI (Cross Platform)
char* GetQuantity();
int SetQuantity(const char* lpszQuantity);

Unicode (Windows)
LPWSTR GetQuantity();
INT SetQuantity(LPCWSTR lpszQuantity);

char* inqb_lineitemgroups_getquantity(void* lpObj);
int inqb_lineitemgroups_setquantity(void* lpObj, const char* lpszQuantity);

QString GetQuantity();
int SetQuantity(QString qsQuantity);

Default Value

Remarks

This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:

class.Quantity = "3"

Leave this field blank and no quantity will be sent to QuickBooks.

Data Type

String

TotalAmount Property (LineItemGroups Class)

The total amount of this group of line items.

Syntax

ANSI (Cross Platform)
char* GetTotalAmount();

Unicode (Windows)
LPWSTR GetTotalAmount();

char* inqb_lineitemgroups_gettotalamount(void* lpObj);

QString GetTotalAmount();

Default Value

Remarks

This field represents the total amount of all transaction lines in the group. This amount will be automatically computed by QuickBooks.

The amount should be formatted as a string in dollars.

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

Data Type

String

UnitOfMeasure Property (LineItemGroups Class)

Unit of measure describing the Quantity .

Syntax

ANSI (Cross Platform)
char* GetUnitOfMeasure();
int SetUnitOfMeasure(const char* lpszUnitOfMeasure);

Unicode (Windows)
LPWSTR GetUnitOfMeasure();
INT SetUnitOfMeasure(LPCWSTR lpszUnitOfMeasure);

char* inqb_lineitemgroups_getunitofmeasure(void* lpObj);
int inqb_lineitemgroups_setunitofmeasure(void* lpObj, const char* lpszUnitOfMeasure);

QString GetUnitOfMeasure();
int SetUnitOfMeasure(QString qsUnitOfMeasure);

Default Value

Remarks

In a transaction line item, the name of the unit of measure selected from within the item's available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!

This property is only available for QBXMLVersion 7.0 and higher.

Data Type

String

Config Method (LineItemGroups Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inqb_lineitemgroups_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.

GetGroupUpdateAggregate Method (LineItemGroups Class)

Generates a group aggregate for use in another class's Update request.

Syntax

ANSI (Cross Platform)
char* GetGroupUpdateAggregate();

Unicode (Windows)
LPWSTR GetGroupUpdateAggregate();

char* inqb_lineitemgroups_getgroupupdateaggregate(void* lpObj);

QString GetGroupUpdateAggregate();

Remarks

For instance, the following code changes the BillableStatus of all line items and line item groups in the Bill retrieved from QuickBooks.

Error Handling (C++)

ParseAggregate Method (LineItemGroups Class)

Parses the aggregate returned from another class's ItemAggregate property.

Syntax

ANSI (Cross Platform)
int ParseAggregate(const char* lpszAggregate);

Unicode (Windows)
INT ParseAggregate(LPCWSTR lpszAggregate);

int inqb_lineitemgroups_parseaggregate(void* lpObj, const char* lpszAggregate);

int ParseAggregate(const QString& qsAggregate);

Remarks

This method takes the XML aggregate returned from any class's ItemAggregate property, and then fills all the properties of this class. For example:

Invoice.Add() For (i = 0 to Invoice.ItemCount - 1) LineItems.ParseAggregate(Invoice.ItemAggregate[0]) Debug.Print(LineItems.ItemName & VbTab & LineItems.Quantity & VbTab & LineItems.Amount) Next

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

Resets this class to its default state.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inqb_lineitemgroups_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties and returns the class to its default state.

Error Handling (C++)

Error Event (LineItemGroups Class)

Information about errors during data delivery.

Syntax

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

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


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

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

#define EID_LINEITEMGROUPS_ERROR 1

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

class LineItemGroupsErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass LineItemGroups and override this emitter function.
virtual int FireError(LineItemGroupsErrorEventParams *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.

LineItem Type

A single line item inside of an Item Group.

Syntax

InQBLineItem (declared in inqb.h)

Remarks

This type of line item is used by the LineItemGroups class, and contains a superset of the fields from all other item types.

The following fields are available:

Fields

Aggregate
char*
Default Value: ""

Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's fields the Aggregate field will re-generate the line item XML with the new data.

If you set the other line item fields and then query the Aggregate, a LineRet aggregate will be generated from the currently set fields.

You may set this field with raw xml. So long as you do not modify any other fields (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this field. When setting this field manually, the class will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod".

If you do not expressly set the Aggregate field with your own custom XML, all of this will be taken care of you automatically by the class.

Amount
char*
Default Value: ""

Line item field: the total amount of this item.

This field represents the total amount of a transaction line. If Rate, Cost and/or Quantity are specified the Amount will be automatically computed by QuickBooks.

Whether Rate or Cost is used will depend on the transaction type. Rate is available for CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, and SalesReceipt transactions while Cost is available for Bill, CCCharge, CCCredit, Check, ItemReceipt, and VendorCredit transactions.

The amount should be formatted as a string in dollars.

BillableStatus
int
Default Value: 0

Line item field: Billing status of this item.

The billing status of this line item. If the billing status is empty (that is, if no billing status appears in QuickBooks), then no BillableStatus value will be returned.

Values:

bsEmpty (0)
bsBillable (1)
bsNotBillable (2)
bsHasBeenBilled (3)

ClassId
char*
Default Value: ""

Line item field: Reference to the class of the item.

A reference to the class of this item.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ClassName
char*
Default Value: ""

Line item field: Reference to the class of the item.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Cost
char*
Default Value: ""

Line item field: Unit cost for item.

The unit cost for this item.

If Amount is specified, then Cost will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

CustomerId
char*
Default Value: ""

Line item property: A reference to customer for whom the item was ordered.

A reference to a Customer for whom this item was ordered.

If this field is set, the expense will be set as billable to the Customer referenced.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

CustomerName
char*
Default Value: ""

Line item field: A reference to customer for whom the item was ordered.

A reference to a Customer for whom this item was ordered.

If this field is set, the expense will be set as billable to the Customer referenced.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

Description
char*
Default Value: ""

Line item field: Description of item.

A string description of the Item specified by ItemName or ItemId.

ItemId
char*
Default Value: ""

Line item field: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

Each line item is represented by a number of properties, each prefixed by Item (see the list of properties for individual classs for details). Properties such as Quantity and Description are always present; some properties are found in only certain types of transactions.

Item is a reference to a kind of item, predefined within QuickBooks. Generally items defined within QuickBooks have default values for Description, etc., and if only Item is set when adding a record to QuickBooks, the other properties will be set automatically.

This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:

Invoice.ItemCount = 3 LineItems.ItemName = "Wingnut" LineItems.Quantity = 8 Invoice.ItemAggregate[0] = LineItems.GetAggregate() LineItems.ItemName = "Shovel" LineItems.Quantity = 1 Invoice.ItemAggregate[1] = LineItems.GetAggregate() LineItems.ItemName = "Mower blade" LineItems.Quantity = 1 Invoice.ItemAggregate[2] = LineItems.GetAggregate()

Items may also be grouped into ItemGroups, using the LineItemGroups class.

ItemName
char*
Default Value: ""

Line item field: Reference to the kind of item.

Line items represent goods or services bought in a QuickBooks transaction.

This class is used to create a single item. However, any InQB class may be set with an unlimited number of these items. For example:

Items may also be grouped into ItemGroups, using the LineItemGroups class.

LineId
char*
Default Value: ""

Identification number of the transaction line, used for Updates.

If you need to add a new transaction line in a transaction Update request, you can do so by setting the LineId to -1.

ManuallyClosed
int
Default Value: 0

Indicates if the line item has been manually closed.

If ManuallyClosed is mcManuallyClosed, the purchase order line has been closed, even if this item has not been received or its sale canceled. If all the purchase order lines are marked as closed, the purchase order itself is marked as closed as well. You cannot change ManuallyClosed to mcNotManuallyClosed after the purchase order line has been fully received. If set to mcNotSet the field is not sent in the request.

Only applicable to Update transactions.

Other1
char*
Default Value: ""

Standard QuickBooks Custom Field available for transaction line items.

The Other1 and Other2 custom fields are available for immediate use: you don't need to enable these in the transaction template to be able to access them via SDK. (However, those Other1 and Other2 fields and their values are viewable and printable in QuickBooks only if the transaction template has these enabled!). QBXMLVersion 6.0 or higher is required to use this field.

Other2
char*
Default Value: ""

Standard QuickBooks Custom Field available for transaction line items.

OverrideAccountId
char*
Default Value: ""

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

OverrideAccountName
char*
Default Value: ""

An account which will override the default account for the line item. QBXMLVersion must be 2.0 or higher to use this configuration setting.

PriceLevelId
char*
Default Value: ""

Line Item field: Used to specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If PriceLevelId and/or PriceLevelName are specified, then Amount will be calculated automatically and should not be specified.

Note that PriceLevelId and PriceLevelName, OR Rate OR RatePercent may be specified. PriceLevelId and PriceLevelName are ONLY available for QBXMLVersions 4.0 and above.

You can use price levels to specify custom pricing for specific customers. 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.)

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the Rate, which was set using the price level.

PriceLevelName
char*
Default Value: ""

Line Item field: Specify custom pricing for specific customers.

Id for the PriceLevel selected for this transaction.

If PriceLevelId and/or PriceLevelName are specified, then Amount will be calculated automatically and should not be specified.

Note that PriceLevelId and PriceLevelName, OR Rate OR RatePercent may be specified. PriceLevelId and PriceLevelName are ONLY available for QBXMLVersions 4.0 and above.

The user can now specify a price level on line items in the following supported sales transactions: invoices, sales receipts, credit memos, and sales orders.

Notice that the response data for the affected sales transaction does not list the price level that was used. The response simply lists the Rate, which was set using the price level.

Quantity
char*
Default Value: ""

Line item field: Quantity of item or item group.

The quantity of the Item specified in this line.

If Quantity and only one of Cost, Rate, or Amount are specified, QuickBooks will automatically calculate the other.

This field is a String type in order to allow setting fractional quantities. Setting this field with non-numeric data will cause an error. Correct usage of this field is shown below:

class.Quantity = "3.5"

Leave this field blank and no quantity will be sent to QuickBooks.

Rate
char*
Default Value: ""

Unit rate of item.

The unit rate charged for this item.

If Amount is specified, then Rate will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

RatePercent
char*
Default Value: ""

Line item field: A markup or discount percentage.

If RatePercent is specified instead of Rate, then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group.

RatePercent should be formatted as a positive or negative integer; a positive value indicates a markup.

Only one of RatePercent and Rate may be specified. If RatePercent is set, then Rate will be set to its default.

ServiceDate
char*
Default Value: ""

Line item field: Date of service.

For Items that represent a service, ServiceDate refers to the date of service. ServiceDate is only applicable for the CreditMemo, Invoice, PurchaseOrder, and SalesReceipt classs.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

TaxCodeId
char*
Default Value: ""

Line item field: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

TaxCodeName
char*
Default Value: ""

Line item field: Sales tax information for this item.

This is a reference to a sales tax code predefined within QuickBooks.

By default, two standard TaxCodes exist: "TAX", or Taxable Sales, and "NON", or Non-Taxable Sales. The QuickBooks user may also define custom tax codes.

Name/Id Reference Properties

Setting the value of this property will set the corresponding Id property to an empty string.

UnitOfMeasure
char*
Default Value: ""

Unit of measure describing the Quantity.

This field is only available for QBXMLVersion 7.0 and higher.

Constructors

LineItem()

InQBList Type

Syntax

InQBList<T> (declared in inqb.h)

Remarks

InQBList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the LineItemGroups class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

Config Settings (LineItemGroups Class)

The class accepts one or more of the following configuration settings. Configuration 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.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (LineItemGroups 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.

LineItemGroups Errors

201	A required field was not specified.
421	Update is not supported for this GroupType.
901	Unable to parse aggregate.
902	Invalid GroupType.