EarningsRate Property

Amount employee has earned for this period.

Syntax

 employee.getEarningsRate(index, [callback])
 employee.setEarningsRate(index,  earningsRate, [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 getEarningsRate([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 setEarningsRate([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

Amount employee has earned for this period.

This property contains the dollar amount that the employee has earned for this Earnings item.

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

This property is not available at design time.

Data Type

String