Insurance Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Insurance Developer Resources
Insurance Product Administration
Insurance Quoting
Insurance Policy Administration
Insurance Brokerage
Insurance Brokerage Business APIs
Resources
Bulk Cancel Policy (POST)
Bulk Renew Policy (POST)
Commission Processing (POST)
Cost Calculation (PATCH)
Expected Revenue (PATCH)
Plan Benefits (GET, POST, PATCH, DELETE)
Plan Benefits Product Model (GET)
Renew Policy (POST)
Requests
Responses
Insurance Brokerage Standard Invocable Actions
Insurance Brokerage Metadata API Types
Insurance Brokerage Apex Reference
PDF

Cost Calculation (PATCH)

Calculate the premium, fee, or premium-equivalent amount at InsuranceRatePlanLineItem based on the underlying rate plan. The InsuranceRatePlanLineItem premium, fees, or premium equivalent amount is rolled up to the Insurance Rate Plan, Insurance Coverage, and Insurance Policy Premium Amount.
Resource
/connect/insurance/brokerage/policies/policyId/expected-rates
Resource example
https://yourInstance.salesforce.com/services/data/v64.0/connect/insurance/brokerage/policies/0YTSG0000000o9h4AA/expected-rates?businessSObjectType=InsuranceRatePlan&recordId=1CcSG00000000fx0AA
Available version
63.0
HTTP methods
PATCH
Path parameter for PATCH
Name Type Description Required or Optional Available Version
policyId String

ID of parent policy for which the expected cost is calculated.

Required 63.0
Request parameters for PATCH
Parameter Name Type Description Required or Optional Available Version
businessSObjectType String Name of business SObject to calculate premium. Possible values are:
  • InsurancePolicy
  • InsurancePolicyCoverage
  • InsuranceRatePlan
  • InsuranceRatePlanLineItem
Optional 63.0
recordId String ID of business SObject for which premium calculation is done. Optional 63.0
Request body for PATCH
JSON example
{
 "action": "rollup",
 "expressionSetName": "expressionSetName",
 "ratePlanLineItems": [
  {
   "id": "xxxxxx",
   "rate": 100,
   "enrollmentCount": 1000,
   "custom_field_1": "xxxxxx"
  },
  {
   "id": "yyyyy",
   "rate": 50,
   "enrollmentCount": 200,
   "custom_field_1": "xxxxxx"
  }
 ]
}
Properties
Name Type Description Required or Optional Available Version
action String Course of action for processing RatePlanLineItems. Valid values:
  • rollup: Calculates premium and roll ups it to Insurance Policy level.
  • calculate: Calculates premium and returns it in the output.
 Optional 63.0
expressionSet​Name String Name of the expression set for cost calculation. If not specified, the value from the InsPolicyManagementConfig setup object is taken. Optional 63.0
ratePlan​LineItems List<Map<String, Object>> List of insurance rate plan line items. Optional 63.0
Response body for PATCH
Cost Calculation