Rates Request
Rates Response
Bill Request
Bill Response
BillSavings Request
BillSavings Response
Location{...}
City
State
Bills[{...}]
MeterName
CurrentBill{...}
HoursInBill
Rate{...}
Id
Description
UtilityId
UtilityDescription
BillTotals{...}
MinimumBill
DemandCharge
EnergyCharge
FixedCharge
NetSurplusCompensation
TotalCharge
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
PeriodBills[{...}]
PeriodStart
PeriodEnd
PeriodName
BillTotals{...}
MinimumBill
DemandCharge
EnergyCharge
FixedCharge
NetSurplusCompensation
TotalCharge
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
ProductionCreditAccounting{...}
CreditUnit
CarryoverFromPreviousPeriod
AddedThisPeriod
AvailableThisPeriod
UsedThisPeriod
CarryoverToNextPeriod
AnnualTrueUp
Seasons[{...}]
Name
HoursInSeason
MinimumBill
FixedCharge
TouPeriods[{...}]
Name
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
MaxDemand_kW
EnergyCharges[{...}]
Tier
Energy_kWh
Charge
UnitPrice
Type
EnergyCredits[{...}]
Tier
Energy_kWh
Credit
UnitPrice
Type
DemandCharges[{...}]
Tier
Demand_kW
Charge
UnitPrice
Type
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
MaxDemand_kW
EnergyCharges[{...}]
Tier
Energy_kWh
Charge
UnitPrice
Type
EnergyCredits[{...}]
Tier
Energy_kWh
Credit
UnitPrice
Type
DemandCharges[{...}]
Tier
Demand_kW
Charge
UnitPrice
Type
ProposedBill{...}
HoursInBill
Rate{...}
Id
Description
UtilityId
UtilityDescription
BillTotals{...}
MinimumBill
DemandCharge
EnergyCharge
FixedCharge
NetSurplusCompensation
TotalCharge
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
PeriodBills[{...}]
PeriodStart
PeriodEnd
PeriodName
BillTotals{...}
MinimumBill
DemandCharge
EnergyCharge
FixedCharge
NetSurplusCompensation
TotalCharge
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
ProductionCreditAccounting{...}
CreditUnit
CarryoverFromPreviousPeriod
AddedThisPeriod
AvailableThisPeriod
UsedThisPeriod
CarryoverToNextPeriod
AnnualTrueUp
Seasons[{...}]
Name
HoursInSeason
MinimumBill
FixedCharge
TouPeriods[{...}]
Name
EnergyTotals
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
MaxDemand_kW
EnergyCharges
Tier
Energy_kWh
Charge
UnitPrice
Type
EnergyCredits
Tier
Energy_kWh
Credit
UnitPrice
Type
DemandCharges
Tier
Demand_kW
Charge
UnitPrice
Type
EnergyTotals{...}
Consumed_kWh
Produced_kWh
Purchased_kWh
Inflow_kWh
Outflow_kWh
MaxDemand_kW
EnergyCharges[{...}]
Tier
Energy_kWh
Charge
UnitPrice
Type
EnergyCredits[{...}]
Tier
Energy_kWh
Credit
UnitPrice
Type
DemandCharges[{...}]
Tier
Demand_kW
Charge
UnitPrice
Type
CashFlow{...}
Years[{...}]
Year
Summary{...}
CurrentTotal
ProposedTotal
NetSavingsTotal
CumulativeNetSavings
Details[{...}]
Current
Proposed
NetSavings
Component
Incentives{...}
Summary{...}
Cost
NetCost
Taxes
FederalTaxCredits
StateTaxCredits
LocalTaxCredits
Buydowns
OngoingIncentives
Details[{...}]
Name
Type
WebAddress
EnergyProfileName
TotalAmount
TotalTaxes
Years[{...}]
Year
Amount
Taxes
AmountBeforeTaxes
Emissions{...}
Current{...}
Units
CO2
NOX
SO2
Proposed{...}
Units
CO2
NOX
SO2

ProposedBill

Bills.ProposedBill

 

Contains utility bill and energy use details for the proposed scenario. When more than one EnergyProfile has Scenario as “Proposed” or “Both”, the profiles will be combined into one single profile for bill calculation purposes.

HoursInBill

The total number of hours over all periods in the bill calculation.

Possible Values: A decimal value such as 8760.0.

Rate

Contains information on the electric rate used for the bill calculation, such as a description of the rate and the utility that offers the rate.

BillTotals

Contains a breakdown of the bill line items that make up the total bill, such as fixed charges, energy charges, and demand charges. BillTotals is repeated throughout the response schema. When found at the billing period level under PeriodBills, BillTotals contains a bill breakdown for that billing period. BillTotals contains a bill breakdown with totals for all billing periods when found outside of PeriodBills.

EnergyTotals

Contains energy use details such as energy consumed, energy produced, and peak load. EnergyTotals is repeated throughout the response schema. When found at the billing period level under PeriodBills, EnergyTotals contains energy use details for that billing period. When found outside of PeriodBills, EnergyTotals contains energy use details with totals for all billing periods.

PeriodBills

An array containing a detailed breakdown of bill totals and energy use details for each individual billing period.