VariableComp

A datatype used to represent target variable comp, typically paid on an annual basis.
Variable comp comes in two pay types, denoted by the compType property:
Amount - a fixed monetary amount (for example, a $100,000 target commission)
Percent - a percentage, usually of base salary (for example, a 10% bonus)
Properties
Property
Type
Description
amount
﻿Number﻿ 
The amount of money, without the currency (same as pay.amount), ornull for percentage comp.
compType
﻿String﻿ 
The pay type of the variable comp (either Amount or Percent)
currency
﻿Currency﻿ 
The currency being paid (same as pay.currency), ornull for percentage comp.
interval
﻿String﻿ 
The interval being paid -- currently must be year
pay
﻿Money﻿ 
The amount of variable pay, or nullfor percentage comp.
percent
﻿Percent﻿ 
The percentage of base comp, or null for fixed monetary amount comp.
type
﻿Enum﻿ 
The type of the variable comp, either Bonus or Commission
Type Conversions and Money Math
If VariableComp is used together with Money in a formula, the VariableComp is automatically converted to its pay value.

Property	Type	Description
amount	Number	The amount of money, without the currency (same as pay.amount), ornull for percentage comp.
compType	String	The pay type of the variable comp (either Amount or Percent)
currency	Currency	The currency being paid (same as pay.currency), ornull for percentage comp.
interval	String	The interval being paid -- currently must be year
pay	Money	The amount of variable pay, or nullfor percentage comp.
percent	Percent	The percentage of base comp, or null for fixed monetary amount comp.
type	Enum	The type of the variable comp, either Bonus or Commission

Updated 20 Nov 2024

Did this page help you?

User

Operators