> 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-revenue-schedules-details.md).

# Retrieve Revenue Contract Revenue Schedules Details

This API is to retrieve the revenue schedules data of order financial IDs from Revenue Contract.

Method - GET

API End Point

```
/apis/recorder/v1/revenue_contract/<RC ID><ofid=>&object=rc_dists&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<br>4. ofid</td><td>1. 1<br>2. 10<br>3. rc_dist<br>4. Order Financial ID For e.g. OFID-001</td></tr></tbody></table>

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

```
/apis/recorder/v1/revenue_contract/RC-391?ofid=OFID_SNOW-1522_AC_1&object=rc_dist&page_number=1&page_size=10
```

* Above sample endpoint will fetch **Revenue Schedules Data of Order Financial ID -** OFID\_SNOW-1522\_AC\_1  **of RC-391** in RightRev system.

**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%2FDfeZ8Fc7566QmWVNKrl0%2Fimage.png?alt=media&amp;token=b115218a-5ac0-461a-ad29-112ef496be88" alt=""><figcaption></figcaption></figure></div>

Response

```
"{
    ""order_financial_id"": ""OFID_SNOW-1522_AC_1"",
    ""rc_dist"": [
        {
            ""act_data"": {
                ""c57e971b-e8ee-4835-99f1-091c9dd9a8d2"": {
                    ""action"": ""Initial Entry"",
                    ""allocation_method"": null,
                    ""amount_functional"": 520.57,
                    ""amount_reporting"": 520.57,
                    ""amount_transactional"": 520.57,
                    ""carves_liability_segment"": ""1111"",
                    ""carves_revenue_segment"": ""2222"",
                    ""comments"": ""INVOICE INGESTION"",
                    ""contractual_liability_segment"": ""1111"",
                    ""contractual_revenue_segment"": ""2222"",
                    ""corporate_currency"": ""USD"",
                    ""corporate_exchange_rate"": 1,
                    ""file_id"": ""9ef3573d-c303-4695-8c4c-7cff5c0f62db"",
                    ""formula_value"": null,
                    ""functional_currency"": ""USD"",
                    ""functional_exchange_rate"": 1,
                    ""percentage"": 0.999995581785662,
                    ""quantity"": null,
                    ""revenue_contract_version"": 1,
                    ""revenue_end_date"": ""2021-03-31"",
                    ""revenue_start_date"": ""2021-01-01"",
                    ""reversal"": false,
                    ""schedule_type"": ""Revenue"",
                    ""transaction_currency"": ""USD"",
                    ""trigger_type"": ""Booking"",
                    ""triggered_period"": ""Jan-21""
                }
            },
            ""dist_data"": [
                {
                    ""c3c3f0f8-e312-4d35-840c-63b84ec60f42"": {
                        ""account_type"": ""Contractual Liability - Billings"",
                        ""drcr_indicator"": ""CREDIT"",
                        ""functional_amount"": 520.57,
                        ""journal_run_id"": null,
                        ""period"": ""Jan-21"",
                        ""period_number"": 1,
                        ""recognized_period"": null,
                        ""transactional_amount"": 520.57
                    }
                }
            ]
        },
        {
            ""act_data"": {
                ""06d65975-b160-4ef0-896c-b725a8375c7a"": {
                    ""action"": ""Release"",
                    ""allocation_method"": null,
                    ""amount_functional"": 520.57,
                    ""amount_reporting"": 520.57,
                    ""amount_transactional"": 520.57,
                    ""carves_liability_segment"": ""1111"",
                    ""carves_revenue_segment"": ""2222"",
                    ""comments"": ""BOOKING RELEASE"",
                    ""contractual_liability_segment"": ""1111"",
                    ""contractual_revenue_segment"": ""2222"",
                    ""corporate_currency"": ""USD"",
                    ""corporate_exchange_rate"": 1,
                    ""file_id"": ""7ae34fd1-13ba-4091-906c-eb5208f70e83"",
                    ""formula_value"": null,
                    ""functional_currency"": ""USD"",
                    ""functional_exchange_rate"": 1,
                    ""percentage"": 100,
                    ""quantity"": null,
                    ""revenue_contract_version"": 1,
                    ""revenue_end_date"": ""2021-03-31"",
                    ""revenue_start_date"": ""2021-01-01"",
                    ""reversal"": false,
                    ""schedule_type"": ""Revenue"",
                    ""transaction_currency"": ""USD"",
                    ""trigger_type"": ""Booking"",
                    ""triggered_period"": ""Jan-21""
                }
            },
            ""dist_data"": [
                {
                    ""4d72107e-355f-48ef-b7ba-77cad6f04323"": {
                        ""account_type"": ""Contractual Revenue"",
                        ""drcr_indicator"": ""CREDIT"",
                        ""functional_amount"": 520.57,
                        ""journal_run_id"": 114,
                        ""period"": ""Jan-21"",
                        ""period_number"": 1,
                        ""recognized_period"": ""Jan-21"",
                        ""transactional_amount"": 520.57
                    }
                }
            ]
        }
    ],
    ""total_records"": 2
}"
```

**Description of the fields**

<table><thead><tr><th width="273">Field Name</th><th width="509">Description</th><th width="235">Example</th></tr></thead><tbody><tr><td>order_financial_id</td><td>Order Financial ID to which the RC distribution entries belong.</td><td>OFID_SNOW‑1522_AC_1</td></tr><tr><td>act_data</td><td>Activity-level details for revenue distribution action.</td><td></td></tr><tr><td>action</td><td>Type of revenue activity (e.g., Initial Entry, Release).</td><td>Initial Entry</td></tr><tr><td>allocation_method</td><td>Allocation method applied to this activity.</td><td>null</td></tr><tr><td>amount_functional</td><td>Amount in functional currency.</td><td>520.57</td></tr><tr><td>amount_reporting</td><td>Amount in reporting/corporate currency.</td><td>46176</td></tr><tr><td>amount_transactional</td><td>Amount in transactional currency.</td><td>520.57</td></tr><tr><td>carves_liability_segment</td><td>GL segment for carves liability postings.</td><td>1111</td></tr><tr><td>carves_revenue_segment</td><td>GL segment for carves revenue postings.</td><td>2222</td></tr><tr><td>comments</td><td>User-entered comments explaining the activity.</td><td>INVOICE INGESTION</td></tr><tr><td>contractual_liability_segment</td><td>GL segment for contractual liability.</td><td>1111</td></tr><tr><td>contractual_revenue_segment</td><td>GL segment for contractual revenue.</td><td>2222</td></tr><tr><td>corporate_currency</td><td>Corporate/reporting currency code.</td><td>USD</td></tr><tr><td>corporate_exchange_rate</td><td>Exchange rate used to convert to corporate currency.</td><td>1</td></tr><tr><td>file_id</td><td>Source file identifier that created this event.</td><td>9ef3573d-c303-4695-8c4c-7cff5c0f62db</td></tr><tr><td>formula_value</td><td>Value derived from SSP/Carve formula (if applicable).</td><td>null</td></tr><tr><td>functional_currency</td><td>Functional reporting currency.</td><td>USD</td></tr><tr><td>functional_exchange_rate</td><td>FX rate to convert to functional currency.</td><td>1</td></tr><tr><td>percentage</td><td>Event or distribution percentage applied.</td><td>2</td></tr><tr><td>quantity</td><td>Quantity used in distribution activity.</td><td>null</td></tr><tr><td>revenue_contract_version</td><td>Version of the RC when this activity occurred.</td><td>1</td></tr><tr><td>revenue_start_date</td><td>Revenue recognition start date.</td><td>2021‑01‑01</td></tr><tr><td>revenue_end_date</td><td>Revenue recognition end date.</td><td>2021‑03‑31</td></tr><tr><td>reversal</td><td>Indicates if this entry is a reversal.</td><td>FALSE</td></tr><tr><td>schedule_type</td><td>Type of schedule impacted (Revenue / Cost).</td><td>Revenue</td></tr><tr><td>transaction_currency</td><td>Transaction currency of the original document.</td><td>USD</td></tr><tr><td>trigger_type</td><td>Triggering event (e.g., Booking, Billing).</td><td>Booking</td></tr><tr><td>triggered_period</td><td>Accounting period when event was triggered.</td><td>Jan‑21</td></tr><tr><td>dist_data</td><td>Journal distribution entries derived from activity.</td><td></td></tr><tr><td>account_type</td><td>Account type affected (e.g., Contractual Liability).</td><td>Contractual Liability - Billings</td></tr><tr><td>drcr_indicator</td><td>Indicates debit or credit entry.</td><td>CREDIT</td></tr><tr><td>functional_amount</td><td>Journal amount in functional currency.</td><td>520.57</td></tr><tr><td>journal_run_id</td><td>ID of journal run that posted this entry.</td><td>114</td></tr><tr><td>period</td><td>Accounting period for the journal line.</td><td>Jan‑21</td></tr><tr><td>period_number</td><td>Numerical period index.</td><td>1</td></tr><tr><td>recognized_period</td><td>Period in which revenue was recognized.</td><td>Jan‑21</td></tr><tr><td>transactional_amount</td><td>Journal amount in transactional currency.</td><td>520.57</td></tr><tr><td>total_records</td><td>Total number of RC distribution records returned.</td><td>2</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-details/retrieve-revenue-contract-revenue-schedules-details.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.
