BalAmount Property

The value of the current balance.

Syntax

 invstatement.getBalAmount(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 getBalAmount([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 setBalAmount([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 value of the current balance. Interpretation of this depends on the value of BalType property:

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

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

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

Data Type

String