QuickBooks Integrator 2020 C++ Edition

Questions / Feedback?

GetGroupUpdateAggregate Method

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

Syntax

ANSI (Cross Platform)
char* GetGroupUpdateAggregate();

Unicode (Windows)
LPWSTR GetGroupUpdateAggregate();
- (NSString*)getGroupUpdateAggregate;
#define MID_LINEITEMGROUPS_GETGROUPUPDATEAGGREGATE 3

INQB_EXTERNAL int INQB_CALL InQB_LineItemGroups_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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();

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.

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