Retrieve Revenue Contract Billings Details

This API is to retrieve the billings data of order financial IDs from Revenue Contract .

Method - GET

API End Point

/apis/recorder/v1/revenue_contract/<RC ID><ofid=>&object=rc_billings&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_billings 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_billings&page_number=1&page_size=10

• Above sample endpoint will fetch Billings Data of Order Financial ID - OFID_SNOW-1522_AC_1 of RC-391 from the RightRev system.

Screenshot for reference

Response

"{
    ""rc_billings"": {
        ""billings_data"": [
            {
                ""BFID_SNOW-1522_AC_1"": {
                    ""adjust_revenue"": null,
                    ""bill_amount_corporate"": 520.57,
                    ""bill_amount_functional"": 520.57,
                    ""bill_smaps_unique_id"": ""9ef3573d-c303-4695-8c4c-7cff5c0f62db|0"",
                    ""created_period"": ""Jan-21"",
                    ""source_invoice_fields"": {
                        ""RR_Overage_Invoice_Line__c"": """",
                        ""bill_amount"": ""520.5723"",
                        ""bill_date"": ""01/01/2021"",
                        ""bill_financial_id"": ""BFID_SNOW-1522_AC_1"",
                        ""bill_number"": ""BN_SNOW-1522_AC_1"",
                        ""bill_qty"": ""1"",
                        ""functional_currency"": ""USD"",
                        ""functional_exchange_rate"": ""1"",
                        ""global_currency"": ""USD"",
                        ""global_exchange_rate"": ""1"",
                        ""reference_financial_id"": ""OFID_SNOW-1522_AC_1"",
                        ""revenue_end_date"": ""03/31/2021"",
                        ""revenue_start_date"": ""01/01/2021"",
                        ""source_system"": ""Oracle"",
                        ""transaction_currency"": ""USD"",
                        ""transaction_type"": ""INVOICE""
                    }
                }
            }
        ],
        ""order_financial_id"": ""OFID_SNOW-1522_AC_1""
    },
    ""total_records"": 1
}"

Description of the fields

Field Name	Description	Example
billings_data	List of billing records associated with the RC.
Bill Financial ID	Unique identifier for the invoice/billing line.	BFID_SNOW-1522_AC_1
adjust_revenue	Amount of revenue adjusted for this billing line.	null
bill_amount_corporate	Billed amount in corporate/reporting currency.	520.57
bill_amount_functional	Billed amount in functional currency.	520.57
bill_smaps_unique_id	Internal SMAPS reference ID for billing linkage.	9ef3573d-c303-4695-8c4c-7cff5c0f62db|0
created_period	Period in which this billing transaction was created.	46043
RR_Overage_Invoice_Line__c	Invoice overage flag/identifier.
bill_amount	Original bill amount from invoice.	520.5723
bill_date	Invoice bill date.	44197
bill_financial_id	Unique identifier for the invoice/billing line.	BFID_SNOW-1522_AC_1
bill_number	Invoice number from source system.	BN_SNOW-1522_AC_1
bill_qty	Quantity billed.	1
functional_currency	Functional currency used for reporting.	USD
functional_exchange_rate	FX rate to convert to functional currency.	1
global_currency	Global/consolidated reporting currency.	USD
global_exchange_rate	FX rate used for global currency.	1
reference_financial_id	Linked Order Financial ID.	OFID_SNOW-1522_AC_1
revenue_end_date	Revenue recognition end date for the invoice.	44286
revenue_start_date	Revenue recognition start date for invoice.	44197
source_system	Source ERP/CRM system name.	Oracle
transaction_currency	Currency in which invoice was originally billed.	USD
transaction_type	Type of transaction – Invoice.	INVOICE
order_financial_id	Order Financial ID to which these billings belong.	OFID_SNOW-1522_AC_1
total_records	Total number of billing entries returned.	1