QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

LineItemGroups Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class 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 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 get_group_update_aggregate 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 .
group_idReference to a group of line items.
group_nameReference to a group of line items.
group_typeThe type of line item group aggregate to create.
line_idIdentification number of the transaction line group, used for Updates.
item_countThe number of records in the Item arrays.
item_aggregateContains an XML aggregate of the line item.
item_amountLine item property: the total amount of this item.
item_billable_statusLine item property: Billing status of this item.
item_class_idLine item property: Reference to the class of the item.
item_class_nameLine item property: Reference to the class of the item.
item_costLine item property: Unit cost for item.
item_customer_idLine item property: A reference to customer for whom the item was ordered.
item_customer_nameLine item property: A reference to customer for whom the item was ordered.
item_descriptionLine item property: Description of item.
item_idLine item property: Reference to the kind of item.
item_nameLine item property: Reference to the kind of item.
item_line_idIdentification number of the transaction line, used for Updates.
item_manually_closedIndicates if the line item has been manually closed.
item_other1Standard QuickBooks Custom Field available for transaction line items.
item_other2Standard QuickBooks Custom Field available for transaction line items.
item_override_account_idAn account which will override the default account for the line item.
item_override_account_nameAn account which will override the default account for the line item.
item_price_level_idLine Item property: Used to specify custom pricing for specific customers.
item_price_level_nameLine Item property: Specify custom pricing for specific customers.
item_quantityLine item property: Quantity of item or item group.
item_rateUnit rate of item.
item_rate_percentLine item property: A markup or discount percentage.
item_service_dateLine item property: Date of service.
item_tax_code_idLine item property: Sales tax information for this item.
item_tax_code_nameLine item property: Sales tax information for this item.
item_unit_of_measureUnit of measure describing the Quantity .
print_items_in_groupIndicates whether line items will be shown on printed forms.
qbxml_versionThe version of QBXML used to generate the update aggregate.
quantityThe quantity of this line item group.
total_amountThe total amount of this group of line items.
unit_of_measureUnit 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.
get_group_update_aggregateGenerates a group aggregate for use in another class's Update request.
parse_aggregateParses 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.

on_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 Python Edition - Version 20.0 [Build 7941]