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

TouPeriods

Bills.CurrentBills.PeriodBill.Seasons.TouPeriods

 

Contains bill and energy details for time-of-use periods within a billing period. Rates without a time-of-use structure will not have TouPeriods.

Name

The name of the time-of-use period.

Possible Values: A string such as “On-Peak”.

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.

EnergyCharges

An array of charges associated with energy use for a given time period. EnergyCharges is repeated at various levels of the response schema. When found at the season level, EnergyCharges contains charges applicable to a particular season, such as block or tier charges. When found at the time of use level under TouPeriods, EnergyCharges contains charges applicable to a particular time of use block.

EnergyCredits

An array of credits associated with energy use for a given time period. EnergyCredits is repeated at various levels of the response schema. When found at the season level, EnergyCredits contains credits applicable to a particular season, such as block or tier charges. When found at the time of use level under TouPeriods, EnergyCredits contains credits applicable to a particular time of use block.

DemandCharges

An array of charges associated with peak demand for a given time period. DemandCharges is repeated at various levels of the response schema. When found at the season level, DemandCharges contains charges applicable to a particular season. When found at the time-of-use level under TouPeriods, DemandCharges contains charges applicable to a particular time-of-use block.