Documentation: meters

This table is deprecated and should not be used for imports

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
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
You can also supply us with files in xlsx, csv or json format. -> Example CSV
Row Name Type Mapping Example

customer_external_id *

ID for the specific customer associated with the meter

  • * required
string installations => customer_external_id

1

device_external_id *

ID for the specific meter tracked by the data provider (source)

  • * required
string installations => device_external_id

1234

serial_number *

serial number of system

  • * required
string installations => serial_number

A1233754345JL

manufacturer *

manufacturer of system, needed to make ID when combined with serial number

  • * required
string installations => manufacturer

HOP

uid

customer_uid + device_uid

  • auto-generated
string installations => uid

123-123

customer_name

customer first and last name (p14)

  • p14n
string customers => name

John Smith - stored as 7c6e6899401b76f23d4eaf4931975872f1b5d9ae026b8b8213a25cf7812d936b

customer_id_number

customer identification number

  • p14n
string customers => identification_number

L23FX1236 - stored as 6a099e5c63f0138de7b3dfa7e03c17e551ea23e53c6399a2f0d490d5d87457de

customer_id_type

type of customer identification

 string customers => identification_type

National ID

customer_gender

Male, Female, Other, or Unknown (null)

 enum: M, F, O customers => gender

M

customer_birth_year

year of purchaser birth, for demographic analysis

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 integer customers => birth_year

1990

customer_former_electricity_source

e.g. none, solar, genset

 string customers => former_electricity_source

none

customer_household_size

number of residents of household (if residential use)

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 integer customers => household_size

5

customer_profession

Profession of the customer - e.g. farmer or shop owner

 string customers => profession

farmer

customer_address

customer address

  • p14n
string customers => address

Some Street 123, Example Village - stored as 452a20d7b82bd6ad82f0bf482f382bfe55f90dcb140e1e79d38b15a4450770d7

customer_country

two-letter country code according to ISO 3166-1 alpha-2

 string customers => country

ZM

customer_latitude

customer latitude (blurred to 3 decimal points)

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

  • blurred
  • p14n
float installations => latitude

12.123

customer_longitude

customer longitude (blurred to 3 decimal points)

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

  • blurred
  • p14n
float installations => longitude

20.456

customer_email

customer email (p14)

  • p14n
string customers => email

test@example.com - stored as b37645e1cc4bc50636c11a9a19566f2ae56764333789159dacb171580c42e49b

customer_phone

customer telephone (p14)

  • p14n
string customers => phone

0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27

customer_phone_2

customer telephone 2 (p14)

  • p14n
string customers => phone_2

0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27

customer_location_area_1

customer first-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

 string installations => location_area_1

Western

customer_location_area_2

customer second-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

 string installations => location_area_2

Bundibugyo

customer_location_area_3

customer third-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

 string installations => location_area_3

Bughendera County

customer_location_area_4

customer fourth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

 string installations => location_area_4

Bukonzo

customer_location_area_5

customer fifth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country

 string installations => location_area_5

Buhundu

installation_date

date system was installed

 date installations => installation_date

2021-01-01

purchase_date

if meter is part of an installation - date system was purchased

 date installations => purchase_date

2022-01-01

firmware_version

firmware version installed on the smart meter / modem

 string installations => firmware_version

1.2-rc3

model

specific model of system

 string installations => model

DTZ1737

customer_category

how the system is to be used: household, institutional, commercial

 string installations => usage_category

commercial

customer_sub_category

which type of business, which institution

 string installations => usage_sub_category

barber shop

account_external_id

ID for the specific account (e.g. paygo loan) associated with the meter

 string installations => account_external_id

11223344

payment_plan

monthly or annual payment plan - e.g. Medium Consumption or High Consumption, paygo or cash

 string installations => payment_plan_category

Medium Consumption

payment_plan_days

if meter is part of an installation with loan - repayment plan of loan

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float installations => payment_plan_days_financed

720.5

payment_plan_down_payment

if meter is part of an installation with loan - amount paid at time of purchase

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float installations => payment_plan_amount_down_payment

1500.0

payment_plan_amount_financed

if meter is part of an installation with loan - amount to be repaid after down payment

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float installations => payment_plan_amount_financed_total

1500.0

total_price

Total sales price of the device

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float installations => payment_plan_cash_price

130000

payment_plan_currency

if meter is part of an installation with loan - currency code of payment plan, in ISO 4217 three character format

 string installations => payment_plan_currency

ZMW

primary_use

what type of appliance (if any) is attached? - e.g. cooking, milling, tv

 string installations => primary_use

cooking

repossession_date

date system was repossessed, null if not repossessed

 date installations => repossession_date

2022-01-01

is_locked

no energy coming through

 boolean installations => custom

FALSE

max_power_w

max connection max load in watts

Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error.

 float installations => rated_power_w

5000

is_test

Is the system installed in the field (FALSE) or for testing purposes (TRUE)

 boolean installations => is_test

true

device_uid

organization_id + manufacturer + serial_number

  • auto-generated
string installations => device_uid

1-a2ei-ABC123

customer_uid

organization_id + data_origin + customer_external_id

  • auto-generated
string installations => customer_uid

1-api-1

account_uid

organization_id + data_origin + account_external_id

  • auto-generated
string installations => account_uid

1-api-1

grid_uid

organization_id + data_origin + grid_external_id; FK from grids table

  • auto-generated
string installations => parent_external_id

a2ei-X98679862w

grid_name

name of the (mini-)grid the meter is connected to, typically given by operator company.

 string installations => site_name

SMU 12 Chinsanka

grid_external_id

ID for the specific (mini-)grid, used to build the grid_uid

 string

X98679862w

created_at

Timestamp when row was inserted

  • auto-generated
datetime

2021-05-03 6:23:55

updated_at

Timestamp when row was updated

  • auto-generated
datetime

2021-05-03 6:23:55

source_id

References Source of data

  • auto-generated
integer

1

import_id

References Import of data

  • auto-generated
integer

1

organization_id

References Organization of data

  • auto-generated
integer

1

custom

Saves additional imported data out of standard structure

  • auto-generated
jsonb

{ "some": "key" }

data_origin

Origin of the data, generic or name of the api

  • auto-generated
string

generic

last_import_id

Id of the last import which updated the record

  • auto-generated
integer

337

last_source_id

Id of the last Source which updated the record

  • auto-generated
integer

33