> 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-details/retrieve-revenue-contract-metrics-details.md).

# Retrieve Revenue Contract Metrics Details

Method - GET

API End Point

```
apis/recorder/v1/revenue_contract/<RC id>?object=rc_metrics
```

Path Parameters&#x20;

<table><thead><tr><th width="133">Key</th><th>Values</th></tr></thead><tbody><tr><td>1. page<br>2. page_size<br>3. object</td><td>1. 1<br>2. 10<br>3. rc_metrics</td></tr></tbody></table>

**Sample API End Point** &#x20;

```
/apis/recorder/v1/revenue_contract/RC-442?object=rc_metrics&page_number=1&page_size=10
```

* Above sample endpoint will fetch **Revenue Contract Metrics of RC-442** in RightRev system.

**Screenshot for reference**

<div data-with-frame="true"><figure><img src="/files/fIEnbmocZvBkL1IBNHtr" alt=""><figcaption></figcaption></figure></div>

Response

```
"{
    ""RC-423"": [
        {
            ""allocation_treatment"": ""Prospective"",
            ""billed_amount"": 0,
            ""ca_cl_balance"": 1227.08,
            ""ca_cl_position"": ""contract_asset"",
            ""carves_currency_code"": ""USD"",
            ""carves_currency_type"": ""transaction_currency"",
            ""carves_in"": 299.73,
            ""carves_out"": -299.73,
            ""contract_created_period"": ""Feb-21"",
            ""contract_modified_period"": ""Mar-21"",
            ""current_qtr_revenue"": 1880.15,
            ""customer_name"": ""KJ"",
            ""fx_adjustments"": 0,
            ""fx_adjustments_func_currency"": ""USD"",
            ""grouping_value"": {
                ""legal_entity"": ""LE_19"",
                ""order_number"": ""ON_SNOW-1554_AA_1"",
                ""tenant_id"": ""pi-snow-kri"",
                ""transaction_currency"": ""USD""
            },
            ""holds_status"": null,
            ""legal_entity"": ""LE_19"",
            ""manually_created_rc"": false,
            ""next_qtr_revenue"": 419.85,
            ""prior_qtr_revenue"": 0,
            ""revenue_contract_id"": ""RC-423"",
            ""revenue_contract_version"": 2,
            ""revenue_planned"": 1072.92,
            ""revenue_recognized"": 1227.08,
            ""revenue_unplanned"": 0,
            ""ssp_min_func_exchange_rate"": 1,
            ""ssp_min_rep_exchange_rate"": 1,
            ""status"": ""Recognize Revenue"",
            ""total_contract_value"": 2300
        }
    ],
    ""total_records"": 1
}"
```

**Description of the fields**

<table><thead><tr><th width="197">Field Name</th><th width="440">Description</th><th width="219">Example</th></tr></thead><tbody><tr><td>allocation_treatment</td><td>Method used for revenue allocation for the RC.</td><td>Prospective</td></tr><tr><td>billed_amount</td><td>Total billed amount for the RC.</td><td>0</td></tr><tr><td>ca_cl_balance</td><td>Balance in contract asset or contract liability.</td><td>1227.08</td></tr><tr><td>ca_cl_position</td><td>Indicates if balance is a contract asset or liability.</td><td>contract_asset</td></tr><tr><td>carves_currency_code</td><td>Currency code used for carves calculations.</td><td>USD</td></tr><tr><td>carves_currency_type</td><td>Currency type for carve calculations (transaction/functional).</td><td>transaction_currency</td></tr><tr><td>carves_in</td><td>Revenue amount added due to carve‑in.</td><td>299.73</td></tr><tr><td>carves_out</td><td>Revenue deducted due to carve‑out.</td><td>-299.73</td></tr><tr><td>contract_created_period</td><td>Accounting period when the RC was created.</td><td>Feb‑21</td></tr><tr><td>contract_modified_period</td><td>Accounting period when the RC was last modified.</td><td>Mar‑21</td></tr><tr><td>current_qtr_revenue</td><td>Revenue recognized in the current quarter.</td><td>1880.15</td></tr><tr><td>customer_name</td><td>Name of the customer for this RC.</td><td>KJ</td></tr><tr><td>fx_adjustments</td><td>FX adjustment amount on revenue.</td><td>0</td></tr><tr><td>fx_adjustments_func_currency</td><td>Functional currency used for FX adjustments.</td><td>USD</td></tr><tr><td>grouping_value</td><td>RC grouping identifiers (composite values).<br>Legal Entity<br>Order Number<br>Tenant Id<br>Transaction Currency</td><td>{legal_entity: LE_19, …}</td></tr><tr><td>holds_status</td><td>Status of revenue holds.</td><td>null</td></tr><tr><td>legal_entity</td><td>Legal entity associated with the RC.</td><td>LE_19</td></tr><tr><td>manually_created_rc</td><td>Whether RC was created manually.</td><td>FALSE</td></tr><tr><td>next_qtr_revenue</td><td>Revenue expected in next quarter.</td><td>419.85</td></tr><tr><td>prior_qtr_revenue</td><td>Revenue recognized in previous quarter.</td><td>0</td></tr><tr><td>revenue_contract_id</td><td>Unique identifier of the RC.</td><td>RC‑423</td></tr><tr><td>revenue_contract_version</td><td>Version number of the RC.</td><td>2</td></tr><tr><td>revenue_planned</td><td>Planned revenue for the RC.</td><td>1072.92</td></tr><tr><td>revenue_recognized</td><td>Total revenue recognized till now.</td><td>1227.08</td></tr><tr><td>revenue_unplanned</td><td>Unplanned revenue amount.</td><td>0</td></tr><tr><td>ssp_min_func_exchange_rate</td><td>Minimum functional FX rate used for SSP.</td><td>1</td></tr><tr><td>ssp_min_rep_exchange_rate</td><td>Minimum reporting FX rate used for SSP.</td><td>1</td></tr><tr><td>status</td><td>Current processing status of RC.</td><td>Recognize Revenue</td></tr><tr><td>total_contract_value</td><td>Total value of the contract.</td><td>2300</td></tr><tr><td>total_records</td><td>Total number of RC entries returned.</td><td>1</td></tr></tbody></table>


---

# 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-details/retrieve-revenue-contract-metrics-details.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.