Preview Policy Premium Action

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.

{
  "inputs": [
    {
      "previewPolicyPremiumInputRepresentation": {
        "insurancePolicyId": "0YTxx00000000CvGAI"
      }
    }
  ]
}

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

[
  {
    "actionName": "previewPolicyPremium",
    "errors": null,
    "expectedError": false,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "previewPolicyPremiumOutputRepresentation": {
        "policyId": "0YTfiP000000FdNGBU",
        "results": [
          {
            "amounts": {
              "standardCommission": 0,
              "standardFee": 0,
              "standardPremium": 3000,
              "standardTax": 0,
              "termCommission": 0,
              "termFee": 0,
              "termPremium": 3000,
              "termTax": 0,
              "totalStandard": 3000,
              "totalTerm": 3000
            },
            "errors": [],
            "name": "Draft State Premium Dummy Policy -1",
            "recordId": "0YTfiP000000FdNGBU"
          }
        ]
      }
    },
    "sortOrder": -1,
    "version": 1
  }
]

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

{
  "inputs": [
    {
      "previewPolicyPremiumInputRepresentation": {
        "insurancePolicyId": "0YTfiP000000FdNGBU",
        "references": {
          "references": [ { "recordId": "0YTfiP000000FdNGBU" } ]
        }
      }
    }
  ]
}

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

[
  {
    "actionName": "previewPolicyPremium",
    "errors": null,
    "expectedError": false,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "previewPolicyPremiumOutputRepresentation": {
        "policyId": "0YTfiP000000FdNGBU",
        "results": [
          {
            "amounts": {
              "standardCommission": 0,
              "standardFee": 0,
              "standardPremium": 3000,
              "standardTax": 0,
              "termCommission": 0,
              "termFee": 0,
              "termPremium": 3000,
              "termTax": 0,
              "totalStandard": 3000,
              "totalTerm": 3000
            },
            "errors": [],
            "name": "Draft State Premium Dummy Policy -1",
            "recordId": "0YTfiP000000FdNGBU"
          }
        ]
      }
    },
    "sortOrder": -1,
    "version": 1
  }
]