Documentation: shs

Represents installations of Solar Home Systems at individual customers
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
device_external_id string
id for the specific shs system as tracked by the data provider (source)
account_external_id string
id for the specific account (e.g. paygo loan) associated with the shs device
serial_number string
serial number of system
purchase_date date
date system was purchased
manufacturer string
manufacturer of system, needed to make id when combined with serial number
model string
model of system, needed e.g. for matching eligible systems of an rbf program
pv_power_w float
PV panel size in watts
battery_energy_wh float
battery capacity in watt-hour
voltage_v float
system voltage in volts; e.g. - 5, 12 if DC or 110, 230 if AC
rated_power_w float
max rated capacity in watts
customer_category string
how the system is to be used: \"household\", \"institutional\", \"commercial\"
customer_sub_category string
which type of business, which institution
primary_use string
what appliance is the main load of system
payment_plan_days float
repayment plan of system/loan
payment_plan_down_payment float
amount paid at time of purchase, total cost if paid in full at purchase
payment_plan_amount_financed float
amount to be repaid after down payment, 0 if paid in full at purchase
total_price float
Total sales price of the device
payment_plan_type string
\"paygo\" or \"full\" if paid in full at purchase
payment_plan_currency string
currency code of payment plan, in ISO 4217 three character format
paid_off_date date
date system was paid off, null if not paid off
repossession_date date
date system was repossessed, null if not repossessed
is_test boolean
is a test system, should be excluded in overall analyses
customer_external_id string
ID for the specific customer associated with the shs device
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 customer - e.g. farmer or shop owner
customer_address string
customer address (p14)
customer_country string
two-letter country code according to https://en.wikipedia.org/wiki/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
seller_external_id string
ID for the specific sales agent associated with the shs device
seller_name string
sales agent name (p14)
seller_gender enum: M, F, O
male (M), female (F), other (O) or unknown (null)
seller_address string
sales agend address (p14)
seller_country string
two-letter country code according to https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
seller_latitude float
sales agent's latitude (blurred to 3 decimal points)
seller_longitude float
sales agent's longitude (blurred to 3 decimal points)
seller_email string
sales agent email (p14)
seller_phone string
sales agent telephone (p14)
seller_location_area_1 string
sales agent first-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country
seller_location_area_2 string
sales agent second-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country
seller_location_area_3 string
sales agent third-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country
seller_location_area_4 string
sales agent fourth-level location according to Administrative division, see https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country
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
id integer
Internal primary key
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
trust_score float
calculated value how much we trust data
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