Unfinalize

Pricing finalized and finalized claims can be brought back in the "Change" status by the unfinalize operation. The steps of unfinalizing are described in Unfinalize Claim

When a claim is in either in the status "Finalized" or "Pricing Finalized" and the claim is not settled, an unfinalize link is added to the claim resource:

   ... claim properties ...
 "links": [
    {
      "href": "http://<host>:<port>/api/generic/claims/<id>",
      "rel": "self"
    },
    {
      "href": "http://<host>:<port>/api/claims/<claim id>/unfinalize",
      "rel": "claim:unfinalize",
      "httpMethod": "POST"
    }
  ]
}

Clients must send one or more claim unfinalize reasons in the POST payload:

{
  "claimunfinalizeReasonList": [
  {
    "sourceReference": "<source reference value>",
    "unfinalizeReason": {
      "id": "<id of unfinalize reason>"
    }
  },
  {
    "unfinalizeReason": {
      "code": "<code of 2nd unfinalize reason>"
    }
  }  {
    "unfinalizeReason": {
      "id": "<id of 3rd unfinalize reason>"
    }
  }]
}

In the example, 2 unfinalize reasons are passed as parameters. More are possible, but at least one is required. Without an unfinalize reason, HTTP Status 400 (Bad Request) is returned, with additional error message CLA-CLUR-002 "To unfinalize a claim, you must enter at least one unfinalize reason".

The unfinalize reasons can be identified by their "id" or their "code" attribute. If both are specified, the id is used to find the unfinalize reason.

unfinalize reasons are always protected by access restrictions. HTTP API operations enforces those access restrictions:

  1. HTTP status 403 is returned if the current user does not have the access rights for all the unfinalize reasons in the payload. Error as specified in the Unfinalize Claim for missing access grant on the unfinalize reason is also returned

  2. If any rights are missing, no change is made at all to the claim or any of its details.

The unfinalize reasons in the payload will replace possibly existing unfinalize reasons for the claim. HTTP Status 200 is returned together with a representation of the claim resource (which is now in status Change").

Authorization

The operation in this section is protected by access restriction "claims.unfinalize IP". A grant must be given with both the Read and Update flag set. A Read grant must also be given to access restriction "claims API".

Response Message

Success

HTTP 303 SEE OTHER after the operation is completed successfully, request is redirected to claims API.

Failure

.Failure

Response Description

HTTP 401

Unauthorized

HTTP 404

Claim is unknown

HTTP 409

Claim is not in a status that allows unfinalize

Please refer to the "Response Messages" section in the HTTP API Integration Points part of the Common Features book for more details.