Documentation: paygo_accounts_snapshots_ts
Rate limit: 300 requests per minute. Once the limit is exceeded, any further requests will result in a 429 (Too Many Requests) response.
Required | Type | p14n | Blurred | Autogenerated | Example | |
---|---|---|---|---|---|---|
snapshot_date Date for which snapshot is calculated for. |
✓ | date | ⤫ | ⤫ | ⤫ |
2021-05-03 |
account_status active, completed, defaulted, cancelled, locked, returned |
✓ | enum: active, completed, defaulted, cancelled, locked, returned | ⤫ | ⤫ | ⤫ |
active |
days_in_repayment When negative: Days until paygo period starts - account is in downpayment period. Then counts up from zero when paygo repayment period starts. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | integer | ⤫ | ⤫ | ⤫ |
5 |
cumulative_paid_amount The accumulated amount the customer paid to this snapshot date. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | float | ⤫ | ⤫ | ⤫ |
500.0 |
days_to_cutoff How many days until system will switch off. Negative if locked for N days. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | integer | ⤫ | ⤫ | ⤫ |
7 |
cumulative_days_locked How many days system was off over its lifetime. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | integer | ⤫ | ⤫ | ⤫ |
2 |
total_remaining_amount How much money is left to payoff the system. Only period (.) decimal delimiters are supported. Do not use commas (,) — they will cause an error. |
✓ | float | ⤫ | ⤫ | ⤫ |
4500.0 |
account_external_id id for the specific account (e.g. paygo loan) associated with the shs device; FK to accounts table |
✓ | string | ⤫ | ⤫ | ⤫ |
11223344 |
is_most_recent used in an DB index to identify most recent payment snapshots |
✓ | boolean | ⤫ | ⤫ | ⤫ |
true |
account_uid organization_id + data_origin + account_external_id; FK to accounts table |
⤫ | string | ⤫ | ⤫ | ✓ |
1_a2ei_ABC123 |
created_at Timestamp when row was inserted |
⤫ | datetime | ⤫ | ⤫ | ✓ |
2021-05-03 6:23:55 |
updated_at Timestamp when row was updated |
⤫ | datetime | ⤫ | ⤫ | ✓ |
2021-05-03 6:23:55 |
source_id References Source of data |
⤫ | integer | ⤫ | ⤫ | ✓ |
1 |
organization_id References Organization of data |
⤫ | integer | ⤫ | ⤫ | ✓ |
1 |
custom Saves additional imported data out of standard structure |
⤫ | jsonb | ⤫ | ⤫ | ✓ |
{ "some": "key" } |
data_origin Origin of the data, generic or name of the api |
⤫ | string | ⤫ | ⤫ | ✓ |
generic |