Apply Contract Adjustment to Member Policy Action

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.

Supported REST HTTP Methods

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.

Inputs

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` .

Outputs

Output	Type	Description
insurancePolicyIds	string	List of IDs for the insurance policies that are issued, endorsed, or canceled.

Example

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.

{
  "inputs": [
    {
      "groupCensusMemberId": "a1Hxx0000001AAA",
      "contractGroupPlanId": "0YQ000000000001AAA",
      "pricingResult": {
        "pricingResults": [
          {
            "memberId": "a1Hxx0000001AAA",
            "plans": [
              {
                "planId": "0YQ000000000001AAA",
                "rates": [
                  {
                    "key": "NetUnitPrice",
                    "value": 150
                  }
                ],
                "proratedRates": [
                  {
                    "key": "NetUnitPrice",
                    "value": 125
                  }
                ],
                "contributions": {
                  "employeePremiumAmount": 50,
                  "employerPremiumAmount": 100
                }
              }
            ]
          }
        ],
        "errors": []
      }
    }
  ]
}

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.

{
  "inputs": [
    {
      "groupCensusMemberId": "a1Hxx0000001AAA",
      "contractGroupPlanId": "0YQ000000000001AAA"
    }
  ]
}

This is a successful sample response is for the Apply Contract Adjustments to Member Policy action.

[
  {
    "actionName": "applyContractAdjToMemberPolicy",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "insurancePolicyIds": ["1RPv00000000010AAA", "1RPv00000000011AAA"]
    },
    "sortOrder": -1,
    "version": 1
  }
]

This is a sample response with errors for the Apply Contract Adjustments to Member Policy action.

[
  {
    "actionName": "applyContractAdjToMemberPolicy",
    "errors": [
      {
        "statusCode": "INVALID_INPUT",
        "message": "The groupCensusMemberId parameter is required.",
        "fields": []
      }
    ],
    "invocationId": null,
    "isSuccess": false,
    "outcome": null,
    "outputValues": {
      "insurancePolicyIds": null
    },
    "sortOrder": -1,
    "version": 1
  }
]