> 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/re-group/retrieve-revenue-contract-lines-eligible-for-regroup.md).

# Retrieve Revenue Contract Lines Eligible for Regroup

This API is to retrieve all the revenue contract order lines eligible for regroup to new or existing revenue contract.

Method - GET

API End Point

```
apis/recorder/v1/revenue_contract/<RC id>?object=rc_regroup&page_number=1&page_size=10
```

Query 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_regroup</td></tr></tbody></table>

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

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

* Above sample endpoint will fetch 10 records of **Order lines from Revenue Contract No 442** eligible for regroup to another or new revenue contract in RightRev system from page number 1.

Screenshot for reference

<div data-with-frame="true"><figure><img src="https://3364757261-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F193S0RVwbPrcp6u9CoPJ%2Fuploads%2F8ZRgO3dwVyDlalaRX5hI%2Fimage.png?alt=media&amp;token=05d37af0-4e29-4411-b9a0-f111969ca972" alt=""><figcaption></figcaption></figure></div>

Response

```
"{
    ""rc_regroup"": [
        {
            ""Perf-ORD-01-01"": {
                ""carves_amount"": 0,
                ""carves_eligible"": false,
                ""created_period"": ""Jan-2023"",
                ""cumulative_carves_amount"": 0,
                ""distribution_method"": ""Prorate"",
                ""functional_currency"": ""USD"",
                ""order_date"": ""2023-01-01"",
                ""order_financial_id"": ""Perf-ORD-01-01"",
                ""order_number"": ""Perf-ORD-01"",
                ""product_name"": ""Booking_Prorate"",
                ""revenue_end_date"": ""2023-12-31"",
                ""revenue_planned"": 39000,
                ""revenue_recognized"": 0,
                ""revenue_start_date"": ""2023-01-01"",
                ""revenue_trigger"": ""Booking"",
                ""revenue_unplanned"": 0,
                ""ssp_percent"": null,
                ""total_billed_amount"": 39000,
                ""total_list_price_functional"": 50000,
                ""total_list_price_transactional"": 50000,
                ""total_sell_price_functional"": 39000,
                ""total_sell_price_transactional"": 39000,
                ""transaction_currency"": ""USD""
            }
        },
        {
            ""Perf-ORD-01-02"": {
                ""carves_amount"": 0,
                ""carves_eligible"": false,
                ""created_period"": ""Jan-2023"",
                ""cumulative_carves_amount"": 0,
                ""distribution_method"": ""Prorate"",
                ""functional_currency"": ""USD"",
                ""order_date"": ""2023-01-01"",
                ""order_financial_id"": ""Perf-ORD-01-02"",
                ""order_number"": ""Perf-ORD-01"",
                ""product_name"": ""Billing_Prorate"",
                ""revenue_end_date"": ""2023-12-31"",
                ""revenue_planned"": 51200,
                ""revenue_recognized"": 0,
                ""revenue_start_date"": ""2023-01-01"",
                ""revenue_trigger"": ""Billing"",
                ""revenue_unplanned"": 0,
                ""ssp_percent"": null,
                ""total_billed_amount"": 51200,
                ""total_list_price_functional"": 63500,
                ""total_list_price_transactional"": 63500,
                ""total_sell_price_functional"": 51200,
                ""total_sell_price_transactional"": 51200,
                ""transaction_currency"": ""USD""
            }
        },
        {
            ""Perf-ORD-01-03"": {
                ""carves_amount"": 0,
                ""carves_eligible"": false,
                ""created_period"": ""Jan-2023"",
                ""cumulative_carves_amount"": 0,
                ""distribution_method"": ""Prorate"",
                ""functional_currency"": ""USD"",
                ""order_date"": ""2023-01-01"",
                ""order_financial_id"": ""Perf-ORD-01-03"",
                ""order_number"": ""Perf-ORD-01"",
                ""product_name"": ""Event_Prorate"",
                ""revenue_end_date"": ""2023-12-31"",
                ""revenue_planned"": 31200,
                ""revenue_recognized"": 0,
                ""revenue_start_date"": ""2023-01-01"",
                ""revenue_trigger"": ""User Defined Events"",
                ""revenue_unplanned"": 0,
                ""ssp_percent"": null,
                ""total_billed_amount"": 31200,
                ""total_list_price_functional"": 48200,
                ""total_list_price_transactional"": 48200,
                ""total_sell_price_functional"": 31200,
                ""total_sell_price_transactional"": 31200,
                ""transaction_currency"": ""USD""
            }
        }
    ],
    ""total_records"": 3
}"

```

**Description of the fields**

<table><thead><tr><th width="220">Field Name</th><th width="384">Description</th><th width="191">Example</th></tr></thead><tbody><tr><td>carves_amount</td><td>Carve‑out adjustment amount.</td><td>0</td></tr><tr><td>carves_eligible</td><td>Whether this line eligible for carves allocation or not</td><td>FALSE</td></tr><tr><td>created_period</td><td>Accounting period of creation.</td><td>Jan‑2023</td></tr><tr><td>cumulative_carves_amount</td><td>Total cumulative carves amount</td><td>0</td></tr><tr><td>distribution_method</td><td>Revenue distribution method.</td><td>Prorate</td></tr><tr><td>functional_currency</td><td>Functional currency of the transaction line</td><td>USD</td></tr><tr><td>order_date</td><td>Date of the order</td><td>2023‑01‑01</td></tr><tr><td>order_financial_id</td><td>Unique order financial ID</td><td>Perf‑ORD‑01‑01</td></tr><tr><td>order_number</td><td>Order number</td><td>Perf‑ORD‑01</td></tr><tr><td>product_name</td><td>BName of the product</td><td>Booking_Prorate</td></tr><tr><td>revenue_end_date</td><td>End date of the contract period</td><td>2023‑12‑31</td></tr><tr><td>revenue_planned</td><td>Planned revenue amount.</td><td>39000</td></tr><tr><td>revenue_recognized</td><td>Revenue recognized so far.</td><td>0</td></tr><tr><td>revenue_start_date</td><td>Start date of the contract period</td><td>2023‑01‑01</td></tr><tr><td>revenue_trigger</td><td>Trigger for revenue recognition.</td><td>Booking</td></tr><tr><td>revenue_unplanned</td><td>Unplanned revenue recognized.</td><td>0</td></tr><tr><td>ssp_percent</td><td>SSP allocation percent.</td><td>null</td></tr><tr><td>total_billed_amount</td><td>Billed amount in transactional currency.</td><td>39000</td></tr><tr><td>total_list_price_functional</td><td>List price in functional currency.</td><td>50000</td></tr><tr><td>total_list_price_transactional</td><td>List price in transactional currency.</td><td>50000</td></tr><tr><td>total_sell_price_functional</td><td>Sell price in functional currency.</td><td>39000</td></tr><tr><td>total_sell_price_transactional</td><td>Sell price in transactional currency.</td><td>39000</td></tr><tr><td>transaction_currency</td><td>Transactional currency of the transaction line</td><td>USD</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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apis.rightrev.com/rightrev-rest-api/revenue-desk-360/revenue-contract-more-actions/re-group/retrieve-revenue-contract-lines-eligible-for-regroup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.