QuickBooks Integrator 2020 C++ Edition

Questions / Feedback?

ItemAggregate Property

Contains an XML aggregate of the line item.

Syntax

ANSI (Cross Platform)
char* GetItemAggregate(int iItemIndex);
int SetItemAggregate(int iItemIndex, const char* lpszItemAggregate); Unicode (Windows) LPWSTR GetItemAggregate(INT iItemIndex);
INT SetItemAggregate(INT iItemIndex, LPCWSTR lpszItemAggregate);
- (NSString*)itemAggregate:(int)itemIndex;
- (void)setItemAggregate:(int)itemIndex:(NSString*)newItemAggregate;
#define PID_CCCREDIT_ITEMAGGREGATE 18

INQB_EXTERNAL void* INQB_CALL InQB_CCCredit_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
INQB_EXTERNAL int INQB_CALL InQB_CCCredit_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
INQB_EXTERNAL int INQB_CALL InQB_CCCredit_CheckIndex(void *lpObj, int propid, int arridx);

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 ItemAggregate property will re-generate the line item XML with the new data.

If you set the other line item properties and then query the ItemAggregate, 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 ItemAggregate field with your own custom XML, all of this will be taken care of you automatically by the class.

The ItemIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

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