InsurancePolicy

Represents a type of insurance policy. Available 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
AttributesSelectedValues__c	Type textarea Properties Create, Nillable, Update Description Values of root product attributes set at the InsurancePolicy level.
AuditTerm	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The frequency of the audit. For example, monthly, semi-monthly, quarterly, semi-annually, or annually. Possible values are: `Annually` `Monthly` `Quarterly` `Semi Annual(twice a year)` `Semi-Monthly(twice a month)`
CancellationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the insurance policy was canceled.
CancellationReason	Type textarea Properties Create, Nillable, Update Description The reason for canceling the insurance policy.
CancellationReasonType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The category that the cancellation reason belongs to. Possible values are: `Canceled at Request of the Finance Company` `Canceled by Underwriter or Plan Administrator` `Corporate Officer NonElection` `Court Release` `Coverage Placed Elsewhere` `Duplicate Coverage` `Failure to Comply with Terms and Conditions (ex. Audit Failure)` `Failure to Pay Deductible` `Insured's Request` `Misrepresentation of Information on Application` `Non-Payment` `Not Taken` `Other` `Revocation of Voluntary Market Acceptance` `Rewritten` `Substantial Change in Risk` `Underwriting Reasons`
CashSurrenderValue	Type currency Properties Create, Filter, Nillable, Sort, Update Description The cash surrender value of the insurance policy.
ChangeSubtype	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description A further categorization of the change type. For example, childbirth, marriage. Possible values are: `Child Birth` `Marriage`
ChangeType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of the change in the policy. For example, life event, house renovation. Possible values are: `House Renovation` `Life-Event`
ContractLineItemId__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a line item in the contract for the policy. This is a relationship field. Relationship Name ContractLineItemId__r Relationship Type Lookup Refers To ContractLineItem__c
DateRenewed	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the policy was last renewed.
Discount	Type double Properties Create, Filter, Nillable, Sort, Update Description The discount that was given on the policy.
EffectiveDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date from which the policy is in effect.
ExpirationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the policy expires.
FinalRenewalDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The final date on which the policyholder can renew the insurance policy.
FnolChannel	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The channel through which the loss for the claim associated with this policy was reported. This field is deprecated in API version 48.0 and will be removed in API version 52 (the Summer ’21 release). Possible values are: `Chatbot` `Mobile` `Phone` `Web`
GrossWrittenPremium	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total expected premium amount for the insurance policy over the policy period.
HasAnyAutoCoverage	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the insurance policy has an Any Auto coverage, which extends the coverage to hired and other non-owned vehicles. The default value is `False`.
IsActive	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the policy is active. The default value is `False`.
IsLoanEligibile	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a loan can be requested against the insurance policy. The default value is `False`.
IsRenewedPolicy	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the policy is a renewed policy. The default value is `False`.
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.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The insurance policy number. Label is Policy Number.
NameInsuredId	Type reference Properties Create, Filter, Group, Sort, Update Description The name of the primary insured. This is a relationship field. Relationship Name NameInsured Relationship Type Lookup Refers To Account
OriginalEffectiveDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the original policy went into effect. This field is available from API version 51.0 and later.
OriginalExpirationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Expiration date of the original policy. This field is available from API version 51.0 and later.
OriginalPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the original insurance policy. This field is available from API version 51.0 and later. This is a relationship field. Relationship Name OriginalPolicy Relationship Type Lookup Refers To InsurancePolicy
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the record owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PaidToDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date up to which the policy is paid for. This field is available from API version 51.0 and later.
ParentPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent policy that covers this policy. For example, a parent policy can cover an auto policy and home policy. This is a relationship field. Relationship Name ParentPolicy Relationship Type Lookup Refers To InsurancePolicy
PaymentDueDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the next payment of the premium is due.
PlanTier	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The class that the insurance policy belongs to. For example, silver, gold, or platinum. Possible values are: `Gold` `Platinum` `Silver`
PlanType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of the insurance policy plan. For example, single life, joint last-to-die, or joint first-to-die (primarily applicable for term insurance). Possible values are: `Joint First-to-Die` `Joint Last-to-Die` `Single Life`
PolicyDescription	Type textarea Properties Create, Nillable, Update Description The description of the insurance policy.
PolicyName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the insurance policy.
PolicyTerm	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The time period for which the policy provides coverage. This field is available from API version 51.0 and later. Possible values are: `Annual` `Custom` `Daily` `Monthly` `Semi-Annual` The default value is `Annual`.
PolicyType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of the insurance policy. For example, home, auto, annuity, or life. Possible values are: `Annuity` `Auto` `Commercial Auto` `Commercial Property` `Home` `Life` `Workers' Compensation`
PremiumAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The premium paid by the policy owner for the current billing period.
PremiumCalculationMethod	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The premium calculation method for a payment period. This field is available from API version 51.0 and later. Possible values are: `Daily` `Modal` The default value is `Daily`.
PremiumFrequency	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The frequency of the premium payment or billing. For example, monthly, semi-monthly, quarterly, semi-annually, or annually. Possible values are: `Annually` `Monthly` `Quarterly` `Semi Annual(twice a year)` `Semi-Monthly(twice a month)` The default value is `Annually`.
PremiumPaymentType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The type of premium payment, such as Advance or Arrears. This field is available from API version 51.0 and later. Possible values are: `Advance` `Arrears` The default value is `Advance`.
PreviousPremium	Type currency Properties Create, Filter, Nillable, Sort, Update Description The premium of the policy before it was renewed.
PreviousRenewalDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the insurance policy was renewed in the last renewal cycle.
PriorPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the insurance policy before it was renewed. This is a relationship field. Relationship Name PriorPolicy Relationship Type Lookup Refers To InsurancePolicy
ProducerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the agency or the agent who sold the policy. This is a relationship field. Relationship Name Producer Relationship Type Lookup Refers To Producer
ProductCode__c	Type string Properties Filter, Nillable, Sort Description The code of the product that this policy belongs to. This is a calculated field. Formula `1Product.ProductCode`
ProductId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The product that this policy belongs to. For example, if the customer buys a silver auto policy, this field looks up to the silver auto product in the Product object. This is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2
RenewalChannel	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The channel through which the insurance policy was renewed. Possible values are: `Chatbot` `Mobile` `Phone` `Web`
RenewalDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the policy is expected to be renewed. The actual renewal date may be different.
SaleDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which the policy was sold.
ServicingOffice	Type address Properties Filter, Nillable Description The address of the office that issued the policy and that services the policy. This is a compound field of type Address and combines these fields: ServicingOfficeCity, ServicingOfficeCountry, ServicingOfficeGeocodeAccuracy, ServicingOfficeLatitude, ServicingOfficeLongitude, ServicingOfficePostalCode, ServicingOfficeState, and ServicingOfficeStreet.
SourceOpportunityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the opportunity from which the policy was created. This is a relationship field. Relationship Name SourceOpportunity Relationship Type Lookup Refers To Opportunity
SourceQuoteId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the quote from which the policy was created. This is a relationship field. Relationship Name SourceQuote Relationship Type Lookup Refers To Quote
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, idLookup, Nillable, Sort, Update Description The unique ID of this record in the source system.
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.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The status of the insurance policy. Possible values are: `Agreement Premature endings` `Applied` `Canceled` `Customer Rejected` `Draft` `Final` `Full Life Ending` `Hypothetical` `In Force` `In Force with temporary coverage` `In Force-change pending` `Initial` `Insurer Rejected` `Lapsed` `Negotiation End` `Not Taken Up` `Offered` `Quote Abandoned` `Quoted` `Replaced by customer application` `Replaced by insurer counter offer` `Suspended` `Terminated` `Under negotiation` The default value is `Initial`.
Substatus	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The carrier system's substatus code for the insurance policy. Possible values are: `Draft` `Final` `Negotiation End` `Not Taken Up` `Quote Abandoned` The default value is `Draft`.
TaxesSurcharges	Type currency Properties Create, Filter, Nillable, Sort, Update Description The taxes and surcharges levied on the premium for the insurance 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.
TotalCommissionAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total commission amount for the policy.
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.
TotalSumInsured	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total insured amount. This field is available from API version 51.0 and later.
UnderwritingEntityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Legal entity that underwrote the insurance policy. This is a relationship field. Relationship Name UnderwritingEntity Relationship Type Lookup Refers To LegalEntity
UniversalPolicyNumber	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description A number that uniquely identifies the policy across different source systems.

Salesforce Health Cloud Developer Guide

InsurancePolicy

Supported Calls

Fields