ItemMarkupRatePercent Property

The markup that will be passed on to the customer for this item on this estimate.

Syntax

 estimate.getItemMarkupRatePercent(index, [callback])
 estimate.setItemMarkupRatePercent(index,  itemMarkupRatePercent, [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 getItemMarkupRatePercent([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 setItemMarkupRatePercent([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 markup that will be passed on to the customer for this item on this estimate. Amount, quantity, rate, and markup are related in the following way: ItemAmount = (ItemQuantity * ItemRate) + ItemMarkupRate.

If ItemMarkupRatePercent is specified instead of ItemMarkupRate, then this line item represents a percentage markup or discount, to be applied to the previous Item or Item group.

ItemMarkupRatePercent should be formatted as a positive or negative percentage; a positive value indicates a markup, and both integer and floating point values are supported as string representations.

Only one of ItemMarkupRatePercent and ItemMarkupRate may be specified. If ItemMarkupRatePercent is set, then ItemMarkupRate will be set to its default (and vice-versa).

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

This property is not available at design time.

Data Type

String