OpportunitySplit
OpportunitySplit credits one or more opportunity team members with a portion of the opportunity amount.
Introduced in API version 16.0.
This object is available in API version 16.0 and later for pilot customers, and version 28.0 and later for others.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 62.0
- Description: The name of the associated territory that’s on an archived territory model. If the OpportunityLineItemSplit isn’t associated with a territory on an archived territory model, the field value is null.
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 57.0
-
Description:
Read-only. Indicates whether the opportunity split has a split on the opportunity line item level (
true) or not (false).The default value is
false. -
Default value: false
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Description:
ID of the opportunity for which the split is being created.
This field is a relationship field.
-
Relationship name: Opportunity
-
Relationship type: masterdetail
-
Refers to: Opportunity
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: Read-only. Automatically generated number identifying the split within the opportunity.
-
Type: currency
-
Properties: Filter, Nillable, Sort
-
Description:
Monetary amount of the split.
Label is
Split Amount.
-
Type: string
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description:
Enter any notes or comments about the split. The character limit is 255.
Label is
Split Note.
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Description:
The opportunity owner.
This field is a relationship field.
-
Relationship name: SplitOwner
-
Relationship type: relationship
-
Refers to: User
-
Type: percent
-
Properties: Create, Filter, Sort, Update
-
Description:
Split percentage that this team member receives. If the split type is validated to a 100% total, this number can range from 0 to 100. If the total isn’t validated, this number can range from 0 to 1,000.
Label is
Split (%).
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 28.0
-
Description:
Auto-generated, numeric ID for the split type defined by the OpportunitySplitType object.
If this field is blank, the system automatically specifies the default split type for the opportunity amount, which is validated to 100%.
This field is a relationship field.
-
Relationship name: SplitType
-
Relationship type: relationship
-
Refers to: OpportunitySplitType
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 62.0
- Description: ID of the associated territory. This field is a relationship field, and is available in API version 62.0 and later.
- Relationship name: Territory2
- Relationship type: relationship
- Refers to: Territory2
Use the OpportunitySplit object to manage splits for an opportunity.
If you change the opportunity owner using the API, the old owner remains on the opportunity team with either Read-only access, or the level of access specified in your organization-wide defaults.
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.
-
OpportunitySplitChangeEvent: Introduced in API version 48.0.
-
OpportunitySplitHistory: Introduced in API version 59.0.