Newer Version Available

This content describes an older version of this product. View Latest

OpportunitySplit

OpportunitySplit credits one or more opportunity team members with a portion of the opportunity amount. This object is available in API version 16.0 and later for pilot customers, and version 28.0 and later for others.

Supported Calls

create()delete()describeSObjects()getDeleted()getUpdated()query()retrieve()update()upsert()

Fields

Field Details
OpportunityId
Type
reference
Properties
Create, FilterGroup, Sort
Description
ID of the opportunity for which the split is being created.
Label is Opportunity ID.
Split
Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
Read-only. Automatically-generated number identifying the split within the opportunity.
SplitAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Monetary amount of the split.
Label is Split Amount.
SplitNote
Type
string
Properties
Create, Filter, Group, Nillable,Sort, Update
Description
Enter any notes or comments about the split. Character limit is 255.
Label is Split Note.
SplitOwnerId
Type
reference
Properties
Create, Filter,Group, Sort
Description
The opportunity owner.
Label is User ID.
SplitPercentage
Type
percent
Properties
Create, Filter, Sort, Update
Description
Split percentage that this team member will receive. 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 (%).
SplitTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Auto-generated, numeric ID for the split type defined by the OpportunitySplitType object. This field is available in API version 28 and later.
If this field is blank, the system automatically specifies the default split type for the opportunity amount, which is validated to 100%.

Usage

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.