Class CommissionOverride

IOverrideService is used to manage manual commission overrides for rules, ranks, and bonuses

Inheritance
System.Object
CommissionOverride
Namespace: DirectScale.Disco.Extension
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public class CommissionOverride : Object

Constructors

CommissionOverride()

Declaration
public CommissionOverride()

Properties

ApprovedBy

Declaration
public string ApprovedBy { get; set; }
Property Value
Type Description
System.String

Who at the company approved this override.
Remarks

Recommended field for all overrides

ApprovedOn

Declaration
public DateTime ApprovedOn { get; set; }
Property Value
Type Description
System.DateTime

The date this override was approved.
Remarks

Recommended field for all overrides

AssociateId

Declaration
public int AssociateId { get; set; }
Property Value
Type Description
System.Int32

The associate that this override affects
Remarks

Required field for all overrides

Begin

Declaration
public OverridePeriod Begin { get; set; }
Property Value
Type Description
OverridePeriod

The details about when the override begins to take effect.
Remarks

Begin.TemplateName must equal End.TemplateName.

See Also

BonusAmount

Declaration
public float BonusAmount { get; set; }
Property Value
Type Description
System.Single

The amount to be paid by the manual bonus.
Remarks

Ignored if BonusName is empty, required if it is not.

BonusName

Declaration
public string BonusName { get; set; }
Property Value
Type Description
System.String

Force an earned bonus to be created for the associate named BonusName. This does not have to be the group name of any existing bonus and could just be called "adjustment".
Remarks

Optional field, Leave empty to not create a bonus.

If BonusName is not empty, then BonusAmount and Notes must also be populated.

EarnedFromIds

Declaration
public int[] EarnedFromIds { get; set; }
Property Value
Type Description
System.Int32[]

Populates the bonus details of who contributed to the bonus.
Remarks

May be empty, but required to not be null.

See Also

End

Declaration
public OverridePeriod End { get; set; }
Property Value
Type Description
OverridePeriod

The details about when the override ends.
Remarks

End.TemplateName must equal Begin.TemplateName.

See Also

HasBonus

Declaration
public bool HasBonus { get; }
Property Value
Type Description
System.Boolean

Indicates BonusName and BonusAmount are populated.

IsTaxable

Declaration
public bool IsTaxable { get; set; }
Property Value
Type Description
System.Boolean

Unused.

Notes

Declaration
public string Notes { get; set; }
Property Value
Type Description
System.String

The reason for the override being given.
Remarks

Recommended if BonusName is empty, it will be logged when the override is created. Required if BonusName is not empty, it will be provided as the comment on the payment details.

OptionOverride

Declaration
public string OptionOverride { get; set; }
Property Value
Type Description
System.String

The rule id of the rule to force to be hit, regardless of any required condition's results.
Remarks

Optional field, Leave empty to not override a rule result.

OverrideId

Declaration
public int OverrideId { get; set; }
Property Value
Type Description
System.Int32

The id of the override to update.
Remarks

Optional field, Set to 0 to create a new override.

RankOverride

Declaration
public int RankOverride { get; set; }
Property Value
Type Description
System.Int32

The rank id to override the associate's rank to.
Remarks

Optional field, Set value to 0 to not override the rank.

See Also