Preview Policy Premium Action

Preview prorated and rolled-up premium amounts across the insurance policy hierarchy without creating or updating the changes.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/previewPolicyPremium

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
`previewPolicyPremiumInputRepresentation`	Apex-defined	Required. An Apex `ConnectApi.PreviewPolicyPremiumIAInputRep` record that contains the details to calculate and preview the premium amounts for the specified policy ID.

Outputs

Output	Type	Description
`previewPolicyPremiumOutputRepresentation`	Apex-defined	An Apex `ConnectApi__PreviewPolicyPremiumIAOutputRep` record that contains the policy premium details for preview.

Example

POST

This sample request is for the Preview Policy Premium action when references isn’t specified.

1{
2  "inputs": [
3    {
4      "previewPolicyPremiumInputRepresentation": {
5        "insurancePolicyId": "0YTxx00000000CvGAI"
6      }
7    }
8  ]
9}

This sample response is for the Preview Policy Premium action when references isn’t specified in the request.

1[
2  {
3    "actionName": "previewPolicyPremium",
4    "errors": null,
5    "expectedError": false,
6    "invocationId": null,
7    "isSuccess": true,
8    "outcome": null,
9    "outputValues": {
10      "previewPolicyPremiumOutputRepresentation": {
11        "policyId": "0YTfiP000000FdNGBU",
12        "results": [
13          {
14            "amounts": {
15              "standardCommission": 0,
16              "standardFee": 0,
17              "standardPremium": 3000,
18              "standardTax": 0,
19              "termCommission": 0,
20              "termFee": 0,
21              "termPremium": 3000,
22              "termTax": 0,
23              "totalStandard": 3000,
24              "totalTerm": 3000
25            },
26            "errors": [],
27            "name": "Draft State Premium Dummy Policy -1",
28            "recordId": "0YTfiP000000FdNGBU"
29          }
30        ]
31      }
32    },
33    "sortOrder": -1,
34    "version": 1
35  }
36]

This sample request is for the Preview Policy Premium action with references included in the request.

1{
2  "inputs": [
3    {
4      "previewPolicyPremiumInputRepresentation": {
5        "insurancePolicyId": "0YTfiP000000FdNGBU",
6        "references": {
7          "references": [ { "recordId": "0YTfiP000000FdNGBU" } ]
8        }
9      }
10    }
11  ]
12}

This sample response is for the Preview Policy Premium action when references is specified in the request.

1[
2  {
3    "actionName": "previewPolicyPremium",
4    "errors": null,
5    "expectedError": false,
6    "invocationId": null,
7    "isSuccess": true,
8    "outcome": null,
9    "outputValues": {
10      "previewPolicyPremiumOutputRepresentation": {
11        "policyId": "0YTfiP000000FdNGBU",
12        "results": [
13          {
14            "amounts": {
15              "standardCommission": 0,
16              "standardFee": 0,
17              "standardPremium": 3000,
18              "standardTax": 0,
19              "termCommission": 0,
20              "termFee": 0,
21              "termPremium": 3000,
22              "termTax": 0,
23              "totalStandard": 3000,
24              "totalTerm": 3000
25            },
26            "errors": [],
27            "name": "Draft State Premium Dummy Policy -1",
28            "recordId": "0YTfiP000000FdNGBU"
29          }
30        ]
31      }
32    },
33    "sortOrder": -1,
34    "version": 1
35  }
36]