Complete Schema
- Rates Request
- Rates Response
- Bill Request
- Bill Response
- BillSavings Request
-
- CustomerInfo{...}
- Meters[{...}]
-
- Name
- CurrentRate{...}
- ProposedRate{...}
- AnnualUtilityBillEscalation_Percent
- EnergyProfiles[{...}]
-
- {"Type": "Consumption", ...}
- {"Type": "Production"}
- {"Type": "Pv", ...}
-
- Name
- Scenario
- EquipmentLife_Years
- SystemDegradationPerYear_Percent
- ProductionEnergyProfileName
- PvSimulation{...}
- CashPayment{...}
- LoanPayment{...}
- LeasePayment{...}
- PpaPayment{...}
- MaintenanceCosts{...}
- BillPeriods[{...}]
- BillPeriodEnd
- EstimationOptions{...}
- BillSavings Response
Meters
An array defining the different meters and energy profiles that will be included in the analysis. Each meter can have multiple energy profiles.
"Meters": [
{
"Name": "House",
"CurrentRate": { "Id": "ABC123" },
"ProposedRate": { "Id": "XYZ456" },
"AnnualUtilityBillEscalation_Percent": 2.5,
"EnergyProfiles": [
{
"Type": "Consumption",
"Name": "Whole House",
"Scenario": "Both",
"IntervalData": {
"Interpolation": "Average",
"Interval": "HalfHour",
"IntervalConvention": "IntervalStart",
"Data": [
{
"Time": "2014-11-09T00:00:00",
"Energy_kWh": 0.19
},
{
"Time": "2014-11-09T00:30:00",
"Energy_kWh": 0.15
},
<em>Edited for length</em>
{
"Time": "2015-11-08T23:00:00",
"Energy_kWh": 0.24
},
{
"Time": "2015-11-08T23:30:00",
"Energy_kWh": 0.26
}
]
}
},
],
"BillPeriods": [
{
"Name": "1",
"StartDate": "2014-11-09T00:00:00"
},
{
"Name": "2",
"StartDate": "2014-12-12T00:00:00"
},
{
"Name": "3",
"StartDate": "2015-01-12T00:00:00"
},
{
"Name": "4",
"StartDate": "2015-02-09T00:00:00"
},
{
"Name": "5",
"StartDate": "2015-03-12T00:00:00"
},
{
"Name": "6",
"StartDate": "2015-04-11T00:00:00"
},
{
"Name": "7",
"StartDate": "2015-05-12T00:00:00"
},
{
"Name": "8",
"StartDate": "2015-06-11T00:00:00"
},
{
"Name": "9",
"StartDate": "2015-07-12T00:00:00"
},
{
"Name": "10",
"StartDate": "2015-08-12T00:00:00"
},
{
"Name": "11",
"StartDate": "2015-09-11T00:00:00"
},
{
"Name": "12",
"StartDate": "2015-10-12T00:00:00"
}
],
"BillPeriodEnd": "2015-11-09T00:00:00"
}
]
Name
A unique identifier for a meter. Use Name to easily identify bill calculation results for each meter in the response.
Possible Values: Any string such as “House” or “Solar”.
Required.
CurrentRate
Contains information specifying the rate for the current scenario in the bill savings calculation.
Required.
ProposedRate
Contains information specifying the rate for the proposed scenario in the bill savings calculation.
Default: If omitted, information contained in CurrentRate will be used.
AnnualUtilityBillEscalation_Percent
The year over year percent increase for electricity prices. Applies to the entire bill amount.
Possible Values: Any decimal value between 0 and 100.
Default: 2.5.
EnergyProfiles
An array of energy technologies or energy profiles. There are three types of energy profiles: “Consumption”, “Production”, and “Pv”.
Required.
BillPeriods
An array defining the start and stop times for each billing period.
Default: If omitted, billing periods are assumed to start and end with calendar months.
BillPeriodEnd
The end date for the final billing period. ISO 8601 format must be used.
Possible Values: Any string conforming to ISO 8601 format, such as “2015-11-09T00:00:00”.
Default: If omitted, BillPeriodEnd is assumed to be equal to the final time point in Data.