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