4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

LineItemGroups Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DAccountingSDK.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.

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.
LineItemsCollection of line items contained in this group.
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 component with short descriptions. Click on the links for further details.

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

ErrorInformation 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.

BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]