LineItemGroups Component
Properties Methods Events Configuration Settings Errors
Generates a group aggregate for use in another component's Update request.
Syntax
inqb.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 component from this package. You can change the Quantity, but you cannot change the line items contained inside the group line. The LineItemGroups component 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 component 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 component 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 component's Update request. |
ParseAggregate | Parses the aggregate returned from another component's ItemAggregate property. |
Reset | Resets this component to its default state. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the component are daemon threads. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |