Skip to main content
A user has locations, a location holds tariffs and devices, and a device prices against the tariffs at its location.
The supplier is a property of the tariff, so there is no supplier endpoint.

Tariffs

Connect the tariff once per location and every device there prices against it, including devices added later. A device that moves prices against the tariffs at its new location.

Device tariffs

A device tariff is a tariff with a device_id, for a device the supplier prices separately, such as a heat pump on a reduced grid-fee rate. Connect creates one when the tariff the user connects applies to one device only.
  • For the same tariff_type and direction, it replaces the location tariff for that device; the two are never combined.
  • It is bound to the device and location pair, so it stops applying when the device moves away and applies again if the device returns.
  • Deleting the device or the location deletes it.
  • Location costs exclude energy priced under a device tariff, so no kWh is counted twice.

Prices

A price combines the tariffs that apply at a point in time: commodity plus non-commodity. Fixed charges that do not depend on consumption, such as standing charges, are not included. For each type and direction, a device resolves to one tariff: its device tariff if it has one, otherwise the location tariff. The price audit returns each component per interval.

Device types

Set device_type when you create the device: BATTERY_STORAGE, ELECTRIC_VEHICLE, EV_CHARGER, AIR_CONDITIONER, HEAT_PUMP, WATER_HEATER, PV_SYSTEM, POWER_GENERATOR or OTHER. Connect uses it for the noun your users see: BATTERY_STORAGE reads “your battery”. The type is all a device needs. Add a pv capability block to a solar system so price windows carry its forecast.