Documentation: shs

Represents installations of Solar Home Systems at individual customers
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
Required Type p14n Blurred Autogenerated Example

device_external_id

id for the specific shs system as tracked by the data provider (source)

string

x98679862w

account_external_id

id for the specific account (e.g. paygo loan) associated with the shs device

string

11223344

serial_number

serial number of system

string

A1233754345JL

manufacturer

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

string

Spark

customer_external_id

ID for the specific customer associated with the shs device

string

123

uid

customer_uid + device_uid

string

123-456

purchase_date

date system was purchased

date

2022-01-01

model

model of system, needed e.g. for matching eligible systems of an rbf program

string

SMRSD

pv_power_w

PV panel size in watts

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

float

30.0

battery_energy_wh

battery capacity in watt-hour

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

float

500.0

voltage_v

system voltage in volts; e.g. - 5, 12 if DC or 110, 230 if AC

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

float

12.0

rated_power_w

max rated capacity in watts

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

float

30.0

customer_category

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

string

commercial

customer_sub_category

which type of business, which institution

string

barber shop

primary_use

what appliance is the main load of system

string

refrigerator

payment_plan_days

repayment plan of system/loan

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

float

720.5

payment_plan_down_payment

amount paid at time of purchase, total cost if paid in full at purchase

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

float

1500.0

payment_plan_amount_financed

amount to be repaid after down payment, 0 if paid in full at purchase

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

float

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

130000.0

payment_plan_type

\"paygo\" or \"full\" if paid in full at purchase

string

paygo

payment_plan_currency

currency code of payment plan, in ISO 4217 three character format

string

ZMW

paid_off_date

date system was paid off, null if not paid off

date

2022-05-14

repossession_date

date system was repossessed, null if not repossessed

date

2022-03-20

is_test

is a test system, should be excluded in overall analyses

boolean

false

customer_name

customer first and last name (p14)

string

John Smith - stored as 7c6e6899401b76f23d4eaf4931975872f1b5d9ae026b8b8213a25cf7812d936b

customer_id_number

customer identification number

string

L23FX1236 - stored as 6a099e5c63f0138de7b3dfa7e03c17e551ea23e53c6399a2f0d490d5d87457de

customer_id_type

type of customer identification

string

National ID

customer_gender

Male, Female, Other, or Unknown (null)

enum: M, F, O

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

1990

customer_former_electricity_source

e.g. none, solar, genset

string

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

5

customer_profession

profession of customer - e.g. farmer or shop owner

string

farmer

customer_address

customer address (p14)

string

Some Street 123, Example Village - stored as 452a20d7b82bd6ad82f0bf482f382bfe55f90dcb140e1e79d38b15a4450770d7

customer_country

two-letter country code according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

string

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.

float

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.

float

-20.456

customer_email

customer email (p14)

string

test@example.com - stored as b37645e1cc4bc50636c11a9a19566f2ae56764333789159dacb171580c42e49b

customer_phone

customer telephone (p14)

string

0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27

customer_phone_2

customer telephone 2 (p14)

string

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

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

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

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

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

Buhundu

seller_external_id

ID for the specific sales agent associated with the shs device

string

12345

seller_name

sales agent name (p14)

string

John Smith - stored as 7c6e6899401b76f23d4eaf4931975872f1b5d9ae026b8b8213a25cf7812d936b

seller_gender

male (M), female (F), other (O) or unknown (null)

enum: M, F, O

F

seller_address

sales agend address (p14)

string

Some Street 123, Example Village - stored as 452a20d7b82bd6ad82f0bf482f382bfe55f90dcb140e1e79d38b15a4450770d7

seller_country

two-letter country code according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

string

ZM

seller_latitude

sales agent's latitude (blurred to 3 decimal points)

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

float

12.203

seller_longitude

sales agent's longitude (blurred to 3 decimal points)

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

float

-20.678

seller_email

sales agent email (p14)

string

test@example.com - stored as b37645e1cc4bc50636c11a9a19566f2ae56764333789159dacb171580c42e49b

seller_phone

sales agent telephone (p14)

string

0123456789 - stored as c340f947f1f7cb83c8f40bb5a7ad24ca78486bdfb2ef587f55ea537de17efc27

seller_location_area_1

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

string

Copperbelt

seller_location_area_2

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

string

Mazabuka

seller_location_area_3

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

string

Chizobo

seller_location_area_4

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

string

Chizobo

device_uid

organization_id + manufacturer + serial_number

string

1_a2ei_ABC123

customer_uid

organization_id + data_origin + customer_external_id

string

1_api_123

account_uid

organization_id + data_origin + account_external_id

string

1_api_123

created_at

Timestamp when row was inserted

datetime

2021-05-03 6:23:55

updated_at

Timestamp when row was updated

datetime

2021-05-03 6:23:55

source_id

References Source of data

integer

1

import_id

References Import of data

integer

1

organization_id

References Organization of data

integer

1

custom

Saves additional imported data out of standard structure

jsonb

{ "some": "key" }

data_origin

Origin of the data, generic or name of the api

string

generic

last_import_id

Id of the last import which updated the record

integer

337

last_source_id

Id of the last Source which updated the record

integer

33