QuickBooks Integrator V6 - Online Help
QuickBooks Integrator V6
Questions / Feedback?

IncludeLineItems Property

Indicates whether to include line items in the response.

Syntax

 objsearch.getIncludeLineItems([callback])
 objsearch.setIncludeLineItems( includeLineItems, [callback])

Default Value

TRUE


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 getIncludeLineItems([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 setIncludeLineItems([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

This filter allows you to omit line items from a query response to get a smaller result. The default value is true, so line items are returned by default. Set IncludeLineItems to false to exclude line items in the response if you don't need to read line item data.

Data Type

Boolean

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0