QuickBooks Integrator 2020 C++ Edition

Questions / Feedback?

LineItemGroups Class

Properties   Methods   Events   Configuration 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 property 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.

DescriptionA string description of the item group specified by GroupName or GroupId .
GroupIdReference to a group of line items.
GroupNameReference to a group of line items.
GroupTypeThe type of line item group aggregate to create.
LineIdIdentification number of the transaction line group, used for Updates.
ItemCountThe number of records in the Item arrays.
ItemAggregateContains an XML aggregate of the line item.
ItemAmountLine item property: the total amount of this item.
ItemBillableStatusLine item property: Billing status of this item.
ItemClassIdLine item property: Reference to the class of the item.
ItemClassNameLine item property: Reference to the class of the item.
ItemCostLine item property: Unit cost for item.
ItemCustomerIdLine item property: A reference to customer for whom the item was ordered.
ItemCustomerNameLine item property: A reference to customer for whom the item was ordered.
ItemDescriptionLine item property: Description of item.
ItemIdLine item property: Reference to the kind of item.
ItemNameLine item property: Reference to the kind of item.
ItemLineIdIdentification number of the transaction line, used for Updates.
ItemManuallyClosedIndicates if the line item has been manually closed.
ItemOther1Standard QuickBooks Custom Field available for transaction line items.
ItemOther2Standard QuickBooks Custom Field available for transaction line items.
ItemOverrideAccountIdAn account which will override the default account for the line item.
ItemOverrideAccountNameAn account which will override the default account for the line item.
ItemPriceLevelIdLine Item property: Used to specify custom pricing for specific customers.
ItemPriceLevelNameLine Item property: Specify custom pricing for specific customers.
ItemQuantityLine item property: Quantity of item or item group.
ItemRateUnit rate of item.
ItemRatePercentLine item property: A markup or discount percentage.
ItemServiceDateLine item property: Date of service.
ItemTaxCodeIdLine item property: Sales tax information for this item.
ItemTaxCodeNameLine item property: Sales tax information for this item.
ItemUnitOfMeasureUnit of measure describing the Quantity .
PrintItemsInGroupIndicates whether line items will be shown on printed forms.
QBXMLVersionThe version of QBXML used to generate the update aggregate.
QuantityThe quantity of this line item group.
TotalAmountThe total amount of this group of line items.
UnitOfMeasureUnit 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.

ConfigSets or retrieves a configuration setting.
GetGroupUpdateAggregateGenerates a group aggregate for use in another class's Update request.
ParseAggregateParses the aggregate returned from another class's ItemAggregate property.
ResetResets 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.

ErrorInformation about errors during data delivery.

Configuration Settings


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

BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 C++ Edition - Version 20.0 [Build 7941]