Retrieve Revenue Contract Lines Eligible for Manual Defer

This API is to retrieve all the revenue contract order lines eligible for manual defer of revenue.

Method - GET

API End Point

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

Query Parameters

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

Sample API End Point

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

• Above sample endpoint will fetch 10 records of Order lines from Revenue Contract No 442 eligible for manual defer in RightRev system from page number 1.

Screenshot for reference

Response

{
    "rc_defer": [
        {
            "SO_OFID_00AB2": {
                "carves_amount": -1074.48,
                "carves_eligible": true,
                "created_period": "Jan-2021",
                "cumulative_carves_amount": -1074.48,
                "distribution_method": "Daily",
                "functional_currency": "USD",
                "order_date": "2021-01-01",
                "order_financial_id": "SO_OFID_00AB2",
                "order_number": "SO_ON_00AB1",
                "product_name": "Software",
                "revenue_end_date": "2021-12-31",
                "revenue_planned": 3780.31,
                "revenue_recognized": 3718.69,
                "revenue_start_date": "2021-01-01",
                "revenue_trigger": "Billing",
                "revenue_unplanned": 0,
                "ssp_percent": null,
                "total_billed_amount": 7499,
                "total_list_price_functional": 8410,
                "total_list_price_transactional": 8410,
                "total_sell_price_functional": 7499,
                "total_sell_price_transactional": 7499,
                "transaction_currency": "USD"
            }
        },
        {
            "SO_OFID_00AB3": {
                "carves_amount": 1074.48,
                "carves_eligible": true,
                "created_period": "Jan-2021",
                "cumulative_carves_amount": 1074.48,
                "distribution_method": "Daily",
                "functional_currency": "USD",
                "order_date": "2021-01-01",
                "order_financial_id": "SO_OFID_00AB3",
                "order_number": "SO_ON_00AB1",
                "product_name": "Support",
                "revenue_end_date": "2021-12-31",
                "revenue_planned": 302.2,
                "revenue_recognized": 297.2,
                "revenue_start_date": "2021-01-01",
                "revenue_trigger": "Billing",
                "revenue_unplanned": 399.6,
                "ssp_percent": null,
                "total_billed_amount": 999,
                "total_list_price_functional": 3000,
                "total_list_price_transactional": 3000,
                "total_sell_price_functional": 999,
                "total_sell_price_transactional": 999,
                "transaction_currency": "USD"
            }
        }
    ],
    "total_records": 2
}

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