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

Summary

CashFlow.Years.Summary

 

Contains a high level summary of total expenses for the “Current” and “Proposed” scenarios, total savings, and cumulative total savings for a given year.

CurrentTotal

Net income for the year for the current scenario. This is calculated by summing all Current items from each object in the Details array. Negative values denote expenses, and positive values denote income or savings.

Possible Values: A decimal value such as 12,000.00.

ProposedTotal

Net income for the year for the proposed scenario. This is calculated by summing all Proposed items from each object in the Details array. Negative values denote expenses, and positive values denote income or savings.

Possible Values: A decimal value such as 12,000.00.

NetSavingsTotal

Net savings for the year. This is calculated by subtracting CurrentTotal from ProposedTotal. Negative values denote expenses, and positive values denote income or savings.

Possible Values: A decimal value such as 12,000.00.

CumulativeNetSavings

The cumulative savings for all preceding years in the cash flow plus the current year. This is calculated by summing the NetSavingsTotal from all previous years and the current year. Negative values denote expenses, and positive values denote income or savings.

Possible Values: A decimal value such as 12,000.00.