Rates Request
Rates Response
Bill Request
Bill Response
BillSavings Request
CustomerInfo{...}
Sector
Location{...}
Address{...}
PostalCode
Income
TaxFilingStatus
Meters[{...}]
Name
CurrentRate{...}
Id
ProposedRate{...}
Id
AnnualUtilityBillEscalation_Percent
EnergyProfiles[{...}]
{"Type": "Consumption", ...}
Name
Scenario
IntervalData{...}
Interpolation
IntervalConvention
Interval
Data[{...}]
Time
Energy_kWh
BillAmount
{"Type": "Production"}
Name
Scenario
IntervalData{...}
Interpolation
IntervalConvention
Interval
Data[{...}]
Time
Energy_kWh
{"Type": "Pv", ...}
Name
Scenario
EquipmentLife_Years
SystemDegradationPerYear_Percent
ProductionEnergyProfileName
PvSimulation{...}
EnergySite{...}
Location{...}
Latitude
Longitude
PvSystems[{...}]
Albedo_Percent
GeneralDerate_Percent
Inverters[{...}]
Count
MaxPowerOutputAC_kW
EfficiencyRating_Percent
PvArrays[{...}]
PvModules[{...}]
Count
NameplateDCRating_kW
PtcRating_kW
PowerTemperatureCoefficient_PercentPerDegreeC
NominalOperatingCellTemperature_DegreesC
ArrayConfiguration{...}
Azimuth_Degrees
Tilt_Degrees
Tracking
TrackingRotationLimit_Degrees
MonthlyShadings[{...}]
MonthNumber
SolarAccess_Percent
CashPayment{...}
Cost
SaleMonth
SaleYear
LoanPayment{...}
Cost
InterestRate_Percent
LoanType
Term_Years
DownPaymentAmount
SaleMonth
SaleYear
LeasePayment{...}
Cost
FirstYearMonthlyPayment
PaymentFactor
AnnualPaymentEscalation_Percent
Term_Years
DownPaymentAmount
SaleMonth
SaleYear
PpaPayment{...}
Cost
PaymentPerkWh
AnnualPaymentEscalation_Percent
Term_Years
DownPaymentAmount
SaleMonth
SaleYear
MaintenanceCosts{...}
AnnualMaintenanceCost
OneTimeMaintenanceCost
OneTimeMaintenanceCostYear
BillPeriods[{...}]
Name
StartDate
BillPeriodEnd
EstimationOptions{...}
IncludeTaxEffects
OutputData[...]
BillSavings Response

EstimationOptions

This is where the caller specifies which details they would like included in the response.

IncludeTaxEffects

You can choose to include or to ignore tax effects. Tax effects are relevant when calculating the tax savings associated with loan interest payments for a secured loan or when calculating the tax effects of taxable incentives. Tax effects are impacted by CustomerInfo such as Income or TaxFilingStatus.

Possible Values: A string equal to “True” or “False”

Default: False.

OutputData

An array containing a list of the data sets to be included in the response.

Possible Values: An array containing one or more of the following strings.

  • “BillSummaries” – Bill and energy totals for all BillPeriods
  • “BillDetails” – Bill and energy totals for each billing period plus details, including a breakdown of fixed charges, energy charges, and others by season and time-of-use period when applicable
  • “CashFlow” – A year by year expense report for the current and proposed scenario
  • “Incentives” – Details for all applicable incentives
  • “Emissions” – A breakdown of SO2, NOx, and CO2 emissions for the current and proposed scenario

Default: “BillDetails”.