OpportunitySplitType

Represents labels and behavior for each split type

This object is read only, and only available if Teamselling and Opportunity Splits are enabled.

There are 2 default split types: revenue splits, which must total 100%, and overlay splits, which can total any percentage.

Version 

Introduced in API version 37.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve()

Supported REST API Methods 

GET, HEAD, Query

Fields 

Description 

• Type: textarea

• Required: No

• Properties: Filter, Group, Sort

• Description: Describes the purpose of the split type, providing context to future developers.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The unique name of the object in the API. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

  When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

  Note

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Enables or disables the split type.

• Default value: false

IsTotalValidated 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: If true, the split must total 100%. If false, the split can total any percentage.

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Indicates language of split labels in the user interface.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

This field is available in API version 38.0 and later.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The user-interface label for the split type.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

• In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
• In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.

This field can’t be accessed unless the logged-in user has the Customize Application permission.

SplitDataStatus 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the status of the split type.

• Possible values:

  • Ready — Ready

  • ToBeInserted — ToBeInserted

  • ToBeDeleted — ToBeDeleted

  • InsertionFailed — InsertionFailed

  • DeletionFailed — DeletionFailed

  • ToBeInsertedAndActivated — ToBeInsertedAndActivated

  • InsertionAndActivationFailed — InsertionAndActivationFailed

SplitEntity 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The containing record type, such as an opportunity.

SplitField 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: Indicates which currency field of the opportunity object is split.