QuickBooks Integrator 2020 Python Edition

Questions / Feedback?

item_aggregate Property

Contains an XML aggregate of the line item.

Syntax

def get_item_aggregate(item_index: int) -> str: ...
def set_item_aggregate(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Contains an XML aggregate of the line item. If the line item has not been modified since receiving a response from QuickBooks, the exact LineRet aggregate that QuickBooks returned will be contained in this XML aggregate. However, if you have made changes to the this line item's properties the item_aggregate property will re-generate the line item XML with the new data.

If you set the other line item properties and then query the item_aggregate, a LineRet aggregate will be generated from the currently set properties.

You may set this property with raw xml. So long as you do not modify any other properties (forcing the line item to regenerate based on new changes), the xml will be sent as-is to the QuickBooks request processor. It is essential that you properly format the XML that you place in this property. When setting this property manually, the class will send exactly what you have set. You must ensure your xml is appropriate for the action you are attempting. For instance, if you are Adding an Invoice, you must ensure the outer tags are "InvoiceLineAdd". If Modifying an Invoice, the outer tags must be "InvoiceLineMod".

If you do not expressly set the item_aggregate field with your own custom XML, all of this will be taken care of you automatically by the class.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

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