> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/policy-sets/configuration/revenue-policies/contract-amendments.md). # Contract Amendments ## Get Contract Amendment Policy > To retrieves all the contract amendment policies setup in system.
```json {"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/contract-amendments":{"get":{"description":"To retrieves all the contract amendment policies setup in system.\n","responses":{"200":{"description":"Get contract amendment Policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"A system-generated compliance ID to retrieve the contract amendment Policies"},"compliance_name":{"type":"string","description":"Name of the policy fetched by the system."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"amendment_reason_and_treatment":{"type":"array","items":{"type":"object","properties":{"accelerate_revenue":{"type":"boolean","description":"A boolean flag that, when set to True, accelerates both planned and unplanned revenue for the amendment line and its parent line into the current open period; when False, revenue follows the standard recognition schedule."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the event policy can be deleted or not. If set to True, the user is allowed to delete the event policy; if False, deletion is not permitted."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"reason":{"type":"string","description":"Name of the Amendment Reason Policy."},"treatment":{"type":"string","description":"Treatment of the amendment policy. Either Prospective or Retrospective."}},"required":["accelerate_revenue","can_delete","is_user_defined","reason","treatment"]},"description":"Name of amendment reason policy and it's treatment"},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the policy can be deleted or not. If set to True, the user is allowed to delete the policy; if False, deletion is not permitted."},"created_at":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"new_product_at_ssp":{"type":"string","description":"It's a configuration field where new product in revision period should Participate in allocation or not. Values to be configured are **in_Allocation** or **no_Allocation**."},"revenue_contract_initial_timeline":{"type":"string","description":"It's a configuration field to determine Revenue Contract Initial Timeline. Values to be configured are **rc_creation_period** or **rc_creation_quarter**."},"updated_at":{"type":"integer","description":"Timestamp of the policy updated by the user. This is a unix Epoch timestamp format"},"updated_by":{"type":"string","description":"ID of the user who updated the policy. Example: username@rightrev.com"}},"required":["amendment_reason_and_treatment","can_delete","created_at","created_by","guid","is_user_defined","new_product_at_ssp","revenue_contract_initial_timeline","updated_at","updated_by"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."},"created_by":{"type":"string","description":"ID of the user who created the policy. Example: username@rightrev.com"},"created_on":{"type":"integer","description":"Timestamp of the policy created by the user. This is a unix Epoch timestamp format"},"last_modified_by":{"type":"string","description":"ID of the user last modified by"},"last_modified_on":{"type":"integer","description":"Timestamp of the policy last modified on. This is a unix Epoch timestamp format"},"policy_type":{"type":"string","description":"Represents the type of policy"},"status":{"type":"string","description":"Represents the status of policy"},"unique_key":{"type":"string","description":"Globally unique identifier generated by the system."},"version_id":{"type":"string","description":"Unique alpha-numeric number generated by the system"}},"required":["compliance_id","compliance_name","compliance_spec","created_by","created_on","last_modified_by","last_modified_on","policy_type","status","unique_key","version_id"]}}}}}},"tags":["Policy Sets"],"summary":"Get Contract Amendment Policy","operationId":"get_contract_amendment_policy_apis_policy_sets_v1_policy_contract_amendments_get"}}}} ``` ## Update Contract Amendment Policy > \- 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.
```json {"openapi":"3.1.0","info":{"title":"RightRev API(s)","version":"1.0.0"},"servers":[{"description":"RightRev APP Server","url":"https://{realm}.{env}.rightrev.cloud/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}},{"description":"RightRev Auth Server","url":"https://authn.{env}.rightrev.cloud/auth/realms/{realm}/protocol/openid-connect/","variables":{"env":{"default":"{env}"},"realm":{"default":"{realm}"}}}],"security":[],"paths":{"/apis/policy-sets/v1/policy/contract-amendments/{compliance_id}":{"patch":{"description":"- To create, update and delete the contract amendment policies in the system.\n- To DELETE any amendment policy or policies user has to remove that specific policy details from the payload.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"A system-generated compliance ID to edit the policy.\n"}],"responses":{"200":{"description":"Create, Update or Delete contract amendment Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_details":{"type":"array","items":{"type":"object","properties":{"error":{"type":"array","description":"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."},"message":{"type":"string","description":"Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed."},"unique_key":{"type":"string","description":"Unique identifier generated by the system. Example: xyz_345"}},"required":["error","message","unique_key"]},"description":"Displays the details of specific rules and standards processed by the system."},"compliance_id":{"type":"string","description":"A system-generated compliance ID to create, update or delete the amendment rule."},"error":{"type":"array","description":"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."}},"required":["compliance_details","compliance_id","error"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"compliance_name":{"type":"string","description":"Name of the policy."},"unique_key":{"type":"string","description":"Globally unique identifier generated by the system."},"format_type":{"type":"string","description":"Format type of the request code used to collect data - For e.g. JSON"},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"revenue_contract_initial_timeline":{"type":"string","description":"It's a configuration field to determine Revenue Contract Initial Timeline. User has to provide values to be configured are **rc_creation_period** or **rc_creation_quarter**"},"new_product_at_ssp":{"type":"string","description":"It's a configuration field where new product in revision period should Participate in allocation or not. User has to provide values to be configured are **in_Allocation** or **no_Allocation**."},"amendment_reason_and_treatment":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":"User has to provide name of the Amendment Reason Policy."},"treatment":{"type":"string","description":"User has to provide treatment of the amendment policy. Either Prospective or Retrospective."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the event policy can be deleted or not. If set to True, the user is allowed to delete the event policy; if False, deletion is not permitted."}},"required":["can_delete","is_user_defined","reason","treatment"]},"description":"Name of amendment reason policy and it's treatment"},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the policy is defined by the user or not. If set to True, the user is allowed to define the policy; if False, defining the policy is not permitted."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the event policy can be deleted or not. If set to True, the user is allowed to delete the event policy; if False, deletion is not permitted."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."}},"required":["amendment_reason_and_treatment","can_delete","guid","is_user_defined","new_product_at_ssp","revenue_contract_initial_timeline"]},"description":"Defines the specific rules and standards where a system must process adhering to the compliant."}},"required":["compliance_name","compliance_spec","format_type","unique_key"]}}},"required":true},"tags":["Policy Sets"],"summary":"Update Contract Amendment Policy","operationId":"update_contract_amendment_policy_apis_policy_sets_v1_policy_contract_amendments__compliance_id__patch"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://apis.rightrev.com/rightrev-rest-api/policy-sets/configuration/revenue-policies/contract-amendments.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.