DepositLineAmount Property

The total amount of this deposit line item.

Syntax

 deposit.getDepositLineAmount(index, [callback])
 deposit.setDepositLineAmount(index,  depositLineAmount, [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 getDepositLineAmount([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 setDepositLineAmount([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 total amount of this deposit line item. This should be a positive number.

The amount should be formatted as a string in dollars.

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

This property is not available at design time.

Data Type

String