Documentation: meters
Represents installations of on-grid or mini-grid meters at a specific customer.
To import data in this format you can use our API.
-> API Documentation
You can also supply us with files in xlsx, csv or json format.
-> Example CSV
type | p14n | blurred | autogenerated | required | |
---|---|---|---|---|---|
uid | string | ⤫ | ⤫ | ✓ | ⤫ |
customer_uid + device_uid | |||||
customer_external_id | string | ⤫ | ⤫ | ⤫ | ✓ |
ID for the specific customer associated with the meter | |||||
customer_name | string | ✓ | ⤫ | ⤫ | ⤫ |
customer first and last name (p14) | |||||
customer_id_number | string | ✓ | ⤫ | ⤫ | ⤫ |
customer identification number | |||||
customer_id_type | string | ⤫ | ⤫ | ⤫ | ⤫ |
type of customer identification | |||||
customer_gender | enum: M, F, O | ⤫ | ⤫ | ⤫ | ⤫ |
Male, Female, Other, or Unknown (null) | |||||
customer_birth_year | integer | ⤫ | ⤫ | ⤫ | ⤫ |
year of purchaser birth, for demographic analysis | |||||
customer_former_electricity_source | string | ⤫ | ⤫ | ⤫ | ⤫ |
e.g. none, solar, genset | |||||
customer_household_size | integer | ⤫ | ⤫ | ⤫ | ⤫ |
number of residents of household (if residential use) | |||||
customer_profession | string | ⤫ | ⤫ | ⤫ | ⤫ |
Profession of the customer - e.g. farmer or shop owner | |||||
customer_address | string | ✓ | ⤫ | ⤫ | ⤫ |
customer address | |||||
customer_country | string | ⤫ | ⤫ | ⤫ | ⤫ |
two-letter country code according to ISO 3166-1 alpha-2 | |||||
customer_latitude | float | ✓ | ✓ | ⤫ | ⤫ |
customer latitude (blurred to 3 decimal points) | |||||
customer_longitude | float | ✓ | ✓ | ⤫ | ⤫ |
customer longitude (blurred to 3 decimal points) | |||||
customer_email | string | ✓ | ⤫ | ⤫ | ⤫ |
customer email (p14) | |||||
customer_phone | string | ✓ | ⤫ | ⤫ | ⤫ |
customer telephone (p14) | |||||
customer_phone_2 | string | ✓ | ⤫ | ⤫ | ⤫ |
customer telephone 2 (p14) | |||||
customer_location_area_1 | string | ⤫ | ⤫ | ⤫ | ⤫ |
customer first-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country | |||||
customer_location_area_2 | string | ⤫ | ⤫ | ⤫ | ⤫ |
customer second-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country | |||||
customer_location_area_3 | string | ⤫ | ⤫ | ⤫ | ⤫ |
customer third-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country | |||||
customer_location_area_4 | string | ⤫ | ⤫ | ⤫ | ⤫ |
customer fourth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country | |||||
customer_location_area_5 | string | ⤫ | ⤫ | ⤫ | ⤫ |
customer fifth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country | |||||
device_external_id | string | ⤫ | ⤫ | ⤫ | ✓ |
ID for the specific meter tracked by the data provider (source) | |||||
serial_number | string | ⤫ | ⤫ | ⤫ | ✓ |
serial number of system | |||||
installation_date | date | ⤫ | ⤫ | ⤫ | ⤫ |
date system was installed | |||||
purchase_date | date | ⤫ | ⤫ | ⤫ | ⤫ |
if meter is part of an installation - date system was purchased | |||||
firmware_version | string | ⤫ | ⤫ | ⤫ | ⤫ |
firmware version installed on the smart meter / modem | |||||
manufacturer | string | ⤫ | ⤫ | ⤫ | ✓ |
manufacturer of system, needed to make ID when combined with serial number | |||||
model | string | ⤫ | ⤫ | ⤫ | ⤫ |
specific model of system | |||||
customer_category | string | ⤫ | ⤫ | ⤫ | ⤫ |
how the system is to be used: \"household\", \"institutional\", \"commercial\" | |||||
customer_sub_category | string | ⤫ | ⤫ | ⤫ | ⤫ |
which type of business, which institution | |||||
account_external_id | string | ⤫ | ⤫ | ⤫ | ⤫ |
ID for the specific account (e.g. paygo loan) associated with the meter | |||||
payment_plan | string | ⤫ | ⤫ | ⤫ | ⤫ |
monthly or annual payment plan - e.g. Medium Consumption or High Consumption, paygo or cash | |||||
payment_plan_days | float | ⤫ | ⤫ | ⤫ | ⤫ |
if meter is part of an installation with loan - repayment plan of loan | |||||
payment_plan_down_payment | float | ⤫ | ⤫ | ⤫ | ⤫ |
if meter is part of an installation with loan - amount paid at time of purchase | |||||
payment_plan_amount_financed | float | ⤫ | ⤫ | ⤫ | ⤫ |
if meter is part of an installation with loan - amount to be repaid after down payment | |||||
total_price | float | ⤫ | ⤫ | ⤫ | ⤫ |
Total sales price of the device | |||||
payment_plan_currency | string | ⤫ | ⤫ | ⤫ | ⤫ |
if meter is part of an installation with loan - currency code of payment plan, in ISO 4217 three character format | |||||
primary_use | string | ⤫ | ⤫ | ⤫ | ⤫ |
what type of appliance (if any) is attached? - e.g. cooking, milling, tv | |||||
repossession_date | date | ⤫ | ⤫ | ⤫ | ⤫ |
date system was repossessed, null if not repossessed | |||||
is_locked | boolean | ⤫ | ⤫ | ⤫ | ⤫ |
no energy coming through | |||||
max_power_w | float | ⤫ | ⤫ | ⤫ | ⤫ |
max connection max load in watts | |||||
is_test | boolean | ⤫ | ⤫ | ⤫ | ⤫ |
Is the system installed in the fiel (FALSE) or for testing purposes (TRUE) | |||||
device_uid | string | ⤫ | ⤫ | ✓ | ⤫ |
organization_id + manufacturer + serial_number | |||||
customer_uid | string | ⤫ | ⤫ | ✓ | ⤫ |
organization_id + data_origin + customer_external_id | |||||
account_uid | string | ⤫ | ⤫ | ✓ | ⤫ |
organization_id + data_origin + account_external_id | |||||
grid_uid | string | ⤫ | ⤫ | ✓ | ⤫ |
organization_id + grid_name; FK from grids table | |||||
grid_name | string | ⤫ | ⤫ | ⤫ | ⤫ |
name of the (mini-)grid the meter is connected to, typically given by operator company. Used to identifies the grid. | |||||
created_at | datetime | ⤫ | ⤫ | ✓ | ⤫ |
Timestamp when row was inserted | |||||
updated_at | datetime | ⤫ | ⤫ | ✓ | ⤫ |
Timestamp when row was updated | |||||
source_id | integer | ⤫ | ⤫ | ✓ | ⤫ |
References Source of data | |||||
import_id | integer | ⤫ | ⤫ | ✓ | ⤫ |
References Import of data | |||||
organization_id | integer | ⤫ | ⤫ | ✓ | ⤫ |
References Organization of data | |||||
custom | jsonb | ⤫ | ⤫ | ✓ | ⤫ |
Saves additional imported data out of standard structure | |||||
data_origin | string | ⤫ | ⤫ | ✓ | ⤫ |
Origin of the data, generic or name of the api | |||||
last_import_id | integer | ⤫ | ⤫ | ✓ | ⤫ |
Id of the last import which updated the record | |||||
last_source_id | integer | ⤫ | ⤫ | ✓ | ⤫ |
Id of the last Source which updated the record |