BalType Property

The type of balance.

Syntax

 invstatement.getBalType(index, [callback])

Possible Values

  0 (btDOLLAR), 
  1 (btPERCENT), 
  2 (btNUMBER), 
  255 (btOTHER)

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 getBalType([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 setBalType([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

The type of balance. Possible values for balance types and their meanings are as follows:

If a balance list is present in the server response, the BalType is always present in the response for each balance listed.

The size of the array is controlled by the BalCount property.

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

Data Type

Integer