Rate Property

Unit rate of item.

Syntax

 statementcharge.getRate([callback])
 statementcharge.setRate( rate, [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 getRate([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 setRate([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 rate of the Item (specified by ItemId or ItemName) you're adding to the statement.

If Amount and Quantity are specified, then Rate will be calculated automatically and should not be specified.

The amount should be formatted as a string in dollars.

Data Type

String