Get Insurance Policy Current Standings Action

Get the current standings of the insurance policy.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/v67.0/actions/standard/getInsPolicyCurrentStandings
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
getInsPlcyCurrStndInputRep
Type
Apex-defined
Description

Required.

An Apex ConnectApi.GetInsPlcyCurrStndInputRep record that contains the details to retrieve the consumed and available limits for the policy or claim.

Outputs

Output Details
getInsPlcyCurrStndOutputRep
Type
Apex-defined
Description
An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy claim.

Example

Sample Request

1{
2  "inputs": [
3    {
4      "getInsPlcyCurrStndInputRep": {
5        "policyId": "01t000000000000001",
6        "claimId": null,
7        "policyParticipantId": null,
8        "policyAssetId": null,
9        "policyCoverageId": null,
10        "claimCoverageId": null,
11        "options": {
12          "viewOption": "showAllPolicyCoverages",
13          "shouldIncludePendingAmount": true
14        }
15      }
16    }
17  ]
18}

Sample Response

1[
2  {
3    "actionName": "getInsPolicyCurrentStandings",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "getInsPlcyCurrStndOutputRep": [
10        {
11          "iplStandingCalcOutputNodes": [
12            {
13              "amounts": {
14                "initialAmount": 500,
15                "pendingAmount": 25,
16                "predictedRemainingAmount": 325,
17                "remainingAmount": 350,
18                "totalUsedAmount": 150
19              },
20              "coverageInfo": {
21                "claimCoverageId": "1TDSG0000007HU84AM",
22                "claimId": "0cYSG000000UYlq2AG",
23                "policyAssetId": "0cYSG000000UYzt2XY",
24                "policyCoverageId": "0cYSG000000UYlq2AG",
25                "policyParticipantId": "sdfbdsf976sff",
26                "subCoverageName": "auto-parts"
27              },
28              "limitAttributes": {
29                "applicableAction": [
30                  "PaymentAttempted"
31                ],
32                "durationType": "PolicyTerm",
33                "category": "LimitCurrency",
34                "policyLimitStandingKey": "PolicyCover LimitCurrency"
35              },
36              "mappedScopes": {
37                "parentMappedScopeId": "a0MS70000004oVfIAI",
38                "prodtAttrMappedScopeId": "a0MS70000004oVgIAI"
39              },
40              "values": {
41                "initialValue": 10000,
42                "pendingValue": 500,
43                "predictedRemainingValue": 8000,
44                "remainingValue": 8500,
45                "totalUsedValue": 1500
46              }
47            }
48          ]
49        }
50      ]
51    },
52    "sortOrder": -1,
53    "version": 1
54  }
55]