Documentation: installations

customer_external_id

Identifies the customer in the context of the data_origin. Can be a fixed ID in another database system or any other way to identify the customer, but note that this information is not encrypted, if you use national id numbers or phone numbers pseudonymize them first.

manufacturer

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

serial_number

Serial number of the device

uid

device_uid + customer_uid

device_uid

organization_id + manufacturer + serial_number

parent_uid

If the device is attached to another in a star like topology, like an appliance associated with a specific solar system or a meter associated with a specific grid.

account_uid

organization_id + data_origin + account_external_id

customer_uid

organization_id + data_origin + customer_external_id

seller_agent_uid

organization_id + data_origin + seller_agent_external_id

seller_agent_external_id

the external ID of the seller agent

installer_agent_uid

organization_id + data_origin + installer_agent_external_id

installer_agent_external_id

The unique identifier of the installer as recorded in the source data table, ex. the CRM or sales platform used by the company.

product_common_id

id of common_product table for verified products.

device_external_id

id of the specific device as recorded in the source data table, ex. the CRM or sales platform used by the company.

parent_external_id

ID for the specific device parent tracked by the data provider

account_external_id

ID for the specific loan account or sale associated with the device. Ideally this is a number which can be used to link to any associated payments.

battery_capacity_wh

battery capacity in watt-hour

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

usage_category

The intended use for this device, e.g. household, institutional, commercial

usage_sub_category

which type of business, which institution

device_category

type of device

ac_input_source

ex. generator, grid, wind turbine

dc_input_source

the type of power input source used, indicating where the energy is sourced from (e.g., solar, grid, battery)

firmware_version

firmware version installed on the smart meter / modem

model

specific model of system

primary_use

Which appliance is bearing the main load of system. This is also used for calculation of device-specific events, ex. number of cooking events.

rated_power_w

Max. rated power in Watts

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

pv_power_w

PV panel size in Watts

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

site_name

Unhashed name for the device

payment_plan_amount_financed_principal

If the device is purchased with a loan, this is the total amount of principal to be repaid (excluding down payment and interest)

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

payment_plan_amount_financed_interest

If device is purchased with a loan, this represents the interest applied to the financed portion of the payment plan after the down payment has been made.

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

payment_plan_amount_financed_total

If device is purchased with a loan, this is the total amount of the loan to be repaid. This should not include the down payment. This is equal to payment_plan_amount_financed_interest + payment_plan_amount_financed_principal

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

payment_plan_amount_down_payment

If a device is purchased with a loan, the down payment refers to the amount the customer is obligated to pay at the time of purchase. While the customer may choose to pay more, this value reflects only the amount specified in the loan terms.

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

payment_plan_cash_price

The cash price is the amount the customer pays when purchasing the device outright. It is usually equal to payment_plan_amount_down_payment + payment_plan_amount_financed_principal for the same product on loan.

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

payment_plan_currency

If the device is part of an installation with loan this is currency code of payment plan in ISO 4217 three character format.

payment_plan_installment_amount

If the device is purchased with a loan, this is the amount owed in each installment period, e.g., 25000.00 UGX every 30 days.

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

payment_plan_number_of_installments

If the device is purchased with a loan, this is the total number of payment installments required to fully repay the loan for the device.

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

payment_plan_installment_period_days

If the device is purchased with a loan, this represents the number of days of lighting per installment paid. For example, if the loan requires 25,000 UGX every 30 days, the payment_plan_installment_period_days is 30.

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

payment_plan_days_financed

If the device is purchased with a loan, this indicates the loan duration in days, (payment_plan_installment_period_days * number_of_installments). It excludes any days covered by the down payment.

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

payment_plan_days_down_payment

This is the number of days of lighting resulting from the payment of a down payment. Note that the first installment will normally be due at the end of this period.

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

payment_plan_category

Type of the repayment model

purchase_date

Date when the device was purchased

installation_date

Date when the device was installed

repossession_date

Date when the device was repossessed (null if not repossessed).

paid_off_date

Date when the device was paid off (null if not paid off).

repossession_category

The reason for repossession, classifying the type of action taken regarding the asset.

write_off_date

Date when customer defaulted on the loan and/or the device was written off

write_off_reason

reason for write off (e.g. cancellation, return, etc.)

is_test

Indicates that this is a test installation, which should be excluded in overall analyses.

latitude

Latitude of installation, blurred to 3 decimal points

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

longitude

Installation location longitude blurred to 3 decimal points

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

country

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

location_area_1

Installation first-level location according to Administrative division

location_area_2

Installation second-level location according to Administrative division

location_area_3

Installation third-level location according to Administrative division

location_area_4

Installation fourth-level location according to Administrative division

location_area_5

Installation fifth-level location according to Administrative division

longitude_autogen

Auto-generated coordinates from given location area 1-5

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

latitude_autogen

Auto-generated coordinates from given location area 1-5

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

location_area_1_autogen

Auto-generated location area 1-5 from given coordinates

location_area_2_autogen

Auto-generated location area 1-5 from given coordinates

location_area_3_autogen

Auto-generated location area 1-5 from given coordinates

location_area_4_autogen

Auto-generated location area 1-5 from given coordinates

location_area_5_autogen

Auto-generated location area 1-5 from given coordinates

created_at

Timestamp when row was inserted

updated_at

Timestamp when row was updated

source_id

References Source of data

import_id

References Import of data

organization_id

References Organization of data

custom

Saves additional imported data out of standard structure

data_origin

Origin of the data, generic or name of the api

last_import_id

Id of the last import which updated the record

last_source_id

Id of the last Source which updated the record