Dokumentacja | Dokumentacja API

Czym są strefy taryfowe?

Strefy taryfowe pozwalają na rozliczanie zużycia energii elektrycznej według różnych stawek w zależności od pory dnia. Liczniki jednostrefowe pokazują całkowite zużycie, dwustrefowe rozdzielają dzień i noc, a trzystrefowe - szczyt, półszczyt i noc.

Obsługiwane kraje:

Ukraina - Energia elektryczna

Typy taryf

jednostrefowy

TOTAL T1

Całkowity

Jeden taryfa na całą dobę

100%

trzystrefowy

PEAK T1

Szczyt

08:00–11:00, 20:00–22:00 (150% taryfy)

150% 08:00–11:00, 20:00–22:00

HALF_PEAK T2

Półszczyt

07:00–08:00, 11:00–20:00, 22:00–23:00 (100% taryfy)

100% 07:00–08:00, 11:00–20:00, 22:00–23:00

NIGHT T3

Noc

23:00–07:00 (50% taryfy)

40% 23:00–07:00

dwustrefowy

DAY T1

Dzień

07:00–23:00 (100% taryfy)

100% 07:00–23:00

NIGHT T2

Noc

23:00–07:00 (50% taryfy)

50% 23:00–07:00

Jak używać

Przy tworzeniu licznika energii elektrycznej wybierz typ taryfy (jednostrefowy, dwustrefowy lub trzystrefowy).
Przy wprowadzaniu odczytów wybierz strefę taryfową, jeśli licznik jest wielostrefowy.
Współczynniki taryf (100%, 50%, 150% itp.) są stosowane do obliczania kosztów.

REST API

Pobieraj informacje o strefach taryfowych przez REST API:

GET /api/v1/tariff-zones?country=UA&expense_type_id=3
GET /api/v1/tariff-zones/tariff-types?country=UA&expense_type_id=3
GET /api/v1/tariff-zones/by-tariff-type?country=UA&expense_type_id=3&tariff_type=TWO_ZONE
GET /api/v1/tariff-zones/has-zones?country=UA&expense_type_id=3

Przykładowa odpowiedź

{
  "tariff_zones": [
    {
      "id": 2,
      "zone_code": "DAY",
      "name": {
        "en": "Day",
        "uk": "День",
        "ru": "День",
        "pl": "Dzień"
      },
      "description": {
        "en": "07:00–23:00 (100% of tariff)",
        ...
      },
      "coefficient": 100,
      "time_ranges": [{"from": "07:00", "to": "23:00"}],
      "meter_index": "T1",
      "tariff_type": "TWO_ZONE"
    },
    {
      "id": 3,
      "zone_code": "NIGHT",
      "name": {"en": "Night", ...},
      "coefficient": 50,
      "time_ranges": [{"from": "23:00", "to": "07:00"}],
      "meter_index": "T2",
      "tariff_type": "TWO_ZONE"
    }
  ],
  "total": 2
}

Swagger / OpenAPI

Pełna dokumentacja API jest dostępna w Swagger UI: /api/v1/doc