Complete Schema

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

CustomerInfo

Contains customer information such as the location of the customer’s meters, whether the customer is a residential or commercial customer, and tax information.

  
  "CustomerInfo": {
    "Sector": "Residential",
    "Location": {
      "Address": { "PostalCode": "85210" }
    },
    "Income": 80000.0,
    "TaxFilingStatus": "MarriedFilingJointly"
  }

Sector

The classification of a customer’s service type. Sector affects CashFlow and Incentives in the response.

Possible Values: A string equal to “Residential” or “Commercial”.

Default: “Residential”.

Location

Contains information on the customer’s location. This is used to determine available incentives.

Required.

Income

The annual income of the customer household or business.

Possible Values: Any decimal value, such as 80000.00.

Default: 80000.

TaxFilingStatus

The tax filing status for the customer household or business. If Sector is specified as “Commercial”, TaxFilingStatus will factor into determining which incentives are available.

Possible Values: If Sector is specified as “Residential”, a string equal to “MarriedFilingJointly”, “HeadOfHousehold”, “Single”, or “MarriedFilingSeparately”. If Sector is specified as “Commercial”, a string equal to “Corporation” or “NonProfit”.

Default: If Sector is specified as “Residential”, default is “MarriedFilingJointly”. If Sector is specified as “Commercial”, default is “Corporation”.