Contract Amendments

Specifies the rules for processing changes to a contract, including upgrades, downgrades, and modifications triggered by API inputs.

Get Contract Amendment Policy

get

/apis/policy-sets/v1/policy/contract-amendments

To retrieves all the contract amendment policies setup in system.

Responses

200

Get contract amendment Policy

application/json

compliance_idstringRequired

A system-generated compliance ID to retrieve the contract amendment Policies

compliance_namestringRequired

Name of the policy fetched by the system.

created_bystringRequired

ID of the user who created the policy. Example: [e-mail]

created_onintegerRequired

Timestamp of the policy created by the user. This is a unix Epoch timestamp format

last_modified_bystringRequired

ID of the user last modified by

last_modified_onintegerRequired

Timestamp of the policy last modified on. This is a unix Epoch timestamp format

policy_typestringRequired

Represents the type of policy

statusstringRequired

Represents the status of policy

unique_keystringRequired

Globally unique identifier generated by the system.

version_idstringRequired

Unique alpha-numeric number generated by the system

get/apis/policy-sets/v1/policy/contract-amendments

GET /apis/policy-sets/v1/policy/contract-amendments HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get contract amendment Policy

[
  {
    "compliance_id": "3241415b-eaf0-42f7-933f-a0e52bd6616b",
    "compliance_name": "Contract amendment",
    "compliance_spec": [
      {
        "amendment_reason_and_treatment": [
          {
            "accelerate_revenue": true,
            "can_delete": true,
            "is_user_defined": true,
            "reason": "Increase Quantity",
            "treatment": "retrospective"
          },
          {
            "accelerate_revenue": false,
            "can_delete": false,
            "is_user_defined": false,
            "reason": "New",
            "treatment": "prospective"
          },
          {
            "accelerate_revenue": false,
            "can_delete": false,
            "is_user_defined": false,
            "reason": "Cancel Full Obligation",
            "treatment": "retrospective"
          },
          {
            "accelerate_revenue": false,
            "can_delete": false,
            "is_user_defined": false,
            "reason": "Cancel",
            "treatment": "prospective"
          }
        ],
        "can_delete": false,
        "created_at": 1758630293,
        "created_by": "RIGHTREV",
        "guid": "aabcd281-4f27-4ac5-a414-1263aa1dc75e",
        "is_user_defined": false,
        "new_product_at_ssp": "in_allocation",
        "revenue_contract_initial_timeline": "rc_creation_period",
        "updated_at": 1767684200,
        "updated_by": "[e-mail]"
      }
    ],
    "created_by": "RIGHTREV",
    "created_on": 1767684208,
    "last_modified_by": "RIGHTREV",
    "last_modified_on": 1767684208,
    "policy_type": "contract-amendments",
    "status": "Active",
    "unique_key": "guid",
    "version_id": "a1de23a8-4fdd-4167-8a7d-a7ad285baf37"
  }
]

Update Contract Amendment Policy

patch

/apis/policy-sets/v1/policy/contract-amendments/{compliance_id}

• To create, update and delete the contract amendment policies in the system.
• To DELETE any amendment policy or policies user has to remove that specific policy details from the payload.

Path parameters

compliance_idstringRequired

A system-generated compliance ID to edit the policy.

Body

compliance_namestringRequired

Name of the policy.

unique_keystringRequired

Globally unique identifier generated by the system.

format_typestringRequired

Format type of the request code used to collect data - For e.g. JSON

Responses

200

Create, Update or Delete contract amendment Policy

application/json

compliance_idstringRequired

A system-generated compliance ID to create, update or delete the amendment rule.

errorarrayRequired

Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.

patch/apis/policy-sets/v1/policy/contract-amendments/{compliance_id}

PATCH /apis/policy-sets/v1/policy/contract-amendments/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 701

{
  "compliance_name": "Contract amendment",
  "unique_key": "guid",
  "format_type": "json",
  "compliance_spec": [
    {
      "revenue_contract_initial_timeline": "rc_creation_period",
      "new_product_at_ssp": "in_allocation",
      "amendment_reason_and_treatment": [
        {
          "reason": "Increase Quantity",
          "treatment": "retrospective",
          "is_user_defined": true,
          "can_delete": true
        },
        {
          "reason": "New",
          "treatment": "prospective",
          "is_user_defined": false,
          "can_delete": false
        },
        {
          "reason": "Cancel",
          "treatment": "prospective",
          "is_user_defined": false,
          "can_delete": false
        },
        {
          "reason": "Cancel Full Obligation",
          "treatment": "retrospective",
          "is_user_defined": false,
          "can_delete": false
        }
      ],
      "is_user_defined": true,
      "can_delete": true,
      "guid": "0e3efa97-bf37-4713-9073-f08b046b4b3f"
    }
  ]
}

200

Create, Update or Delete contract amendment Policy

{
  "compliance_details": [
    {
      "error": [],
      "message": "updated successfully",
      "unique_key": "0e3efa97-bf37-4713-9073-f08b046b4b3f"
    }
  ],
  "compliance_id": "fc4edc57-6bcb-4204-b6dc-878c3f8e2afe",
  "error": []
}