InsurancePolicyCoverage

A junction object that associates the InsurancePolicy object with the ProductCoverage object.

Supported Calls

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

Fields

BenefitPaymentFrequency

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The frequency of the payment if the benefit or coverage entails a recurring payout to the insured. For example, monthly, semi-monthly, quarterly, semi-annually, or annually.

BillingTreatmentId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Specifies how the Subscription Management bills an insurance policy coverage.
This field is a relationship field.
Relationship Name: BillingTreatment
Refers To: BillingTreatment

CategoryCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A carrier-specific code that identifies the coverage. For example, benefit, clause, or deductible.

CategoryGroup

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The specific category group. For example, for a liability coverage record, benefit is the category and liability is the category group.

CategoryGroupType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of the category group.

CommissionPercent

Type: percent
Properties: Create, Filter, Nillable, Sort, Update
Description: The percentage of Insurance Policy Coverage premium to be earned as commission by the brokerage firm.

ContractGroupPlanId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The contract group plan associated with the insurance policy coverage.

CoverageCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unique code of the insurance policy coverage across all the policy versions.

CoverageName

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the coverage.

DeathBenefitOptionType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The method for the payment of death benefit.

DeductibleAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The deductible amount that the customer must pay.

Description

Type: textarea
Properties: Create, Nillable, Update
Description: The description of the coverage.

Discount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The discount that was given on the coverage or the benefit.

EffectiveDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date from which the coverage is in effect.

EffectiveFromDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date from when the coverage becomes active on the policy.

EffectiveToDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date after when the coverage 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.

ExpectedRevenueAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The revenue amount that the brokerage is expected to earn from the Insurance Policy Coverage.

ExpirationDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date on which the coverage expires.

IncomeOptionType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The type of the income option given to the policy participant. For example, periodic payment is an income option type, and annuity is an income option.

InsurancePolicyAssetId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The asset covered by this coverage.

InsurancePolicyId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The insurance policy associated with this coverage.

InsurancePolicyParticipantId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: The insurance policy participant associated with this coverage.

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.

LimitAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The limit of the fixed coverage amount. For example, uninsured motorist coverage of USD 1000.

LimitDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date from which the coverage limit is in effect. For example, an annuity benefit is valid only after the insured is 60 years old.

LimitPercentage

Type: percent
Properties: Create, Filter, Nillable, Sort, Update
Description: The percentage of the actuals covered by this coverage.

LimitRange

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The range of the coverage limit. For example, bodily injury coverage with limits as USD 100,000 per person and USD 300,000 per accident.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, Sort
Description: An auto-generated number assigned to this record.

OriginalCoverageId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the first instance of a specific coverage that's used to track it across policy versions created through lifecycle events.
This field is a relationship field.
Relationship Name: OriginalCoverage
Refers To: InsurancePolicyCoverage

ParentCoverageId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The parent coverage record associated with this coverage. This relationship establishes a multi-level, parent-child hierarchy in the policy to support bundled coverages.
This field is a relationship field.
Relationship Name: ParentCoverage
Relationship Type: Lookup
Refers To: InsurancePolicyCoverage

PremiumAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The premium paid by the customer for this coverage.

PriorCoverageId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The reference coverage record before the policy was endorsed or renewed.
This field is a relationship field.
Relationship Name: PriorCoverage
Refers To: InsurancePolicyCoverage

ProductId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The product associated with the coverage.
This field is a relationship field.
Relationship Name: Product
Refers To: Product2

ProductSellingModelId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Indicates whether the insurance policy is sold as a one-time or an installment-based sale.
This field is a relationship field.
Relationship Name: ProductSellingModel
Refers To: ProductSellingModel

SourceCoverageId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: References the last reinstated coverage version used as the source for subsequent versions, or the original coverage if not reinstated.
This field is a relationship field.
Relationship Name: SourceCoverage
Relationship Type: Lookup
Refers To: InsurancePolicyCoverage

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 coverage record in the source system.

StandardCommissionAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The total commission expected for the policy coverage 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 coverage, prorated based on the coverage 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 expected premium, tax, and fee amount for the insurance policy over the policy period, prorated based on the policy's effective dates.
This field 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.

InsurancePolicyCoverageChangeEvent: Change events are available for the object in API version 62.0 and later.
InsurancePolicyCoverageFeed: Feed tracking is available for the object.
InsurancePolicyCoverageHistory: History is available for tracked fields of the object.
InsurancePolicyCoverageOwnerSharingRule: Sharing rules are available for the object.
InsurancePolicyCoverageShare: Sharing is available for the object.

Financial Services Cloud Developer Guide