ResultAggregate Property

One response XML aggregate returned from QuickBooks.

Syntax

 qbobject.getResultAggregate(index, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getResultAggregate([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setResultAggregate([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

One response XML aggregate returned from QuickBooks.

The QBObject class can be used to queue multiple transactions for batch processing with QuickBooks. Use the Queue method to store QBAddAggregate or QBUpdateAggregate structures from other classs in QBObject, and then call ProcessQueue to send them to QuickBooks. The results will appear in the ResultAggregate array property in the same order they were inserted into the Queue. The number of results returned is indicated by the ResultCount property. The ResultObjName array property will contain the name of the component required to process each ResultAggregate.

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

This property is read-only and not available at design time.

Data Type

String