Skip to main content

CreateCompensationRuleDto

namestringrequired
descriptionstring
compensationTypestringrequired

Possible values: [DAILY_WAGE, HOURLY_WAGE, COMMISSION, BONUS, DEDUCTION]

calculationBasisstringrequired

Possible values: [FLAT_RATE, PER_UNIT_PRODUCTION, PERCENTAGE_OUTPUT_VALUE, TIERED_RATE]

ratenumberrequired
unitstring
scopeTypestringrequired

Possible values: [all, role, zone, team, subcontractor, individual]

scopeIdstring

Target entity id. Required when scopeType is not "all" (team/role/zone/subcontractor/individual).

paymentFrequencystringrequired

Possible values: [DAILY, WEEKLY, BI_WEEKLY, MONTHLY]

effectiveStartstringrequired
effectiveEndstring
stackingBehaviorstringrequired

Possible values: [ADDITIVE, EXCLUSIVE]

payoutCapnumber
conditions object
property name*any
CreateCompensationRuleDto
{
"name": "string",
"description": "string",
"compensationType": "DAILY_WAGE",
"calculationBasis": "FLAT_RATE",
"rate": 0,
"unit": "string",
"scopeType": "all",
"scopeId": "string",
"paymentFrequency": "DAILY",
"effectiveStart": "string",
"effectiveEnd": "string",
"stackingBehavior": "ADDITIVE",
"payoutCap": 0,
"conditions": {}
}