Retrieve Revenue Contract Metrics Details

This API is to retrieve all the revenue contract metrics data.

Method - GET

API End Point

apis/recorder/v1/revenue_contract/<RC id>?object=rc_metrics

Path Parameters

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

Sample API End Point

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

• Above sample endpoint will fetch Revenue Contract Metrics of RC-442 in RightRev system.

Screenshot for reference

Response

"{
    ""RC-423"": [
        {
            ""allocation_treatment"": ""Prospective"",
            ""billed_amount"": 0,
            ""ca_cl_balance"": 1227.08,
            ""ca_cl_position"": ""contract_asset"",
            ""carves_currency_code"": ""USD"",
            ""carves_currency_type"": ""transaction_currency"",
            ""carves_in"": 299.73,
            ""carves_out"": -299.73,
            ""contract_created_period"": ""Feb-21"",
            ""contract_modified_period"": ""Mar-21"",
            ""current_qtr_revenue"": 1880.15,
            ""customer_name"": ""KJ"",
            ""fx_adjustments"": 0,
            ""fx_adjustments_func_currency"": ""USD"",
            ""grouping_value"": {
                ""legal_entity"": ""LE_19"",
                ""order_number"": ""ON_SNOW-1554_AA_1"",
                ""tenant_id"": ""pi-snow-kri"",
                ""transaction_currency"": ""USD""
            },
            ""holds_status"": null,
            ""legal_entity"": ""LE_19"",
            ""manually_created_rc"": false,
            ""next_qtr_revenue"": 419.85,
            ""prior_qtr_revenue"": 0,
            ""revenue_contract_id"": ""RC-423"",
            ""revenue_contract_version"": 2,
            ""revenue_planned"": 1072.92,
            ""revenue_recognized"": 1227.08,
            ""revenue_unplanned"": 0,
            ""ssp_min_func_exchange_rate"": 1,
            ""ssp_min_rep_exchange_rate"": 1,
            ""status"": ""Recognize Revenue"",
            ""total_contract_value"": 2300
        }
    ],
    ""total_records"": 1
}"

Description of the fields

Field Name	Description	Example
allocation_treatment	Method used for revenue allocation for the RC.	Prospective
billed_amount	Total billed amount for the RC.	0
ca_cl_balance	Balance in contract asset or contract liability.	1227.08
ca_cl_position	Indicates if balance is a contract asset or liability.	contract_asset
carves_currency_code	Currency code used for carves calculations.	USD
carves_currency_type	Currency type for carve calculations (transaction/functional).	transaction_currency
carves_in	Revenue amount added due to carve‑in.	299.73
carves_out	Revenue deducted due to carve‑out.	-299.73
contract_created_period	Accounting period when the RC was created.	Feb‑21
contract_modified_period	Accounting period when the RC was last modified.	Mar‑21
current_qtr_revenue	Revenue recognized in the current quarter.	1880.15
customer_name	Name of the customer for this RC.	KJ
fx_adjustments	FX adjustment amount on revenue.	0
fx_adjustments_func_currency	Functional currency used for FX adjustments.	USD
grouping_value	RC grouping identifiers (composite values). Legal Entity Order Number Tenant Id Transaction Currency	{legal_entity: LE_19, …}
holds_status	Status of revenue holds.	null
legal_entity	Legal entity associated with the RC.	LE_19
manually_created_rc	Whether RC was created manually.	FALSE
next_qtr_revenue	Revenue expected in next quarter.	419.85
prior_qtr_revenue	Revenue recognized in previous quarter.	0
revenue_contract_id	Unique identifier of the RC.	RC‑423
revenue_contract_version	Version number of the RC.	2
revenue_planned	Planned revenue for the RC.	1072.92
revenue_recognized	Total revenue recognized till now.	1227.08
revenue_unplanned	Unplanned revenue amount.	0
ssp_min_func_exchange_rate	Minimum functional FX rate used for SSP.	1
ssp_min_rep_exchange_rate	Minimum reporting FX rate used for SSP.	1
status	Current processing status of RC.	Recognize Revenue
total_contract_value	Total value of the contract.	2300
total_records	Total number of RC entries returned.	1