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

Details

CashFlow.Years.Details

An array containing details on each cash flow component for the current and the proposed scenarios for a given year.

Current

The expense or income for the year associated with the cash flow element identified by Component for the current scenario. Negative values denote expenses, and positive values denote income or savings.

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

Proposed

The expense or income for the year associated with the cash flow element identified by Component for the proposed scenario. Negative values denote expenses, and positive values denote income or savings.

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

NetSavings

The net savings for the year associated with the cash flow element identified by Component for the current scenario. This is calculated by subtracting Current from Proposed. Negative values denote expenses, and positive values denote income or savings.

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

Component

A unique description for the particular cash flow component. Values for Component are unique and consistent.

Possible Values: A specific string describing the component. A few common examples are:

  • “AnnualElectricBill” – Annual cost for electricity from the utility
  • “MaintenanceCost” – Annual maintenance cost
  • “LoanPayment” – Annual loan payment total
  • “LeasePayment” – Annual lease payment total
  • “PpaPayment” – Annual PPA payment total
  • “DownPayment” – A one time payment usually at the beginning of life for a piece of equipment
  • “IncentiveAfterPurchase” – An incentive amount that is usually received in the first year and not applied to the purchase of the system (usually a tax credit)
  • “NetIncentive” – An incentive amount (net of taxes) received at the time of purchase
  • “FederalTaxCredit” – Amount received for federal tax credits
  • “StateTaxCredit” – Amount received for state tax credits
  • “LocalTaxCredit” – Amount received for local tax credits