> 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-search.md).

# Revenue Contract Search

## Get Rc Search

> To retrieve the Revenue Contract details.<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/rc-search/v1/search":{"get":{"description":"To retrieve the Revenue Contract details.\n","parameters":[{"name":"searchTerm","in":"path","required":true,"schema":{"type":"string","title":"searchTerm"},"description":"Using this parameter user can fetch Revenue Contract ID details. Values can be used to search are Revenue Contract ID , Order Number, Invoice Number or Customer Name.\n"},{"name":"q","in":"path","required":true,"schema":{"type":"string","title":"q"},"description":"This Parameter is used to fetch recently created, recently viewed, on hold, most valued contracts, modified contracts or manually created Revenue Contract details.\n"},{"name":"view_cnt","in":"path","required":false,"schema":{"type":"string","title":"view_cnt"},"description":"This parameter will fetch recently created 50 Revenue contract details.\n"}],"responses":{"200":{"description":"RC Search","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"This count is no of Revenue Contracts fetched by using the APIs."},"data_items":{"type":"array","items":{"type":"object","properties":{"allocation_type":{"type":"string","description":"This will show the Allocation status of Revenue Contract. For e.g Prospective, Retrospective, Prospective - Within SSP Range"},"amendment_version":{"type":"integer","description":"Version number represents how many times the Revenue Contract is modified or amended."},"billed":{"type":"integer","description":"The total amount billed in Revenue Contract"},"ca_cl_position":{"type":"string","description":"It will show the status or position of Revenue Contract. For e.g Contract Asset Position or Contract Liability position."},"created_date":{"type":"string","description":"Date and Timestamp of the Revenue Contract created by the user. Timestamp is in a unix Epoch format."},"created_period":{"type":"string","description":"Period name and year of the period in which Revenue Contract is created."},"customer":{"type":"string","description":"Name of the customer."},"isonhold":{"type":"null","description":"Hold status of Revenue Contract"},"modified_date":{"type":"string","description":"Date and Timestamp of the Revenue Contract modified by the user. Timestamp is in a unix Epoch format."},"modified_period":{"type":"null","description":"Period name and year of the period in which Revenue Contract is modified."},"name":{"type":"string","description":"Revenue Contract Number. For e.g. RC-225"},"recognized":{"type":"integer","description":"Amount recognized out of total contract value till current period."},"scheduled":{"type":"integer","description":"Future scheduled amount out of total contract value."},"stage":{"type":"string","description":"Status of Revenue contract. For e.g. If Revenue Contract still having unplanned revenue then contract is at Recognize Revenue stage."},"transactional_currency_code":{"type":"string","description":"Transactional currency code of the Revenue Contract."},"value":{"type":"integer","description":"Total contract value of the Revenue Contract."},"version":{"type":"integer","description":"Version of the Revenue Contract."}},"required":["allocation_type","amendment_version","billed","ca_cl_position","created_date","created_period","customer","isonhold","modified_date","modified_period","name","recognized","scheduled","stage","transactional_currency_code","value","version"]},"description":"Details of the Revenue Contract. "},"message":{"type":"string","description":"Message of the search. For e.g. RC Search Successfully returned"}},"required":["count","data_items","message"]}}}}},"tags":["RC Search"],"summary":"Get Rc Search","operationId":"get_rc_search_apis_rc_search_v1_search_get"}}}}
```


---

# 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-search.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.
