RateRule

Defines one rule which may be applied to a rate policy.

Name Type Description
id string

name string

The name of the rule.

description string

A description of the rule.

project array of string

A list of projects to which this rule applies (include the value "wildProj" to apply the rule to any project).

code array of string

A list of codes to which this rule applies (include the value "wildCode" to apply the rule to any code).

subcode array of string

A list of subcodes to which this rule applies (include the value "wildSub" to apply the rule to any subcode).

othercode array of string

hours float

The number of hours at which this rule triggers.

timeframe string

One of "TimeSheet", "Day", or "Week" to select the timeframe over which the rule applies.

actionType string

The string "excess" if the rule is applied to excess hours, or "all" if it is applied to all matching hours.

autoreject boolean

If true, sheets matching the rule will be automatically rejected.

reason string

The rejection reason to be applied to automatically rejected sheets.

condition string

The condition matching the target hours: "g", "ge", "e", "lte", or "lt" for greater than, greater or equal, equal, less or equal, or less than, respectively.

days array of string

List of days to which this rule applies.

autoaccrual boolean

If true, sheets matching the rule will cause target hours to be accrued.

accrueitem string

The name of the accrual to use, if autoaccrual is in effect.

descendants boolean

If true, project descendants are automatically included in this rule.