Expected Revenue (PATCH)

Calculate the expected revenue, derived both from an Insurance Rate Plan Commission object, such as a flat fee and percentage premium, and the premium, fee, or premium equivalent amount on Insurance Rate Plan. The expected revenue amount is rolled up from Insurance Rate Plan to Insurance Coverage and Insurance Policy expected revenue amount.

Resource

1/connect/insurance/brokerage/policies/policyId/expected-revenue

Resource example

1https://yourInstance.salesforce.com/services/data/v63.0/connect/insurance/brokerage/policies/0YTSG0000000o9h4AA/expected-revenue?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 revenue is calculated.	Required	63.0

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`businessSObjectType`	String	Name of the business sObject to calculate expected revenue. Possible values are: `InsurancePolicy` `InsurancePolicyCoverage` `InsuranceRatePlan`	Optional	63.0
`recordId`	String	ID of the business sObject for which expected revenue must be calculated.	Optional	63.0

Request body for PATCH

JSON example

1{
2  "expressionSetName": "expressionSetName",
3  "ratePlanCommissions": [
4    {
5      "Name": "RPC-1",
6      "Type": "GradedPercent",
7      "amountStartRange": 0,
8      "amountEndRange": 1000
9    },
10    {
11      "Name": "RPC-1",
12      "Type": "GradedPercent",
13      "amountStartRange": 1001,
14      "amountEndRange": 100000
15    }
16  ]
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`expressionSetName`	String	Name of expression set to be used for expected revenue calculation. If unspecified, a value from the `InsPolicyManagementConfig` setup object is taken.	Optional	63.0
`ratePlanCommissions`	List	List of rate plan commissions to be used for expected revenue calculation. This is a valid input only when `businessSObjectType` is `InsuranceRatePlan`.	Optional	63.0

Response body for PATCH

Expected Revenue

Insurance Developer Guide

Expected Revenue (PATCH)