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

{policyId} is a placeholder.

1/connect/insurance/brokerage/policies/{policyId}/expected-rates

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.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 the premium for. Possible values are: `InsurancePolicy` `InsurancePolicyCoverage` `InsuranceRatePlan` `InsuranceRatePlanLineItem`	Optional	63.0
`recordId`	String	ID of business SObject to calculate the premium for.	Optional	63.0

Request Body for PATCH

JSON Example

1{
2 "action": "rollup",
3 "expressionSetName": "expressionSetName",
4 "ratePlanLineItems": [
5  {
6   "id": "xxxxxx",
7   "rate": 100,
8   "enrollmentCount": 1000,
9   "custom_field_1": "xxxxxx"
10  },
11  {
12   "id": "yyyyy",
13   "rate": 50,
14   "enrollmentCount": 200,
15   "custom_field_1": "xxxxxx"
16  }
17 ]
18}

Properties

Name	Type	Description	Required or Optional	Available Version
`action`	String	Action for processing `RatePlanLineItems`. Valid values are: `rollup`: Calculates premium and roll ups it to Insurance Policy level. `calculate`: Calculates premium and returns it in the output.	Optional	63.0
`expressionSetName`	String	Name of the expression set for cost calculation. If not specified, the value from the `InsPolicyManagementConfig` setup object is taken.	Optional	63.0
`ratePlanLineItems`	List<Map<String, Object>>	List of insurance rate plan line items to include for calculation. Items with an `id` represent existing records. Items without an `id` are draft records. When `action` is `calculate`, premiums for draft records are calculated and returned without being saved. Use `referenceId` to correlate draft records with their calculated premiums in the response.	Optional	63.0

Response Body for PATCH

Cost Calculation