InsurancePolicy

Represents a type of insurance policy. This object is available in API version 59.0 and later.

Supported Calls

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

Special Access Rules

To access this object on your Public Sector Solutions org, Benefit Disbursement must be enabled and you must have the Benefit Disbursement Access permission set or the Benefit Disbursement permission set license.

Fields

Field	Details
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.
BillingCarrierAccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the Billing Carrier Account associated with the Insurance Policy. When the company that sells the policy also writes the policy, then the billing carrier is the same as the writing carrier. This field is a relationship field. Relationship Name BillingCarrierAccount Relationship Type Lookup Refers To Account
CancellationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date 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.
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.
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.
CurrentDueAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The current due amount for the policy.
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 the policy is in effect.
ExpirationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date 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.
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. The default value is `false`.
IntermediaryAccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Intermediary Account associated with the Insurance Policy. This field is a relationship field. Relationship Name IntermediaryAccount Relationship Type Lookup Refers To Account
IsActive	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the policy is active. Creating or updating an InsurancePolicy sets IsActive automatically based on the Status field value. For example, you can set IsActive to False by setting Status to Inactive. 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`.
IsPolicyEditLocked	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the application locks the policy record. 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 Required. The insurance policy number.
NameInsuredId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. The name of the primary insured. This field 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 the original policy went into effect.
OriginalExpirationDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Expiration date of the original policy.
OriginalPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the original insurance policy. This field 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 field 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.
ParentPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the parent policy that covers this policy. This field is a relationship field. Relationship Name ParentPolicy Relationship Type Lookup Refers To InsurancePolicy
PastDueAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The amount past due for the policy.
PaymentDueDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The due date for the next payment of the premium.
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.
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).
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, Filter, Group, Nillable, Sort, Update Description The time period for which the policy provides coverage.
PolicyType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of the insurance policy. For example, home, auto, annuity, or life.
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, Filter, Group, Nillable, Sort, Update Description The premium calculation method for a payment period.
PremiumFrequency	Type picklist Properties 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.
PremiumPaymentType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The type of premium payment, such as Advance or Arrears.
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 most recent renewal date for the insurance policy.
PriorPolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the insurance policy before it was renewed. This field is a relationship field. Relationship Name PriorPolicy Relationship Type Lookup Refers To InsurancePolicy
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 field is a relationship field. Relationship Name Product Relationship Type Lookup Refers To Product2
RatingDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date to determine the rating details on a mid-term adjustment, endorsement, or out-of-sequence endorsement to a policy.
ReferencePolicyNumber	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The reference number of the insurance policy that is renewed when the policy term tracking is continued across multiple policy versions. For example, if a limit is a "Lifetime Limit", then the policy term tracking is tracked across all versions of the policy.
RenewalChannel	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The channel used to renew the insurance policy. For example, phone or web.
RenewalDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The next expected policy renewal date. The actual renewal date may be different.
SaleDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date 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. For more information, see Address Compound Fields.
SourceOpportunityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the opportunity from which the policy was created. This field is a relationship field. Relationship Name SourceOpportunity Relationship Type Lookup Refers To Opportunity
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.
StandardPremiumAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The expected premium for the policy over the policy period.
StandardTaxAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The expected tax on the policy over the policy period.
Status	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The status of the insurance policy.
Substatus	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The carrier system's substatus code for the insurance policy.
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.
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.
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.
TotalCommissionAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total commission amount for the policy.
TotalSumInsured	Type currency Properties Create, Filter, Nillable, Sort, Update Description The total insured amount.
TotalTermFeeAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The current total term fees of all policy versions.
TotalTermPremiumAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The current total term premium of all policy versions.
TotalTermTaxAmount	Type currency Properties Create, Filter, Nillable, Sort, Update Description The current total term taxes of all policy versions.
UnderwritingEntityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Legal entity that underwrote the insurance policy. This field 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.
WritingCarrierAccountId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The Writing Carrier Account associated with the Insurance Policy. This field is a relationship field. Relationship Name WritingCarrierAccount Relationship Type Lookup Refers To Account

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.

InsurancePolicyChangeEvent (API version 61.0): Change events are available for the object.
InsurancePolicyFeed: Feed tracking is available for the object.
InsurancePolicyHistory: History is available for tracked fields of the object.
InsurancePolicyOwnerSharingRule: Sharing rules are available for the object.
InsurancePolicyShare: Sharing is available for the object.

Public Sector Solutions Developer Guide

InsurancePolicy

Supported Calls

Special Access Rules

Fields

Associated Objects