> 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/revenue-desk-360/revenue-contract-more-actions/journal-transfer-hold-rc-level.md).

# Journal Transfer Hold - RC Level

## Holds Get

> This API is used to retrieve the Journal Transfer Hold on Revenue Contracts.<br>

```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/holds/v1/{rc_id}":{"get":{"description":"This API is used to retrieve the Journal Transfer Hold on Revenue Contracts.\n","parameters":[{"name":"rc_id","in":"path","required":true,"schema":{"type":"string","title":"Rc Id"},"description":"This is Revenue Contract Number. For e.g. RC-225\n"},{"name":"state","in":"path","required":true,"schema":{"type":"string","title":"state"},"description":"State is status of hold. Supported values are **active** or **released**.\n"}],"responses":{"200":{"description":"Get Holds","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","description":"This will display if any additional information is available. "},"holds_list":{"type":"array","items":{"type":"object","properties":{"applied_by":{"type":"string","description":"User ID of the person who applied the hold."},"applied_comments":{"type":"string","description":"Any comments added by user at the time of applying the hold."},"applied_on":{"type":"string","description":"Date & Timestamp of the hold policy applied on. Timestamp is a unix Epoch timestamp format."},"applied_period":{"type":"string","description":"Period Name for which user has applied the hold on revenue contract."},"file_id":{"type":"string","description":"A system generated alpha-numeric number."},"guid":{"type":"string","description":"A system generated alpha-numeric number"},"hold_name":{"type":"string","description":"Name of the Hold Policy applied on Revenue Contract."},"hold_type":{"type":"string","description":"Type of the hold policy."},"rc_version_when_applied":{"type":"string","description":"Version number of Revenue Contract at the time of applying hold"},"rc_version_when_released":{"type":"string","description":"Version number of Revenue Contract at the time of releasing hold"},"released_by":{"type":"string","description":"User ID of the person who released the hold."},"released_comments":{"type":"string","description":"Any comments added by user at the time of releasing the hold."},"released_file_id":{"type":"string","description":"A system generated alpha-numeric number."},"released_on":{"type":"string","description":"Date & Timestamp of the hold policy released on. Timestamp is a unix Epoch timestamp format."},"released_period":{"type":"string","description":"Period Name for which user has released the hold on revenue contract."},"state":{"type":"string","description":"State is status of hold. It could be applied or released."}},"required":["applied_by","applied_comments","applied_on","applied_period","file_id","guid","hold_name","hold_type","rc_version_when_applied","rc_version_when_released","released_by","released_comments","released_file_id","released_on","released_period","state"]},"description":"This will provide list of all holds applied or released on Revenue Contract."},"request_id":{"type":"null","description":"This is system generated alpha-numeric number."}},"required":["additional_info","holds_list","request_id"]}}}}},"tags":["Holds"],"summary":"Holds Get","operationId":"holds_get_apis_holds_v1__rc_id__get"}}}}
```

## Holds Sfdc

> This API is used to Apply or Release hold on Revenue contracts.<br>

```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/holds/v1/":{"post":{"description":"This API is used to Apply or Release hold on Revenue contracts.\n","responses":{"200":{"description":"Holds Sfdc","content":{"application/json":{"schema":{"type":"object","properties":{"additional_info":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","description":"This will display the action response. Either success or failure"},"applied_period":{"type":"string","description":"This is name of period in which hold is applied or released."},"status":{"type":"string","description":"This will show the status of action. Either Success or Failure."}},"required":["action","applied_period","status"]},"description":"This will display all the response information of action performed."},"request_id":{"type":"string","description":"A system generated alpha-numeric number."}},"required":["additional_info","request_id"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"holds_spec":{"type":"array","items":{"type":"object","properties":{"hold_type":{"type":"string","description":"This is type of Hold to be applied or released on Revenue Contract"},"comments":{"type":"string","description":"User can add comments to while applying or releasing the hold."},"hold_activity":{"type":"string","description":"This filed supports only two action. **Apply** or **Release**"},"revenue_contract_id":{"type":"string","description":"User need to provide Revenue Contract ID. For e.g. RC-225"},"hold_name":{"type":"string","description":"This is the name of hold policy user want to apply on Revenue Contract."}},"required":["comments","hold_activity","hold_name","hold_type","revenue_contract_id"]},"description":"This are the details associated with Hold Policy."}},"required":["holds_spec"]}}},"required":true},"tags":["Holds"],"summary":"Holds Sfdc","operationId":"holds_sfdc_apis_holds_v1__post"}}}}
```


---

# 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/revenue-desk-360/revenue-contract-more-actions/journal-transfer-hold-rc-level.md?ask=<question>&goal=<endgoal>
```

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