SettleAmount Property

The final settlement amount.

Syntax

 tsyshcadjustment.getSettleAmount([callback])
 tsyshcadjustment.setSettleAmount( settleAmount, [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 getSettleAmount([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 setSettleAmount([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 is used to specify the final settlement (transaction) amount.

Note: The final settlement amount can only be decreased. Thus SettlementAmount must be less than OriginalAmount. If you do not wish to adjust the settlement amount, you can should not set SettlementAmount.

Data Type

String