Sélectionnez votre langue

Documentation: payments_ts

Payment time series data for SHS Accounts or Meter Accounts
Pour importer des données dans ce format, vous pouvez utiliser notre API. -> Documentation API
Limite de débit : 300 requêtes par minute. Une fois la limite dépassée, toute requête ultérieure entraînera une réponse 429 (Trop de requêtes).
Vous pouvez également nous fournir des fichiers aux formats xlsx, csv ou json. -> Exemple CSV
Nom de la ligne Type Exemple

payment_external_id *

ID for the specific payment as tracked by the data provider (source)

  • * requis
string

ABC-123

paid_at *

date payment was made (including time if available)

  • * requis
datetime

2022-07-30 14:45:32.876Z

amount *

amount of payment, in whatever currency is specified

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

  • * requis
float

150.5

currency *

currency in which payment was made according to ISO code https://en.wikipedia.org/wiki/List_of_circulating_currencies

  • * requis
string

ZMW

account_origin *

The table where we find the matching account_uid

  • * requis
enum: meters, shs, installations, grids

meters

account_external_id *

external id for the specific account (e.g. paygo loan) associated with the shs or meter

  • * requis
string

1234abcd

last_source_id

Id of the last Source which updated the record

  • généré automatiquement
integer

33

last_import_id

Id of the last import which updated the record

  • généré automatiquement
integer

337

data_origin

Origin of the data, generic or name of the api

  • généré automatiquement
string

generic

custom

Saves additional imported data out of standard structure

  • généré automatiquement
jsonb

{ "some": "key" }

organization_id

References Organization of data

  • généré automatiquement
integer

1

import_id

References Import of data

  • généré automatiquement
integer

1

source_id

References Source of data

  • généré automatiquement
integer

1

updated_at

Timestamp when row was updated

  • généré automatiquement
datetime

2021-05-03 6:23:55

created_at

Timestamp when row was inserted

  • généré automatiquement
datetime

2021-05-03 6:23:55

account_uid

organization_id + data_origin + account_external_id

  • généré automatiquement
string

1-generic-1234abcd

days_active

information from shs table, is calculated

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

 float

7.2

reverted_at

datetime of when payment was reverted

 datetime

2022-07-30 14:48:20.876Z

provider_transaction_id

data validation, was transaction actually done

 string

12345X

provider_category

high level category of the payment, like bank transfer, cash, mobile money, app, other

 string

mobile money

provider_name

who provided payment for particular payment (e.g. airtel, cash, MTN)

 string

MTN

purchase_quantity

amount of units of the item purchased

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

 float

3.0

purchase_unit

unit of the purchase, e.g. 'wh', 'pcs', 'days'

 string

days

purchase_item

item or rate which was purchased with the payment, e.g. 'Energy', 'TV', 'Uptime'

 string

Uptime

paid_until

date payment is valid until

 datetime

2022-07-30 14:45:32.876Z

purpose

e.g.: Paygo payment, Loan repayment, cash purchase, tariff payment, etc.

 string

Paygo Payment

uid

account_origin + account_uid + payment_external_id + paid_at

  • généré automatiquement
string

meters-1-generic-1234abcd-ABC-123-2022-07-30 14:45:32.876Z