InsurancePolicyParticipant
A junction object that associates the InsurancePolicy object with the Account
object. This object represents the participants of an insurance policy. Insurance policy
participants include policy owners and beneficiaries.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
BeneficiarySharePercentage
- Type: percent
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The percentage of the total benefits that goes to the nominee.
BillingTreatmentId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies how the Subscription Management bills an
insurance policy participant.
This field is a relationship field.
- Relationship Name: BillingTreatment
- Refers To: BillingTreatment
EffectiveDate
- Type: dateTime
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The date from which the participant is active on the policy.
EffectiveFromDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date from when the participant becomes active on the policy.
EffectiveToDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date after when the participant becomes inactive on the policy.
EmployeeContribution
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The employee contribution towards the insurance premium value for the participant.
EmployerContribution
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The employer contribution towards the insurance premium value for the participant.
ExpirationDate
- Type: dateTime
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The date from which the participant is inactive on the policy.
InsurancePolicyId
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The ID of the insurance policy.
IsActiveParticipant
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the participant is an active participant on the policy.
- Default value: False
IsMinorBeneficiary
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the nominee is a minor.
- Default value: False
IsPolicyholder
- Type: boolean
- Properties: Defaulted on create, Filter, Group, Sort
- Description: Indicates whether this client owns the policy or is just a participant on the policy. This field is available from API version 51.0 and later.
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.
LegalGuardianId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The legal guardian of the minor beneficiary. This can be a business account or a person account.
Name
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, Sort
- Description: An auto-generated number assigned to this record.
OriginalParticipantId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The ID of the first instance of a specific participant
that's used to track it across policy versions created
through lifecycle events.
This field is a relationship field.
- Relationship Name: OriginalParticipant
- Refers To: InsurancePolicyParticipant
ParticipantCode
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The unique code of the insurance policy participant across all the policy versions.
ParticipantName
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the participant of the insurance policy.
PrimaryParticipantAccountId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the primary participant's account.
PrimaryParticipantContactId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the primary participant's contact.
PriorParticipantId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The reference participant form before the policy was
endorsed or renewed.
This field is a relationship field.
- Relationship Name: PriorParticipant
- Refers To: InsurancePolicyParticipant
ProductId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The product associated with the participant.
This field is a relationship field.
ProductSellingModelId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Indicates whether the insurance policy coverage is sold
as a one-time sale or an installment-based sale.
This field is a relationship field.
- Relationship Name: ProductSellingModel
- Refers To: ProductSellingModel
RelatedInsPolicyParticipantId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The related insurance policy participant.
This field is a relationship field.
RelatedParticipantAccountId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the related participant's account.
RelatedParticipantContactId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the related participant's contact.
RelationshipToInsured
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The relationship of the nominee with the insured.
Role
- Type: multipicklist
- Properties: Create, Filter, Update
- Description: The roles that the participant has in the policy. For example, owner, beneficiary, driver.
SourceParticipantId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: References the last reinstated participant version used as the
source for subsequent versions, or the original participant if not reinstated.
This field is a relationship field.
- Relationship Name: SourceParticipant
- Relationship Type: Lookup
- Refers To: InsurancePolicyParticipant
SourceSystem
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the source system this record was obtained from.
SourceSystemIdentifier
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of this record in the source system.
StandardCommissionAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The total commission expected for the policy participant across the full policy term.
StandardFeeAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected fee for the policy over the policy period. This field is available from API version 51.0 and later.
StandardPremiumAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected premium for the policy over the policy period. This field is available from API version 51.0 and later.
StandardTaxAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected tax on the policy over the policy period. This field is available from API version 51.0 and later.
TermCommissionAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The commission amount for the policy participant, prorated based on the participant’s effective dates within the policy.
TermFeeAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected fee for the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later.
TermPremiumAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected premium for the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later.
TermTaxAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The expected tax on the policy over the policy period, prorated based on the policy's effective dates. This field is available from API version 51.0 and later.
TotalStandardAmount
- Type: currency
- Properties: Filter, Nillable, Sort
-
Description: The sum of the expected premium, fee, and tax for the
policy over the policy period. This field is available
from API version 51.0 and later.
This is a calculated field.
TotalTermAmount
- Type: currency
- Properties: Filter, Nillable, Sort
-
Description: The sum of the expected premium, tax, and fee for the policy over the policy period,
prorated based on the policy's effective dates. This
field is available from API version 51.0 and later.
This is a calculated field.
Associated Objects
This object has the following associated objects. Unless noted, they’re available in the same API version as this object.
- InsurancePolicyParticipantChangeEvent
- Change events are available for the object in API version 62.0 and later.
- InsurancePolicyParticipantFeed
- Feed tracking is available for the object.
- InsurancePolicyParticipantHistory
- History is available for tracked fields of the object.
- InsurancePolicyParticipantOwnerSharingRule
- Sharing rules are available for the object.
- InsurancePolicyParticipantShare
- Sharing is available for the object.