> 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/holds.md). # Holds ## Get Holds Policy > Retrieves hold policies created by the user and the system to prevent revenue release / recognition for the revenue contract. Also retrieves the inactive holds.
```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/holds":{"get":{"description":"Retrieves hold policies created by the user and the system to prevent revenue release / recognition for the revenue contract. Also retrieves the inactive holds.\n","responses":{"200":{"description":"Get Holds Policy","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"compliance_id":{"type":"string","description":"Provide compliance id to retrieve holds pertaining to that compliance id."},"compliance_name":{"type":"string","description":"Name of the policy fetched by the system."},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"A boolean field indicating whether the policy is active or not. If set to True, the policy is active; if False, the policy is not active."},"can_delete":{"type":"boolean","description":"A boolean field indicating whether the hold can be deleted or not. If set to True, the user is allowed to delete the hold; 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."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"hold_type":{"type":"string","description":"Displays the type of hold."},"is_user_defined":{"type":"boolean","description":"A boolean field indicating whether the hold is defined by the user or not. If set to True, the user is allowed to define the hold; if False, defining the hold is not permitted."},"name":{"type":"string","description":"Displays the name of the hold."},"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."},"when":{"type":"array","description":"A list of conditions that determine whether a specific action should be executed."}},"required":["active","can_delete","created_at","created_by","guid","hold_type","is_user_defined","name","updated_at","updated_by","when"]},"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."},"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 the policy."},"unique_key":{"type":"string","description":"Unique identifier generated by the system."},"version_id":{"type":"string","description":"Represents the latest version of the policy."}},"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 Holds Policy","operationId":"get_holds_policy_apis_policy_sets_v1_policy_holds_get"}}}} ``` ## Update Holds Policy > Create a new hold policy in the system to temporarily stop revenue release / recognition.
```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/holds/{compliance_id}":{"patch":{"description":"Create a new hold policy in the system to temporarily stop revenue release / recognition.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"Provide compliance id to define hold pertaining to that compliance id.\n"}],"responses":{"200":{"description":"Create a New Hold 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."}},"required":["error","message","unique_key"]},"description":"Displays the details of specific rules and standards processed by the system."},"compliance_id":{"type":"string","description":"Provide compliance id to delete an accounting calendar pertaining to that compliance id."},"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":"It's GUID. Globally unique identifier generated by the system."},"format_type":{"type":"string","description":"Format of the payload. For e.g. JSON"},"compliance_spec":{"type":"array","items":{"type":"object","properties":{"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."},"name":{"type":"string","description":"Name of the hold policy."},"guid":{"type":"string","description":"Globally unique identifier generated by the system."},"hold_type":{"type":"string","description":"Type of the hold. For e.g Transfer "},"active":{"type":"boolean","description":"A boolean field indicating whether the policy is Active or not. If set to True, the policy is Active; if false, it's Inactive."},"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."},"when":{"type":"array","description":"A list of conditions that determine whether a specific action should be executed."}},"required":["active","can_delete","guid","hold_type","is_user_defined","name","when"]},"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 Holds Policy","operationId":"update_holds_policy_apis_policy_sets_v1_policy_holds__compliance_id__patch"}}}} ``` ## Delete Holds Policy > Delete the existing hold policies in the RightRev 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/holds/{compliance_id}/{object_unique_value}":{"delete":{"description":"Delete the existing hold policies in the RightRev system.\n","parameters":[{"name":"compliance_id","in":"path","required":true,"schema":{"type":"string","title":"Compliance Id"},"description":"Provide compliance id to delete hold pertaining to that compliance. id.\n"},{"name":"object_unique_value","in":"path","required":true,"schema":{"type":"string","title":"Object Unique Value"},"description":"Unique object identifier generated by the system.\n"}],"responses":{"200":{"description":"Delete Holds Policy","content":{"application/json":{"schema":{"type":"object","properties":{"compliance_details":{"type":"array","description":"Displays the details of specific rules and standards processed by the system."},"compliance_id":{"type":"string","description":"Provide compliance id to delete hold pertaining to that compliance id."},"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"]}}}}},"tags":["Policy Sets"],"summary":"Delete Holds Policy","operationId":"delete_holds_policy_apis_policy_sets_v1_policy_holds__compliance_id___object_unique_value__delete"}}}} ``` --- # 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/holds.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.