Documentation: payments_ts
Payment time series data for SHS Accounts or Meter Accounts
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 | ⤫ | ⤫ | ✓ | ⤫ |
account_origin + account_uid + payment_external_id + paid_at | |||||
payment_external_id | string | ⤫ | ⤫ | ⤫ | ✓ |
ID for the specific payment as tracked by the data provider (source) | |||||
purpose | string | ⤫ | ⤫ | ⤫ | ⤫ |
e.g.: Paygo payment, Loan repayment, cash purchase, tariff payment, etc. | |||||
paid_at | datetime | ⤫ | ⤫ | ⤫ | ✓ |
date payment was made (including time if available) | |||||
amount | float | ⤫ | ⤫ | ⤫ | ✓ |
amount of payment, in whatever currency is specified | |||||
currency | string | ⤫ | ⤫ | ⤫ | ✓ |
currency in which payment was made according to ISO code https://en.wikipedia.org/wiki/List_of_circulating_currencies | |||||
purchase_item | string | ⤫ | ⤫ | ⤫ | ⤫ |
item or rate which was purchased with the payment, e.g. 'Energy', 'TV', 'Uptime' | |||||
purchase_unit | string | ⤫ | ⤫ | ⤫ | ⤫ |
unit of the purchase, e.g. 'wh', 'pcs', 'days' | |||||
purchase_quantity | float | ⤫ | ⤫ | ⤫ | ⤫ |
amount of units of the item purchased | |||||
provider_name | string | ⤫ | ⤫ | ⤫ | ⤫ |
who provided payment for particular payment (e.g. airtel, cash, MTN) | |||||
provider_transaction_id | string | ⤫ | ⤫ | ⤫ | ⤫ |
data validation, was transaction actually done | |||||
reverted_at | datetime | ⤫ | ⤫ | ⤫ | ⤫ |
datetime of when payment was reverted | |||||
days_active | float | ⤫ | ⤫ | ⤫ | ⤫ |
information from shs table, is calculated | |||||
account_external_id | string | ⤫ | ⤫ | ⤫ | ✓ |
external id for the specific account (e.g. paygo loan) associated with the shs or meter | |||||
account_uid | string | ⤫ | ⤫ | ✓ | ⤫ |
organization_id + data_origin + account_external_id | |||||
account_origin | enum: meters, shs | ⤫ | ⤫ | ⤫ | ✓ |
The table where we find the matching account_uid | |||||
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 |