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
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
payment_external_id ID for the specific payment as tracked by the data provider (source)	✓	string	⤫	⤫	⤫
paid_at date payment was made (including time if available)	✓	datetime	⤫	⤫	⤫
amount amount of payment, in whatever currency is specified	✓	float	⤫	⤫	⤫
currency currency in which payment was made according to ISO code https://en.wikipedia.org/wiki/List_of_circulating_currencies	✓	string	⤫	⤫	⤫
account_external_id external id for the specific account (e.g. paygo loan) associated with the shs or meter	✓	string	⤫	⤫	⤫
account_origin The table where we find the matching account_uid	✓	enum: meters, shs	⤫	⤫	⤫
uid account_origin + account_uid + payment_external_id + paid_at	⤫	string	⤫	⤫	✓
purpose e.g.: Paygo payment, Loan repayment, cash purchase, tariff payment, etc.	⤫	string	⤫	⤫	⤫
purchase_item item or rate which was purchased with the payment, e.g. 'Energy', 'TV', 'Uptime'	⤫	string	⤫	⤫	⤫
purchase_unit unit of the purchase, e.g. 'wh', 'pcs', 'days'	⤫	string	⤫	⤫	⤫
purchase_quantity amount of units of the item purchased	⤫	float	⤫	⤫	⤫
provider_name who provided payment for particular payment (e.g. airtel, cash, MTN)	⤫	string	⤫	⤫	⤫
provider_transaction_id data validation, was transaction actually done	⤫	string	⤫	⤫	⤫
reverted_at datetime of when payment was reverted	⤫	datetime	⤫	⤫	⤫
days_active information from shs table, is calculated	⤫	float	⤫	⤫	⤫
account_uid organization_id + data_origin + account_external_id	⤫	string	⤫	⤫	✓
created_at Timestamp when row was inserted	⤫	datetime	⤫	⤫	✓
updated_at Timestamp when row was updated	⤫	datetime	⤫	⤫	✓
source_id References Source of data	⤫	integer	⤫	⤫	✓
import_id References Import of data	⤫	integer	⤫	⤫	✓
organization_id References Organization of data	⤫	integer	⤫	⤫	✓
custom Saves additional imported data out of standard structure	⤫	jsonb	⤫	⤫	✓
data_origin Origin of the data, generic or name of the api	⤫	string	⤫	⤫	✓
last_import_id Id of the last import which updated the record	⤫	integer	⤫	⤫	✓
last_source_id Id of the last Source which updated the record	⤫	integer	⤫	⤫	✓