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

Key	Values
1. page 2. page_size 3. object	1. 1 2. 10 3. rc_regroup

Sample API End Point

/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

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

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