Financial Services Cloud Developer Guide
jInsurancePolicySurcharge
Represents the charges calculated for an insurance policy and its related
assets, coverages, and participants in a region. This object is available in API version
51.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
ApplicableObjectType
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: Specifies the item on which the surcharge was applied.
-
Possible values:
- InsurancePolicyAsset—Insurance Policy Asset
- InsurancePolicyCoverage—Insurance Policy Coverage
- InsurancePolicyParticipant—Insurance Policy Participant
BillingTreatmentId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The rules that determine how an insurance policy surcharge is billed. For
example, advance or arrears.
This field is a relationship field.
- Relationship Name: BillingTreatment
- Refers To: BillingTreatment
InsurancePolicyAssetId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The insurance policy asset associated with the surcharge.
InsurancePolicyCoverageId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The insurance policy coverage associated with the surcharge.
InsurancePolicyId
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The insurance policy associated with the surcharge.
InsurancePolicyParticipantId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The insurance policy participant associated with the surcharge.
InsurancePolicyTransactionId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The insurance policy transaction associated with the surcharge.
IsProrationAllowed
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the term surcharge amount is prorated based on the policy duration.
- Default value: false
IsRefundAllowed
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the term surcharge amount is eligible for refund.
- Default value: 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 name of the insurance policy surcharge.
OriginalSurchargeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The ID of the first instance of a specific surcharge record (tax or fee)
that's used to track it across policy versions created through lifecycle
events.
This field is a relationship field.
- Relationship Name: OriginalSurcharge
- Refers To: InsurancePolicySurcharge
ParentSurchargeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The parent surcharge record that this surcharge is associated with. For
example, a Tax surcharge is associated with a Fee surcharge.
This field is a relationship field.
- Relationship Name: ParentSurcharge
- Refers To: InsurancePolicySurcharge
PriorSurchargeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The reference surcharge form before the policy was endorsed or renewed.
This field is a relationship field.
- Relationship Name: PriorSurcharge
- Refers To: InsurancePolicySurcharge
ProductSurchargeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The product surcharge associated with an insurance policy surcharge.
This field is a relationship field.
ProductSellingModelId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies the type of payments. Possible values include one time or
installment.
This field is a relationship field.
- Relationship Name: ProductSellingModel
- Refers To: ProductSellingModel
SourceSurchargeId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: References the last reinstated surcharge version used as the source
for subsequent versions, or the original surcharge if not reinstated.
This field is a relationship field.
- Relationship Name: SourceSurcharge
- Relationship Type: Lookup
- Refers To: InsurancePolicySurcharge
SourceSystem
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The name of the system from which this insurance policy surcharge was obtained.
SourceSystemIdentifier
- Type: string
- Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
- Description: The ID of the insurance policy surcharge record in the source system. This field is unique within your organization.
SurchargeAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The surcharge amount calculated for an insurance policy, insurance policy asset, insurance policy coverage, or an insurance policy participant. This surcharge is calculated based on the tax and fee structure defined for products or can be retrieved from a source system.
TaxTreatmentId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: Specifies how the taxes are calculated, applied, and reported for billing
transactions.
This field is a relationship field.
- Relationship Name: TaxTreatment
- Refers To: TaxTreatment
TermSurchargeAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The surcharge amount calculated for the duration of an insurance policy, insurance policy asset, insurance policy coverage, or insurance policy participant.