CommissionSchedule

Represents a commission calculation and rate definition. Calculates commission values for a commissionable event.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
ApplicableObject	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description The object for which this Commission Schedule calculates commissions. Possible values are: `Contract` `InsurancePolicy` `Producer` `Quote`
CalcProcessInputMapping	Type textarea Properties Create, Nillable, Update Description The input mappings from the object fields to the variables used in the commission calculation.
CalcProcessOutput	Type textarea Properties Create, Nillable, Update Description The formula applied to this Commission Schedule’s process output that calculates the final commission amount.
CalcProcessOutputConvNotation	Type textarea Properties Create, Nillable, Update Description An optimized version of the CalcProcessOutput formula that calculates the commission. Not user-editable.
CalculationProcessName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Integration Procedure, Calculation Matrix, or Calculation Procedure this Commission Schedule uses for calculations.
CalculationType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of calculation or process used when this Commission Schedule is used. Possible values are: `Amount` `CalculationMatrix` `CalculationProcedure` `IntegrationProcedure` `Rate`
CommissionAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The commission amount for the Commission Schedule when the process type is Amount.
CommissionRate	Type percent Properties Create, Filter, Nillable, Sort, Update Description The commission percentage for the Commission Schedule when the process type is Rate.
CommissionStructureType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates whether the commission calculation is Flat or Tiered when the process type is Matrix. Possible values are: `Flat` `Tiered` The default value is `Flat`.
EffectiveEndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The effective end date of the Commission Schedule.
EffectiveStartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The effective start date of the Commission Schedule.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the Commission Schedule is active. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the Commission Schedule.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
TierDefinition	Type textarea Properties Create, Nillable, Update Description Internal-only. Applies when the CalculationType is CalculationMatrix.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

CommissionScheduleChangeEvent: Change events are available for the object in API version 62.0 and later.
CommissionScheduleFeed: Feed tracking is available for the object.
CommissionScheduleHistory: History is available for tracked fields of the object.
CommissionScheduleOwnerSharingRule: Sharing rules are available for the object.
CommissionScheduleShare: Sharing is available for the object.