Get Started with Insurance Developer Resources
Process Member Enrollment Action
Renew Group Census Member Policies Action
Process Member Plans for Mid-Term Adjustment Action
Apply Contract Adjustment to Member Policy Action
Previous PDF Versions
Apply contract adjustment to group insurance policy for a primary group census member and a contract group plan. For each plan, the action enrolls a new policy, endorses an existing policy, or cancels a policy for a removed plan based on the endorsed contract version and the member’s plan configuration.
This action is available in API version 68.0 and later.
URI: /services/data/vXX.X/actions/standard/applyContractAdjToMemberPolicy
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.
| Input | Type | Description |
|---|---|---|
contractGroupPlanId | string | Required. ID of the root contract group plan to retrieve the associated product and member plan configuration for the endorsed contract version. |
groupCensusMemberId | string | Required. ID of the primary group census member whose insurance policies must be processed because of contract mid-term adjustment. |
pricingResult | Apex-defined | Optional. An Apex ind_ins_grpben__MembersPlansRatingOutput record that contains the pricing result for the member’s plans. Used when creating a new policy version as part of a contract mid-term adjustment during enrollment and endorsement operations if shouldReprice is set to True . |
| Output | Type | Description |
|---|---|---|
insurancePolicyIds | string | List of IDs for the insurance policies that are issued, endorsed, or canceled. |
POST
This sample request is for the Apply Contract Adjustments to Member Policy action when a group insurance policy is enrolled or endorsed for a primary group census member.
1{
2 "inputs": [
3 {
4 "groupCensusMemberId": "a1Hxx0000001AAA",
5 "contractGroupPlanId": "0YQ000000000001AAA",
6 "pricingResult": {
7 "pricingResults": [
8 {
9 "memberId": "a1Hxx0000001AAA",
10 "plans": [
11 {
12 "planId": "0YQ000000000001AAA",
13 "rates": [
14 {
15 "key": "NetUnitPrice",
16 "value": 150
17 }
18 ],
19 "proratedRates": [
20 {
21 "key": "NetUnitPrice",
22 "value": 125
23 }
24 ],
25 "contributions": {
26 "employeePremiumAmount": 50,
27 "employerPremiumAmount": 100
28 }
29 }
30 ]
31 }
32 ],
33 "errors": []
34 }
35 }
36 ]
37}This sample request is for the Apply Contract Adjustments to Member Policy action when a group insurance policy is canceled for a primary group census member.
1{
2 "inputs": [
3 {
4 "groupCensusMemberId": "a1Hxx0000001AAA",
5 "contractGroupPlanId": "0YQ000000000001AAA"
6 }
7 ]
8}This is a successful sample response is for the Apply Contract Adjustments to Member Policy action.
1[
2 {
3 "actionName": "applyContractAdjToMemberPolicy",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "insurancePolicyIds": ["1RPv00000000010AAA", "1RPv00000000011AAA"]
10 },
11 "sortOrder": -1,
12 "version": 1
13 }
14]This is a sample response with errors for the Apply Contract Adjustments to Member Policy action.
1[
2 {
3 "actionName": "applyContractAdjToMemberPolicy",
4 "errors": [
5 {
6 "statusCode": "INVALID_INPUT",
7 "message": "The groupCensusMemberId parameter is required.",
8 "fields": []
9 }
10 ],
11 "invocationId": null,
12 "isSuccess": false,
13 "outcome": null,
14 "outputValues": {
15 "insurancePolicyIds": null
16 },
17 "sortOrder": -1,
18 "version": 1
19 }
20]