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