Skip to main content
The diagram below shows the relationships between core objects in Flatpeak, along with their key attributes and API methods. Click any object to view its corresponding API reference. A summary of each object and its key properties is provided below:
ObjectDescriptionKey properties
CustomerA user in your system.Your user reference
LocationA physical address (supply address) where electricity is delivered under a contract with an energy provider — e.g. flat, house, office, or factory.Postal address, linked Tariff(s), energy consumption and/or export history
TariffA cost component of electricity supply at a Location, based on one or more contracts — e.g. energy usage rates or network charges. Tariff objects are typically created automatically via the Connect flow and kept up to date by Flatpeak in the background, usually refreshed once per day.Energy price schedule
DeviceA physical device (e.g. EV, charger, battery, HVAC). Devices are not directly linked to Locations, but an internal association is created when you submit meter readings, as these are always contextual to the device’s current location.Your device reference, energy consumption and/or export history
ProviderIdentifies the energy provider for a Tariff Element, allowing you to track which organisation supplies electricity to your users.Name, served area