SharedSavingPaymentAgreement

Specifies the payment terms for contracts of Shared Saving Payment Agreement type. This object is available in API version 54.0 and later with the Provider Network Management permission set license.

Supported Calls

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

Fields

Field Details
BenchmarkEndDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The end date of the benchmark period based on which the profit or loss is determined for the Shared Saving payment type.
BenchmarkStartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The start date of the benchmark period based on which the profit or loss is determined for the Shared Saving payment type.
BenchmarkedExpenditureAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
This is the expenditure amount for the selected benchmark period.
ContractPaymentAgreementId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The contract payment agreement record to which this shared savings payment agreement is associated.
This is a relationship field.
Relationship Name
ContractPaymentAgreement
Relationship Type
Master-Detail
Refers To
ContractPaymentAgreement
ForecastedExpenditureAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
This is the expenditure amount that's forecasted for the contract payment agreement duration.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced the record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed the record.
LossPlanDescription
Type
textarea
Properties
Create, Nillable, Update
Description
The description of the shared savings payment agreement in case of a loss.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the shared savings payment agreement.
ProfitPlanDescription
Type
textarea
Properties
Create, Update
Description
The description of the shared savings payment agreement when a profit is attained.
QualifyingProfitPercentage
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum profit percentage to be reached to share the profit.

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.

SharedSavingPaymentAgreementFeed
Feed tracking is available for the object.
SharedSavingPaymentAgreementHistory
History is available for tracked fields of the object.
SharedSavingPaymentAgreementChangeEvent (API version 61.0)
Change events are available for the object.