Newer Version Available

This content describes an older version of this product. View Latest

Insurance Policy Limit Current Standings (POST)

Get the calculated current standings (consumption status) for all applicable insurance policy limits. This API retrieves standings based on the policy, claim, claim coverage as well as policy coverage, insurance policy participant, and insurance policy asset.

This API accepts only one ID per request, either policyId or claimId.

Resource
1/connect/insurance/policy-limit/calculate-standings
Resource example
1https://yourInstance.salesforce.com/services/data/v65.0/connect/insurance/policy-limit/calculate-standings
Available version
65.0
HTTP methods
POST
Request body for POST
JSON example
This example queries for standings at the entire policy level, using the viewOption parameter to get a summary, including pending amounts.
1{
2  "policyId": "01t000000000000001",
3  "claimId": null,
4  "claimCoverageId": null,
5  "policyParticipantId": null,
6  "policyAssetId": null,
7  "policyCoverageId": null,
8  "options": {
9    "viewOption": "showAllPolicyCoverages",
10    "shouldIncludePendingAmount": true
11  }
12}
This example gets the specific limits that are impacted by a single claim, excluding pending amounts.
1{
2  "policyId": null,
3  "claimId": "01t000000000000001",
4  "claimCoverageId": null,
5  "policyParticipantId": null,
6  "policyAssetId": null,
7  "policyCoverageId": null,
8  "options": {
9    "viewOption": "showOpenClaimPolicyCoverages",
10    "shouldIncludePendingAmount": false
11  }
12}
Properties
Name Type Description Required or Optional Available Version
claimCoverageId String ID of the claim coverage record. Optional 65.0
claimId String ID of the claim. Required to get the standings for a claim 65.0
options Limit Standing Option Input Options for the calculation. Optional 65.0
policyAssetId String ID of the policy asset. Optional 65.0
policy​CoverageId String ID of the policy coverage record. Optional 65.0
policyId String ID of the insurance policy. Required to get the standings for a policy 65.0
policy​ParticipantId String ID of the policy participant. Optional 65.0
Response body for POST
Insurance Policy Limit Current Standings Response