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

# Retrieve Revenue Contract Lines

Method - GET

API End Point

```
/apis/recorder/v1/revenue_contract/<RC_ID>?object=rc_lines&page_number=1&page_size=10
```

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

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

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

* Above sample endpoint will fetch 10 records of **Order lines from Revenue Contract No 442** in RightRev system from page number 1.

Screenshot for reference

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

Response

```
"    ""rc_lines"": [
        {
            ""SO_OFID_00AB2"": {
                ""allocated_amount"": 6424.52,
                ""allocation_method"": ""Retrospective"",
                ""allocation_method_from_policy"": ""Prospective"",
                ""balance_for_allocation"": 7499,
                ""billing_average_corp_exchange_rate"": null,
                ""billing_average_exchange_rate"": null,
                ""cancel_full_obligation"": false,
                ""carves_amount"": -1074.48,
                ""carves_eligible"": true,
                ""carves_liability_segment"": ""1100"",
                ""carves_revenue_segment"": ""2200"",
                ""comments"": null,
                ""contract_asset_segment"": null,
                ""contract_liability_segment"": ""1111"",
                ""contract_revenue_segment"": ""2222"",
                ""cost_amount"": null,
                ""cost_planned_transactional"": null,
                ""cost_recognized_transactional"": null,
                ""cost_unplanned_transactional"": null,
                ""created_by"": ""krishnadas.j@rightrev.com"",
                ""created_on"": ""2025-01-03 08:33:09.577"",
                ""created_period"": ""Jan-2021"",
                ""cumulative_carves_amount"": -1074.48,
                ""cumulative_net_revenue"": 6424.52,
                ""deferred_balance"": 3238.66,
                ""deferred_cost_account"": null,
                ""derived_above_midpoint_price"": 7064.4,
                ""derived_below_midpoint_price"": 6391.6,
                ""derived_midpoint_price"": 6728,
                ""distribution_method"": ""Daily"",
                ""file_id"": ""d29eb599-d1f7-4b5e-b1f9-6b4fe182fcbf"",
                ""formula_expression"": ""total_list_price_transactional * 0.80"",
                ""fx_adjustments"": 0,
                ""order_line_cancelled"": false,
                ""posted_revenue_percent"": 50,
                ""prior_period_revenue_method"": ""Catch-up in current period"",
                ""prior_recognized_period"": null,
                ""prior_unrecognized_period"": null,
                ""prorate_method"": null,
                ""recognized_cost_account"": null,
                ""regrouped_contract_version"": null,
                ""regrouped_date"": null,
                ""regrouped_period"": null,
                ""relative_percent"": 0.756003595736484,
                ""remaining_contractual_revenue_percent"": null,
                ""revenue_event_name"": null,
                ""revenue_planned"": 3238.66,
                ""revenue_recognized"": 3185.86,
                ""revenue_rule_name"": ""Software"",
                ""revenue_trigger"": ""Billing"",
                ""revenue_unplanned"": 0,
                ""revenue_unposted"": 3780.31,
                ""source_order_fields"": {
                    ""amendment_reason"": ""New"",
                    ""billing_revenue_accrual"": false,
                    ""carves_eligible"": true,
                    ""carves_liability_segment"": ""1100"",
                    ""carves_revenue_segment"": ""2200"",
                    ""contract_liability_segment"": ""1111"",
                    ""contract_revenue_segment"": ""2222"",
                    ""customer_code"": ""A1"",
                    ""customer_id"": """",
                    ""customer_name"": ""KJ"",
                    ""discount_amount"": """",
                    ""discount_percent"": """",
                    ""functional_currency"": ""USD"",
                    ""functional_exchange_rate"": ""1"",
                    ""global_currency"": ""USD"",
                    ""global_exchange_rate"": ""1"",
                    ""legal_entity"": ""LE_01"",
                    ""order_date"": ""01/01/2021"",
                    ""order_financial_id"": ""SO_OFID_00AB2"",
                    ""order_number"": ""SO_ON_00AB1"",
                    ""order_quantity"": ""1"",
                    ""parent_order_reference"": """",
                    ""po_number"": ""SSP-Formula"",
                    ""product_id"": """",
                    ""product_name"": ""Software"",
                    ""revenue_end_date"": ""12/31/2021"",
                    ""revenue_start_date"": ""01/01/2021"",
                    ""source_system"": ""Oracle"",
                    ""ssp_date"": """",
                    ""total_list_price"": ""8410"",
                    ""total_sell_price"": ""7499"",
                    ""transaction_currency"": ""USD"",
                    ""transaction_type"": ""Order"",
                    ""unit_list_price"": """",
                    ""unit_sell_price"": """",
                    ""usage_bookings"": false
                },
                ""source_revenue_contract"": null,
                ""ssp_balance"": 7064.4,
                ""ssp_carves_revenue_recognized_till_prior_period"": null,
                ""ssp_contractual_revenue_recognized_till_prior_period"": null,
                ""ssp_percent"": null,
                ""ssp_perday_above_midpoint"": null,
                ""ssp_perday_below_midpoint"": null,
                ""ssp_perday_midpoint"": null,
                ""ssp_policy_name"": ""SSP Formula"",
                ""ssp_remaining_carves_revenue"": null,
                ""ssp_remaining_contractual_revenue"": null,
                ""ssp_remaining_contractual_revenue_percent"": null,
                ""ssp_type"": ""ssp"",
                ""ssp_within_range"": false,
                ""total_billed_amount"": 7499,
                ""total_billed_amount_functional"": 7499,
                ""total_list_price_functional"": 8410,
                ""total_list_price_transactional"": 8410,
                ""total_release_percent"": 100,
                ""total_sell_price_functional"": 7499,
                ""total_sell_price_transactional"": 7499,
                ""total_ssp_price"": 7064.4,
                ""transaction_price"": null,
                ""trigger_no_allocation"": false,
                ""updated_by"": ""krishnadas.j@rightrev.com"",
                ""updated_on"": ""2025-01-03 08:33:09.577"",
                ""usage_bookings_amount"": null
            }
        }"
```

**Description of the fields**

<table><thead><tr><th width="313">Field Name</th><th width="533">Description</th><th width="213">Example</th></tr></thead><tbody><tr><td>allocated_amount</td><td>Revenue amount allocated to this line.</td><td>1200</td></tr><tr><td>allocation_method</td><td>Which Allocation method applied. Prospective or Retrospective</td><td>Retrospective</td></tr><tr><td>allocation_method_from_policy</td><td>Allocation method defined by SSP policy.</td><td>Prospective</td></tr><tr><td>balance_for_allocation</td><td>Remaining amount available for allocation.</td><td>499</td></tr><tr><td>billing_average_corp_exchange_rate</td><td>Corporate average FX rate on billing.</td><td>1</td></tr><tr><td>billing_average_exchange_rate</td><td>Average FX rate applied on billing.</td><td>0.85</td></tr><tr><td>cancel_full_obligation</td><td>Indicates if whole obligation is cancelled.</td><td>FALSE</td></tr><tr><td>carves_amount</td><td>Carve‑In/ (out) adjustment amount.</td><td>155.5</td></tr><tr><td>carves_eligible</td><td>Whether this line eligible for carves allocation or not</td><td>TRUE</td></tr><tr><td>carves_liability_segment</td><td>GL segment for carves liability.</td><td>4355-250-1122</td></tr><tr><td>carves_revenue_segment</td><td>GL segment for carves revenue.</td><td>4355-250-1133</td></tr><tr><td>comments</td><td>User comments on RC Line.</td><td>comment - test</td></tr><tr><td>contract_asset_segment</td><td>GL segment for contract asset.</td><td>4555-250-9988</td></tr><tr><td>contract_liability_segment</td><td>GL segment for contract liability.</td><td>4055-250-6677</td></tr><tr><td>contract_revenue_segment</td><td>GL segment for contract revenue.</td><td>4055-250-7700</td></tr><tr><td>cost_amount</td><td>Total cost associated with line.</td><td>250</td></tr><tr><td>cost_planned_transactional</td><td>Planned cost in transactional currency.</td><td>250</td></tr><tr><td>cost_recognized_transactional</td><td>Cost recognized to date.</td><td>50</td></tr><tr><td>cost_unplanned_transactional</td><td>Unplanned cost to date.</td><td>200</td></tr><tr><td>created_by</td><td>User ID who created RC line.</td><td>username@rightrev.com</td></tr><tr><td>created_on</td><td>Timestamp of the policy created by the user. This is a unix Epoch timestamp format.</td><td>2025‑01‑03 08:33:09.577</td></tr><tr><td>created_period</td><td>Accounting period of creation.</td><td>Jan‑2021</td></tr><tr><td>cumulative_carves_amount</td><td>Total cumulative carves amount</td><td>155.5</td></tr><tr><td>cumulative_net_revenue</td><td>Total net revenue recognized.</td><td>1355.5</td></tr><tr><td>deferred_balance</td><td>Deferred revenue balance.</td><td>837</td></tr><tr><td>deferred_cost_account</td><td>GL account for deferred cost.</td><td>3055-250-1199</td></tr><tr><td>derived_above_midpoint_price</td><td>SSP price above midpoint.</td><td>1500</td></tr><tr><td>derived_below_midpoint_price</td><td>SSP price below midpoint.</td><td>1000</td></tr><tr><td>derived_midpoint_price</td><td>Midpoint SSP price.</td><td>1200</td></tr><tr><td>distribution_method</td><td>Revenue distribution method.</td><td>Daily</td></tr><tr><td>file_id</td><td>ID of import file.</td><td>d29eb599-d1f7-4b5e-b1f9-6b4fe182fcbf</td></tr><tr><td>formula_expression</td><td>Formula used for SSP or allocation.</td><td>total_list_price_transactional * 0.80</td></tr><tr><td>fx_adjustments</td><td>FX adjustment amount.</td><td>0</td></tr><tr><td>order_line_cancelled</td><td>Indicates if order line was cancelled.</td><td>FALSE</td></tr><tr><td>posted_revenue_percent</td><td>% of revenue posted.</td><td>33.34</td></tr><tr><td>prior_period_revenue_method</td><td>Method for prior period adjustments.</td><td>Catch‑up in current period</td></tr><tr><td>prior_recognized_period</td><td>Last recognized period.</td><td>null</td></tr><tr><td>prior_unrecognized_period</td><td>Last unrecognized period.</td><td>null</td></tr><tr><td>prorate_method</td><td>Method of proration used.</td><td>consider partial months as full months</td></tr><tr><td>recognized_cost_account</td><td>GL account for recognized cost.</td><td>3055-250-7733</td></tr><tr><td>regrouped_contract_version</td><td>Version after regrouping.</td><td>2</td></tr><tr><td>regrouped_date</td><td>Date when regrouping happened.</td><td>2025-15-02</td></tr><tr><td>regrouped_period</td><td>Period of regrouping.</td><td>Feb-25</td></tr><tr><td>relative_percent</td><td>Percent relative to total SSP.</td><td>0.756003596</td></tr><tr><td>remaining_contractual_revenue_percent</td><td>Remaining revenue %.</td><td>0.9166666</td></tr><tr><td>revenue_event_name</td><td>Revenue event applied.</td><td>null</td></tr><tr><td>revenue_planned</td><td>Planned revenue amount.</td><td>1355.5</td></tr><tr><td>revenue_recognized</td><td>Revenue recognized so far.</td><td>418.5</td></tr><tr><td>revenue_rule_name</td><td>Revenue rule applied.</td><td>Software</td></tr><tr><td>revenue_trigger</td><td>Trigger for revenue recognition.</td><td>Billing</td></tr><tr><td>revenue_unplanned</td><td>Unplanned revenue recognized.</td><td>0</td></tr><tr><td>revenue_unposted</td><td>Calculated but unposted revenue.</td><td>837</td></tr><tr><td>source_order_fields</td><td>Order details used to create RC line.</td><td>(JSON object)</td></tr><tr><td>source_revenue_contract</td><td>Source RC used in regrouping.</td><td>null</td></tr><tr><td>ssp_balance</td><td>SSP allocated to the line.</td><td>1000</td></tr><tr><td>ssp_carves_revenue_recognized_till_prior_period</td><td>Carve SSP recognized till prior.</td><td>null</td></tr><tr><td>ssp_contractual_revenue_recognized_till_prior_period</td><td>Contractual SSP recognized till prior.</td><td>null</td></tr><tr><td>ssp_percent</td><td>SSP allocation percent.</td><td>null</td></tr><tr><td>ssp_perday_above_midpoint</td><td>Per day SSP above midpoint.</td><td>null</td></tr><tr><td>ssp_perday_below_midpoint</td><td>Per day SSP below midpoint.</td><td>null</td></tr><tr><td>ssp_perday_midpoint</td><td>Per day midpoint SSP.</td><td>null</td></tr><tr><td>ssp_policy_name</td><td>SSP policy applied.</td><td>SSP Formula</td></tr><tr><td>ssp_remaining_carves_revenue</td><td>Remaining carve SSP.</td><td>null</td></tr><tr><td>ssp_remaining_contractual_revenue</td><td>Remaining contractual SSP.</td><td>null</td></tr><tr><td>ssp_remaining_contractual_revenue_percent</td><td>Remaining SSP %.</td><td>null</td></tr><tr><td>ssp_type</td><td>SSP classification type.</td><td>ssp</td></tr><tr><td>ssp_within_range</td><td>Whether SSP is within policy range.</td><td>FALSE</td></tr><tr><td>total_billed_amount</td><td>Billed amount in transactional currency.</td><td>418.5</td></tr><tr><td>total_billed_amount_functional</td><td>Billed amount in functional currency.</td><td>418.5</td></tr><tr><td>total_list_price_functional</td><td>List price in functional currency.</td><td>1200</td></tr><tr><td>total_list_price_transactional</td><td>List price in transactional currency.</td><td>1200</td></tr><tr><td>total_release_percent</td><td>Total release % from events.</td><td>33.34</td></tr><tr><td>total_sell_price_functional</td><td>Sell price in functional currency.</td><td>1200</td></tr><tr><td>total_sell_price_transactional</td><td>Sell price in transactional currency.</td><td>1200</td></tr><tr><td>total_ssp_price</td><td>Total SSP price.</td><td>1000</td></tr><tr><td>transaction_price</td><td>Final transaction price.</td><td>null</td></tr><tr><td>trigger_no_allocation</td><td>Whether allocation is bypassed.</td><td>FALSE</td></tr><tr><td>updated_by</td><td>User who last updated line.</td><td>username@rightrev.com</td></tr><tr><td>updated_on</td><td>Timestamp of the policy updated by the user. This is a unix Epoch timestamp format.</td><td>2025‑01‑03 08:33:09.577</td></tr><tr><td>usage_bookings_amount</td><td>Usage‑based booking amount.</td><td>null</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-lines.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.