## The Revenue API

The Revenue API provides a set of endpoints for partners to access revenue data that has been earned by participating in grid services programs with Leap. Accessing preliminary and final revenue data in a timely manner helps increase efficiency as well as more quickly identify opportunities to improve revenue.

### Supported Regions & Programs  
Check out the [Revenue Tab Guide](https://support.leap.energy/support/solutions/articles/73000640396-revenue-tab-guide) (portal credentials required) for the list of supported regions and programs.

### Retrieve monthly customer revenue data  
The monthly revenue data endpoints provide granular revenue data and can be used for the following:

- Understand how revenue is generated within your portfolio by aggregating data per [meter](https://developer.leap.energy/reference/postmetersearchperiodicaggregationsearch), [customer](https://developer.leap.energy/reference/postcustomersearchperiodicaggregationsearch), [load type](https://developer.leap.energy/reference/postloadtypesearchperiodicaggregationsearch), [market group](https://developer.leap.energy/reference/postmarketgroupsearchperiodicaggregationsearch), or [utility](https://developer.leap.energy/reference/postutilitysearchperiodicaggregationsearch)
- Automate customer reporting and payments (if applicable for your grid services offering) by leveraging the [revenue by meter](https://developer.leap.energy/reference/postmetersearchperiodicaggregationsearch) or [revenue by customer](https://developer.leap.energy/reference/postcustomersearchperiodicaggregationsearch) endpoints to get preliminary estimates and final revenue data

- Revenue data is considered final when the applicable [monthly revenue report(s)](https://developer.leap.energy/reference/getperiodicreports) have a `status` value of "FINALIZED".

### Track missed revenue & flag worst performing meters  
The worst performing meters in your portfolio can significantly impact overall revenue. Prioritize investigation and corrective action on these meters by leveraging the [revenue by meter](https://developer.leap.energy/reference/postmetersearchperiodicaggregationsearch) endpoint and automating the following steps:

1. Query for each applicable month and program
2. For each `meter_id`, confirm `data_coverage_percentage`:
   - If greater than 75%, proceed with calculation below
   - If less than 75%, skip analysis for this meter until data coverage reaches threshold
3. For each `meter_id`, determine missed revenue:
   - Total Missed Revenue = `missed_revenue`
   - % Missed Revenue = `missed_revenue` / `potential_revenue`
4. Flag worst performing meters (based on numbers above) for follow-up to confirm event response and no hardware or software issues
   - If meters correctly responded to all events, reach out to your Leap partner success manager for further analysis and nominations discussion.

### Automate revenue reporting  
To eliminate operations overhead and the risk of human errors, monthly and seasonal revenue reporting can be automated to accomplish the following:

- Retrieve final revenue report data and format for finance team analysis
- Sync revenue data with financial systems for automated reporting, analysis, and tracking trends
- Track revenue report version changes

These use cases are supported by the following endpoints:
- [Monthly revenue reports](https://developer.leap.energy/reference/getperiodicreports) - Preliminary and final revenue reports
- [Revenue report versions](https://developer.leap.energy/reference/getperiodicreportversions) - Version history if changes are needed after a report reaches FINALIZED `status`
- [Annual revenue data](https://developer.leap.energy/reference/getyearlyoverview) - Annual summary of revenue data

Updated 11 months ago