Retrieve Revenue Contract Cost 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_dist_cost&page_number=1&page_size=10

Path Parameters

Key	Values
1. page 2. page_size 3. object 4. ofid	1. 1 2. 10 3. rc_dist_cost 4. Order Financial ID For e.g. OFID-001

Sample API End Point

/apis/recorder/v1/revenue_contract/RC-156?ofid=SO_OFID_00All_Cost_AB_1&object=rc_dist_cost&page_number=1&page_size=10

• Above sample endpoint will fetch Cost Schedules Data of Order Financial ID - SO_OFID_00All_Cost_AB_1 of RC-156 from RightRev system.

Screenshot for reference

Response

{
    "order_financial_id": "SO_OFID_00All_Cost_AB_1",
    "rc_dist": [
        {
            "act_data": {
                "61dc95ee-4421-41ed-8cb9-3bccd4c4f642": {
                    "action": "RELEASE",
                    "allocation_method": null,
                    "amount_functional": 15000,
                    "amount_reporting": 15000,
                    "amount_transactional": 15000,
                    "carves_liability_segment": "1111",
                    "carves_revenue_segment": "2222",
                    "comments": "BOOKING RELEASE",
                    "contractual_liability_segment": "1111",
                    "contractual_revenue_segment": "2222",
                    "corporate_currency": "USD",
                    "corporate_exchange_rate": 1,
                    "deferred_cost_account": null,
                    "file_id": "ed521af9-77cb-4157-9e29-ec9708547241",
                    "formula_value": null,
                    "functional_currency": "USD",
                    "functional_exchange_rate": 1,
                    "percentage": 100,
                    "recognized_cost_account": null,
                    "revenue_contract_version": 1,
                    "revenue_end_date": "2021-06-30",
                    "revenue_start_date": "2021-01-01",
                    "reversal": false,
                    "schedule_type": "Revenue",
                    "transaction_currency": "USD",
                    "trigger_type": "Booking",
                    "triggered_period": "Jan-2021"
                }
            },
            "dist_data": [
                {
                    "069f16ef-4826-4b5c-ba00-1f26a31fa1af": {
                        "account_type": "Contractual Revenue",
                        "drcr_indicator": "CREDIT",
                        "functional_amount": 15000,
                        "journal_run_id": 72,
                        "period": "Jan-2021",
                        "period_number": 1,
                        "recognized_period": "Jan-2021",
                        "transactional_amount": 15000
                    }
                }
            ]
        }
    ],
    "total_records": 1
}

Description of the fields

Field Name	Description	Example
order_financial_id	Order Financial ID associated with this RC distribution.	SO_OFID_00All_Cost_AB_1
rc_dist	List of revenue/cost distribution entries for the order.
act_data	Activity-level details for the distribution event.
action	Type of distribution action (e.g., RELEASE, INITIAL ENTRY).	RELEASE
allocation_method	Allocation method used for this distribution.	null
amount_functional	Amount in functional/reporting currency.	15000
amount_reporting	Amount in reporting/corporate currency.	46046
amount_transactional	Amount in transactional currency.	15000
carves_liability_segment	GL segment for carves liability.	1111
carves_revenue_segment	GL segment for carves revenue.	2222
comments	User comments describing the activity.	BOOKING RELEASE
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
deferred_cost_account	GL account for deferred cost posting.	null
file_id	Source file ID from which the activity originated.	ed521af9‑77cb‑4157‑9e29‑ec9708547241
formula_value	Value derived from SSP/Carve formula.	null
functional_currency	Functional reporting currency.	USD
functional_exchange_rate	FX rate to convert to functional currency.	2
percentage	Percentage used for revenue/cost release.	100
recognized_cost_account	GL account for recognized cost posting.	null
revenue_contract_version	Version of revenue contract during this entry.	1
revenue_end_date	End date of revenue recognition.	2021‑06‑30
revenue_start_date	Start date of revenue recognition.	2021‑01‑01
reversal	Flag indicating if the entry is a reversal.	FALSE
schedule_type	Type of schedule impacted (Revenue / Cost).	Revenue
transaction_currency	Original transaction currency.	USD
trigger_type	Event that triggered distribution (Booking / Billing).	Booking
triggered_period	Accounting period when activity was triggered.	Jan‑2021
dist_data	Journal distribution lines generated from the activity.
account_type	Type of account impacted by the journal entry.	Contractual Revenue
drcr_indicator	Debit or credit indicator.	CREDIT
functional_amount	Journal amount in functional currency.	15000
journal_run_id	Identifier of journal run posting the entry.	72
period	Accounting period of the journal entry.	Jan‑2021
period_number	Numeric index of the accounting period.	1
recognized_period	Period in which revenue/cost was recognized.	Jan‑2021
transactional_amount	Journal amount in transactional currency.	15000
total_records	Total RC distribution entries returned.	1