mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
109 lines
5.3 KiB
JSON
109 lines
5.3 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"associated_objects"
|
||
],
|
||
"title": "CommissionSchedule - Data API",
|
||
"description": "Represents a commission calculation and rate definition. Calculates commission values for a commissionable event.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"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.\n\n- **CommissionScheduleChangeEvent**: Change events are available for the object in API version 62.0 and later.\n- **CommissionScheduleFeed**: Feed tracking is available for the object.\n- **CommissionScheduleHistory**: History is available for tracked fields of the object.\n- **CommissionScheduleOwnerSharingRule**: Sharing rules are available for the object.\n- **CommissionScheduleShare**: Sharing is available for the object."
|
||
} |