GroupType Property

The type of line item group aggregate to create.

Syntax

 lineitemgroups.getGroupType([callback])
 lineitemgroups.setGroupType( groupType, [callback])

Possible Values

  0 (gtStandardGroup), 
  1 (gtCreditMemo), 
  2 (gtEstimate), 
  3 (gtInvoice), 
  4 (gtPurchaseOrder), 
  5 (gtSalesOrder), 
  6 (gtSalesReceipt)

Default Value

0

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 getGroupType([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 setGroupType([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 property will be automatically filled after a call to ParseAggregate. The following values are permitted:

Data Type

Integer