---
tags: KCN
---
# **KCN Savings Calculator API** `v1.0.0`
API zpracovává kalkulace cenových nabídek pro zákazníky.
* [Verze](#Verze)
* [Vlastnosti](#Vlastnosti)
* [Chyby](#Chyby:)
* [Číselníky](#Číselníky)
* [Cílový systém](#Cílový-systém)
* [Šablona](#Šablona)
* [Stát](#Stát)
* [Komodita](#Komodita)
* [Segment](#Segment)
* [EndPoints](#EndPoints)
* [/list/last-change](#/list/last-change)
* [/list/bonus](#/list/bonus)
* [/list/household](#/list/household)
* [/list/accounting-area](#/list/accounting-area)
* [/list/measure-unit](#/list/measure-unit)
* [/list/rate](#/list/rate)
* [/list/circuit-breaker](#/list/circuit-breaker)
* [/list/distributor](#/list/distributor)
* [/list/supplier](#/list/supplier)
* [/list/supplier-line](#/list/supplier-line)
* [/list/supplier-line-without-price](#/list/supplier-line-without-price)
* [/price/electricity](#/price/electricity)
* [/price/gas](#/price/gas)
* [/price/calculate](#/price/calculate)
* [/price/monthly-advance](#/price/monthly-advance)
* [/price/type-of-use](#/price/type-of-use)
---
## **Verze:**
Aktualizace 1.7.2021
### **1.0.0** Základní popis rozhraní
---
## **Vlasnosti:**
### **Umístění API**
#### **TEST** prostředí
* Lokální síť: https://calculator.test.ux.bee.corp/api/v1
* Externí zóna: https://apitest.bohemiaenergy.cz/calculator
#### **PROD** prostředí
* Lokální síť: https://calculator.services.bee.corp/api/v1
* Externí zóna: https://api.bohemiaenergy.cz/calculator
---
### **Ověření přístupu k API**
Ověření je řešeno pomocí `API-KEY` vloženého do hlavičky
* `Authorization: Bearer <API-KEY>`
V případě použití přístupu z externí zóny, je nutné ještě navíc přístupový `PROXY-KEY` pro `Proxy` umístěný do hlavičky
* `X-APP-KEY: <PROXY-KEY>`
---
### **Vlasnosti API:**
Společné vlastnosti jednotlivých EndPoint
* **URL** `Odpovídá názvu EndPoint`
* **Metoda** `POST`
* **Požadavek:** `application/json` bez vnořených objektů
* **Odpověď** `application/json` strukturovaný s objektem odpovědi
* **Date** `string`
`Prvek požadavku Datum specifikuje referenční datum, ke kterému se mají data načíst.`
`Parametr je nepovinný s nezadanou hodnotou interpretovanou jako aktuální datum bez času.`
`Zavedemím MDS příznaku Validity je funkčost omezena. Načítají se pouze aktuálně platné Ceníky a produktové Řady.`
* **RequestId** `string`
`Odpověď obsahuje prvek RequestId, pod kterým je požadavek i odpověď logována.`
`Na základě RequestId lze tedy dohled vstup a opovídající výstup z API.`
* **UnixTimeStamp** `timestamp`
`Odpověď pro číslelníky (list) obsahuje prvek UnixTimeStamp obsahující Unix timestamp (od 1.1.1970)) indentfikující datum a čas poslední změny záznamu.`
`Lze využít při selektivní aktualizaci cílových číselníků.`
---
### **Systémové parametry:**
Pro `API-KEY` jsou definovány výchozí systémové paramtry.
**Jejich hodnoty mají přednost před hodnotami předanými prostřednictvím API.**
Každé `API-KEY` má definován minimálně systémový parametr `TargetSystemId`.
Webové kalkulačky obsahují navíc systémové parametry `StateId` a `AccountingArea`.
Hodnoty systémových parametrů nastavuje správce aplikace.
---
### **Vysvětlivky:**
* ==*== - povinné položky
* [color=#ff4500] - další informace na konci dokumentu v Příloze
---
## **Chyby:**
#### **V případě jakékoliv chyby je vráceno například:**
```json=
{
"EequestID": "b59fb26d-89df-4fea-9560-0dc3379eda82",
"Error": {
"Code": "MISSING_MANDATORY_DATA",
"Message": "Missing mandatory nodes: entity"
}
}
```
#### **Popis:**
* **RequestID** `string` - interní ID, pod kterým je provedeno zalogování požadavku, vhodné logovat i na straně aplikace pro případné hledání problémů
* **error** `object` - objekt s tělem chyby
* **code** `string` - označení chyby, strojově zpracovatelný kód
* **message** `string` - doplňující popis chyby, většinou předávaná hodnota z dalších systémů nebo lidsky čitelná podoba chyby
### **Seznam kódů**
| Code | Message | Data | Popis |
| --------------------------- | -------------------------------------- |:----:| ----- |
| `INVALID_INPUT_JSON` | Chyba z parseru | - | Vstupní data nejsou validní JSON formát |
| `MISSING_MANDATORY_DATA` | List chybějících polí vstupních dat | - | Kontrola vstupních dat, kontrola povinných položek a jejich struktury, případně validita stupních dat |
| `DB_INTERNAL_ERROR` | | - | Vnitřní chyba databáze, chyba není eskalovaná, je logovaná pouze interně |
**Způsob reportování chyb je u všech endpointů stejný. Dále nebude popisován.**
---
## **Číselníky:**
### **Cílový systém**
Systémový číselník jehož hodnota je pevně svázána s `API-KEY`.
Určuje množinu povolených dat a u některých EndPoint určuje množinu parametrů požadavku a jejich povinnost.
| TargetSystemId | TargetSystem |
|----------------|-------------------|
| 1 | Webové kalkulačky |
| 2 | Partnerský portál |
### **Šablona**
Systémová definice formátu výstupu nabídky aktuálně pevně svázáná s `API-KEY` a `TargetSystemId`. `TemplateId` je v případě potřeby umožní definovat více výstupních formátů nabídky v rámci jednoho Zdrojového systému nebo sdílet shodnou Šablonu více Cílovými systémy. [Šablona](#Šablona)
.
| TemplateId | TargetSystemId | TeplateDescription |
|------------|----------------|----------------------------------------------------------------------------|
| 1 | 1 | Jednoduchý objekt s celkovými ročními cenami, dodavateli a názvy produktů |
| 2 | 2 | Struktura objektů odpovídající tabulce PDF nabídky PP |
### **Stát**
| StateId | StateName |
| --------|-----------------|
| 0 | Nespecifikováno |
| 1 | Česká republika |
| 2 | Slovensko |
### **Komodita**
| CommodityId | CommodityName |
|-------------|-----------------|
| 0 | Nespecifikováno |
| 1 | Elektřina |
| 2 | Plyn |
### **Segment**
| CommodityId | CommodityName |
|-------------|------------------|
| 0 | Nespecifikováno |
| 1 | Domácnosti |
| 2 | Firmy |
| 3 | Malý podnik (SK) |
| 4 | Velký podnik (SK)|
### **Typ využití**
| UseTypeId | UseTypeName |
|-----------|------------------|
| 0 | nic |
| 1 | elektřina |
| 2 | plyn |
| 3 | elektřina a plyn |
---
## **EndPoints:**
### **/list/last-change**
Datum poslední aktualizace jednotlivých číselníků.
#### **Požadavek:**
> [name=ovlasek] Připravuji načtení vybraného seznamu EndPoints
* **EndPoints** `array of objects` - objekt se seznamem číselníků k načtení
* **EndPoint** `string` - Název EndPoint
#### **Odpověď:**
* **LastChanges** `array of objects` - objekt se seznamem číselníků
* **EndPoint** `string` - Název EndPoint
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny číselníku
* **LastChange** `string` - Datum a čas ve formátu `ISO 8601`
---
#### Příklad:
##### Požadavek:
```json=
{}
```
##### Odpověď:
```json=
{
"RequestId": "TEST List/last-change",
"LastChanges": [
{
"EndPoint": "list/circuit-breaker",
"UnixTimeStamp": 1621042417,
"LastChange": "2021-05-15T01:33:37.987"
},
{
"EndPoint": "list/measure-unit",
"UnixTimeStamp": 1620916969,
"LastChange": "2021-05-13T14:42:49.403"
},
{
"EndPoint": "list/rate",
"UnixTimeStamp": 1621042421,
"LastChange": "2021-05-15T01:33:41.607"
},
...
]
}
```
---
---
### **/list/bonus**
Číselík poskytovaných bonusů
> [name=ovlasek] Aktuálně vrací pevně definovanou hodnotu 500,- Kč. Připravuje se obecná MDS definice, která si pravděpodobně vyžádá rozšíření EndPoint.
#### **Požadavek:**
Bez parametrů
#### **Odpověď:**
* **Bonuses** `array of objects` - objekt se seznamem bonusů
* **BonusId** `int` - ID
* **BonusName** `string` - Název bonusu
* **BonusValue** `float` - Hodnota bonusu
* **UnixTimeStamp** `timestamp` - Unix timestamp od kdy je definice bonusů platná
---
#### **Příklad:**
##### Požadavek:
```json=
{}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/bonus",
"Bonuses": [
{
"BonusId": 1,
"BonusName": "Bonus 500 Kč",
"BonusValue": 500,
"UnixTimeStamp": 1621987200
}
]
}
```
---
### **/list/household**
Číselík domácností dle typu/velikosti pro určení orientační spotřeby
#### **Požadavek:**
Bez parametrů
#### **Odpověď:**
* **Households** `array of objects` - objekt se seznamem rozdělení domácností
* **HouseholdId** `int` - Id
* **~~HouseholdCode~~** `string` [name=ovlasek] Ke zrušení, obsahuje shodnou hodnotu jako Id.
* **HouseholdName** `string` - Název
* **SegmentId** `int` - [Segment](#Segment)
* **SegmentName** `string` - Název Segmentu
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:**
##### Požadavek:
```json=
{}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/household",
"Households": [
{
"HouseholdId": 1,
"HouseholdCode": "Malý byt",
"HouseholdName": "Malý byt",
"SegmentId": 1,
"SegmentName": "Domácnosti",
"UnixTimeStamp": 1611739022
},
{
"HouseholdId": 2,
"HouseholdCode": "Velký byt",
"HouseholdName": "Velký byt",
"SegmentId": 1,
"SegmentName": "Domácnosti",
"UnixTimeStamp": 1611739022
},
{
"HouseholdId": 3,
"HouseholdCode": "Dům",
"HouseholdName": "Dům",
"SegmentId": 1,
"SegmentName": "Domácnosti",
"UnixTimeStamp": 1611739022
},
{
"HouseholdId": 4,
"HouseholdCode": "Chata",
"HouseholdName": "Chata",
"SegmentId": 1,
"SegmentName": "Domácnosti",
"UnixTimeStamp": 1611739022
}
]
}
```
---
### **/list/accounting-area**
Číselník Účetních okruhů
V Požadavcích odakzujících se na Účetní okruh se předává AccountingAreaName.
#### **Požadavek:**
* **StateId** `int` - [Stát](#Stát)
#### **Odpověď:**
* **AccountingAreas** `array of objects` - objekt se seznamem Účetních okruhů
* **AccountingAreaId** `int` - Id
* **AccountingAreaName** `string` - Zkratka Účetního okruhu předávaná v rámci požadavků
* **StateId** `int` - [Stát](#Stát)
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:**
##### Požadavek:
```json=
{"StateId":1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/accounting-area",
"AccountingAreas": [
{
"AccountingAreaId": 1,
"AccountingAreaName": "BEE",
"SteteId": 1,
"UnixTimeStamp": 1621042399
},
{
"AccountingAreaId": 12,
"AccountingAreaName": "ECS",
"SteteId": 1,
"UnixTimeStamp": 1622524401
},
{
"AccountingAreaId": 5,
"AccountingAreaName": "3E",
"SteteId": 1,
"UnixTimeStamp": 1621042399
},
{
"AccountingAreaId": 7,
"AccountingAreaName": "AM",
"SteteId": 1,
"UnixTimeStamp": 1621042399
},
...
]
}
```
---
### **/list/measure-unit**
Číselník Měrných jednotek s příznaky jednotky spotřeby elektiřny, plynu a stálých platů
#### **Požadavek:**
* **CommodityId** `int` - [Komodita](#Komodita)
#### **Odpověď:**
* **MeasureUnits** `array of objects` - objekt se seznamem měrných jednotek
* **MeasureUnitId** `int` - Id
* **MeasureUnitCode** `string` - Zkratka měrné jednotky
* **MeasureUnitName** `string` - Název
* **ConsumptionElectricity** `bool` - Příznak měrné jednotky spotřeby elektřiny
* **ConsumptionGas** `bool` - Příznak měrné jednotky spotřeby plynu
* **FixedPayment** `bool` - Příznak měrné jednotky stálého platu
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu platná
---
#### **Příklad:**
##### Požadavek:
```json=
{"CommodityId":1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/measure-unit",
"MeasureUnits": [
{
"MeasureUnitId": 4,
"MeasureUnitCode": "kWh",
"MeasureUnitName": "kilowatthodina",
"ConsumptionElectricity": true,
"ConsumptionGas": true,
"FixedPayment": false,
"UnixTimeStamp": 1620916969
},
{
"MeasureUnitId": 5,
"MeasureUnitCode": "MWh",
"MeasureUnitName": "megawatthodina",
"ConsumptionElectricity": true,
"ConsumptionGas": true,
"FixedPayment": false,
"UnixTimeStamp": 1620916969
}
]
}
```
---
### **/list/rate**
Číselník Distribučních sazeb elektřiny a Pásem spotřeb plynu
#### **Požadavek:**
* **StateId** `int` - [Stát](#Stát)
* **CommodityId** `int` - [Komodita](#Komodita)
* **SegmentId** `int` - [Segment](#Segment)
* **Date** `string` - Platnost záznamů
#### **Odpověď:**
* **Rates** `array of objects` - objekt se seznamem distribučních sazeb
* **RateId** `int` - Id
* **RateName** `string` - Název
* **RateNT** `bool` - Příznak Distribuční sazby s Nízkým Tarifem
* **ZoneFrom** `int` - Počátek pásma spotřeby plynu
* **ZoneTo** `int` - Konec pásma spotřeby plynu
* **StateId** `int` - [Stát](#Stát)
* **CommodityId** `int` - [Komodita](#Komodita)
* **SegmentId** `int` - [Segment](#Segment)
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### Příklad:
##### Požadavek:
```json=
{"StateId":1,"CommodityId":1,"SegmentId":1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/rate",
"Rates": [
{
"RateId": 56,
"RateName": "D01d",
"RateNT": false,
"StateId": 1,
"CommodityId": 1,
"SegmentId": 1,
"UnixTimeStamp": 1621042421
},
{
"RateId": 59,
"RateName": "D02d",
"RateNT": false,
"StateId": 1,
"CommodityId": 1,
"SegmentId": 1,
"UnixTimeStamp": 1621042421
},
{
"RateId": 68,
"RateName": "D25d",
"RateNT": true,
"StateId": 1,
"CommodityId": 1,
"SegmentId": 1,
"UnixTimeStamp": 1621042421
},
...
]
}
```
---
### **/list/circuit-breaker**
Číselík velikostí hlavních jističů
#### **Požadavek:**
* **StateId** `int` - [Stát](#Stát)
* **Date** `string` - Platnost záznamů
#### **Odpověď:**
* **CircuitBreakers** `array of objects` - objekt se seznamem hlavních jističů
* **TariffId** `int` - Id
* **~~TariffCode~~** `string` [name=ovlasek] Ke zrušení, obsahuje shodnou hodnotu jako Id.
* **TariffName** `string` - Název
* **TariffPhases** `int` - Počet fází
* **ZoneFrom** `int` - Spodní hranice velikosti hlavního jističe
* **ZoneTo** `int` - Horni hranice velikosti hlavního jističe
* **StateId** `int` - [Stát](#Stát)
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:**
##### Požadavek:
```json=
{"StateId": 1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/circuit-breaker",
"CircuitBreakers": [
{
"TariffId": 9,
"TariffCode": "do 1x25 A",
"TariffName": "do 1x25 A",
"TariffPhases": 1,
"ZoneFrom": 0,
"ZoneTo": 25,
"StateId": 1,
"UnixTimeStamp": 1621042417
},
{
"TariffId": 21,
"TariffCode": "nad 1x25 A za 1 A",
"TariffName": "nad 1x25 A za 1 A",
"TariffPhases": 1,
"ZoneFrom": 25,
"StateId": 1,
"UnixTimeStamp": 1621042417
},
{
"TariffId": 11,
"TariffCode": "do 3x10 A",
"TariffName": "do 3x10 A",
"TariffPhases": 3,
"ZoneFrom": 0,
"ZoneTo": 10,
"StateId": 1,
"UnixTimeStamp": 1621042417
},
...
]
}
```
---
### **/list/distributor**
Číselík Distributorů (distribučních území)
* Distributoři s rozlišením Komodity
* Distributoři pro zadané PSČ
* Distributor pro zadané PSČ a Komoditu
#### **Požadavek:**
* **StateId** `int` - [Stát](#Stát)
* **CommodityId** `int` - [Komodita](#Komodita)
* **DistributorId** `int` - Id Distributora (data pro zadané Id)
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
#### **Odpověď:**
* **Distributors** `array of objects` - objekt se seznamem Distributorů
* **~~Id~~** `int` [name=ovlasek] Ke zrušení, nahrazeno DistributorId.
* **~~ZisId~~** `int` [name=ovlasek] Ke zrušení, nahrazeno DistributorId.
* **~~Name~~** `string` [name=ovlasek] Ke zrušení, nahrazeno DistributorName.
* **DistributorId** `int` Id Distributora
* **DistributorZisId** `int` ZIS Id Distributora
* **DistributorName** `string` Název Distributora
* **StateId** `int` - [Stát](#Stát)
* **CommodityId** `int` - [Komodita](#Komodita)
* **Electricity** `bool` - Příznak Distributora elektřiny
* **Gas** `bool` - Příznak Distributora plynu
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:**
##### Požadavek:
```json=
{"ZIP":"12000","CommodityId":1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/distributor",
"Distributors": [
{
"Id": 329,
"ZisId": 748787,
"Name": "PREdistribuce, a.s.",
"DistributorId": 329,
"DistributorZisId": 748787,
"DistributorName": "PREdistribuce, a.s.",
"StateId": 1,
"CommodityId": 1,
"Electricity": true,
"Gas": false,
"UnixTimeStamp": 1621606213
}
]
}
```
---
### **/list/supplier**
Číselník dodavatelů včetně dodavatelů ze skupiny BEE (Účetních okruhu)
* Dodavatelé pro Účetní okruh, Komoditu, Segment a PSČ nebo Distributora z MDS matice (Webové kalkulačky)
* Dodavatelé s možností omezení dle Země (Partnerský portál)
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) podmíňuje definici Požadvku i Odpovědi
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* **CommodityId** `int` - [Komodita](#Komodita)
* **SegmentId** `int` - [Segment](#Segment)
* **DistributorId** `int` - [Distributor](/list/distributor)
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* **Date** `string` - Platnost MDS definice
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) podmíňuje definici Požadvku i Odpovědi
* **StateId** `int` - [Stát](#Stát)
#### **Odpověď:** [TargetSystemId = 1](#Cílový-systém)
* **Suppliers** `array of objects` - objekt se seznamem Dodavatelů
* **StateId** `int` - [Stát](#Stát)
* **DistributorId** `int` - [Distributor](/list/distributor)
* **DistributorName** `string` Název Distributora
* **SupplierId** `int` Id Dodavatele
* **SupplierName** `string` Název Dodavatele
* **SupplierDefault** `bool` - Příznak výchozího Dodavatele
* **Electricity** `bool` - Příznak Dodavatele elektřiny
* **Gas** `bool` - Příznak Dodavatele plynu
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
#### **Odpověď:** [TargetSystemId = 2](#Cílový-systém)
* **Suppliers** `array of objects` - objekt se seznamem Dodavatelů
* **StateId** `int` - [Stát](#Stát)
* **SupplierId** `int` Id Dodavatele
* **SupplierName** `string` Název Dodavatele
* **Electricity** `bool` - Příznak Dodavatele elektřiny
* **Gas** `bool` - Příznak Dodavatele plynu
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:** [TargetSystemId = 1](#Cílový-systém)
##### Požadavek:
```json=
{"AccountingArea":"3E","CommodityId":1,"SegmentId":1,"ZIP":"12000"}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/supplier",
"Suppliers": [
{
"StateId": 1,
"DistributorId": 329,
"DistributorName": "PREdistribuce, a.s.",
"SupplierId": 109,
"SupplierName": "innogy Energie, s.r.o.",
"SupplierDefault": false,
"Electricity": true,
"Gas": false,
"UnixTimeStamp": 1621336692
},
{
"StateId": 1,
"DistributorId": 329,
"DistributorName": "PREdistribuce, a.s.",
"SupplierId": 327,
"SupplierName": "Pražská energetika, a.s.",
"SupplierDefault": true,
"Electricity": true,
"Gas": false,
"UnixTimeStamp": 1621336692
},
{
"StateId": 1,
"DistributorId": 329,
"DistributorName": "PREdistribuce, a.s.",
"SupplierId": 218,
"SupplierName": "BOHEMIA ENERGY entity s.r.o.",
"SupplierDefault": false,
"Electricity": true,
"Gas": false,
"UnixTimeStamp": 1621581975
},
...
]
}
```
---
#### **Příklad:** [TargetSystemId = 2](#Cílový-systém)
##### Požadavek:
```json=
{"StateId":1}
```
##### Odpověď:
```json=
{
"RequestId": "TEST list/supplier",
"Suppliers": [
{
"StateId": 1,
"SupplierId": 258,
"SupplierName": "Amper Market, a.s.",
"Electricity": true,
"Gas": true,
"UnixTimeStamp": 1621336951
},
{
"StateId": 1,
"SupplierId": 300,
"SupplierName": "ARMEX ENERGY, a.s.",
"Electricity": true,
"Gas": true,
"UnixTimeStamp": 1621336951
},
{
"StateId": 1,
"SupplierId": 307,
"SupplierName": "ČEZ Prodej, a.s.",
"Electricity": true,
"Gas": true,
"UnixTimeStamp": 1621336951
},
...
]
}
```
---
### **/list/supplier-line**
Číselník produktových Řad včetně obchodních Řad Účetních okruhů
* Seznam produktových Řad pro zadaného Dodavatele, Komoditu a PSČ nebo Distributora (Webové kalkulačky)
* Seznam produktových Řad včetně obchodních s možností omezení dle Země (Partnerský portál)
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* **CommodityId** `int` - [Komodita](#Komodita)
* **SegmentId** `int` - [Segment](#Segment)
* **DistributorId** `int` - [Distributor](/list/distributor)
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* **SupplierId** `int` - [Dodavatel](#/list/supplier) (0 = výchozí)
* **Date** `string` - Platnost MDS definice
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* **StateId** `int` - [Stát](#Stát)
* **SupplierLineId** `int` - Produktová Řada => Marketingové texty pro generování nabídky
#### **Odpověď:** [TargetSystemId = 1](#Cílový-systém)
* **SupplierLines** `array of objects` - objekt se seznamem Dodavatelů
* **StateId** `int` - [Stát](#Stát)
* **DistributorId** `int` - [Distributor](/list/distributor)
* **DistributorName** `string` Název Distributora
* **SupplierId** `int` [Dodavatele](#/list/supplier)
* **SupplierName** `string` Název Dodavatele
* **SupplierLineId** `int` Id produktové Řady
* **SupplierLineName** `string` Název produktové Řady
* **Electricity** `bool` - Příznak platného Ceníku elektříny
* **Gas** `bool` - Příznak platného Ceníku plynu
* **Home** `bool` - Příznak platného Ceníku pro Domácnosti
* **Company** `bool` - Příznak platného Ceníku pro Firmy
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
#### **Odpověď:** [TargetSystemId = 2](#Cílový-systém)
* **SupplierLines** `array of objects` - objekt se seznamem Dodavatelů
* **StateId** `int` - [Stát](#Stát)
* **SupplierId** `int` [Dodavatele](#/list/supplier)
* **SupplierName** `string` Název Dodavatele
* **SupplierLineId** `int` Id produktové Řady
* **SupplierLineName** `string` Název produktové Řady
* **ProductLineDescription1** `string` Marketingový text 1 do nabídky
* **ProductLineDescription2** `string` Marketingový text 2 do nabídky
* **ProductLineDescription3** `string` Marketingový text 3 do nabídky
* **Electricity** `bool` - Příznak platného Ceníku elektříny
* **Gas** `bool` - Příznak platného Ceníku plynu
* **Home** `bool` - Příznak platného Ceníku pro Domácnosti
* **Company** `bool` - Příznak platného Ceníku pro Firmy
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad 1:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{"AccountingArea":"3E","CommodityId":1,"SegmentId":1,"ZIP":"12000"}
```
##### Odpověď: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"RequestId": "TEST list/supplier-line",
"SupplierLines": [
{
"StateId": 1,
"AccountingArea": "3E",
"DistributorId": 204,
"DistributorName": "GasNet, s.r.o.",
"SupplierId": 109,
"SupplierName": "innogy Energie, s.r.o.",
"SupplierDefault": true,
"SupplierLineId": 798,
"SupplierLineName": "Standard",
"SupplierLineDefault": true,
"Electricity": false,
"Gas": true,
"Home": true,
"Company": false,
"UnixTimeStamp": 1621336692
},
{
"StateId": 1,
"AccountingArea": "3E",
"DistributorId": 346,
"DistributorName": "ČEZ Distribuce, a. s.",
"SupplierId": 307,
"SupplierName": "ČEZ Prodej, a.s.",
"SupplierDefault": true,
"SupplierLineId": 286,
"SupplierLineName": "Elektřina na dobu neurčitou",
"SupplierLineDefault": true,
"Electricity": true,
"Gas": false,
"Home": true,
"Company": true,
"UnixTimeStamp": 1621336692
},
...
]
}
```
---
#### **Příklad 2:**
##### Požadavek: [TargetSystemId = 2](#Cílový-systém)
```json=
{}
```
##### Odpověď: [TargetSystemId = 2](#Cílový-systém)
```json=
{
"RequestId": "TEST list/supplier-line",
"SupplierLines": [
{
"StateId": 1,
"SupplierId": 300,
"SupplierName": "ARMEX ENERGY, a.s.",
"SupplierLineId": 1038,
"SupplierLineName": "Základní produktová řada",
"Electricity": true,
"Gas": true,
"Home": true,
"Company": true,
"UnixTimeStamp": 1621313800
},
{
"StateId": 1,
"AccountingArea": "BEE",
"SupplierId": 218,
"SupplierName": "BOHEMIA ENERGY entity s.r.o.",
"SupplierLineId": 80,
"SupplierLineName": "BE RELAX",
"Electricity": true,
"Gas": true,
"Home": true,
"Company": false,
"UnixTimeStamp": 1624553035
},
{
"StateId": 1,
"SupplierId": 304,
"SupplierName": "CENTROPOL ENERGY, a.s.",
"SupplierLineId": 308,
"SupplierLineName": "E-MOJE ENERGIE",
"Electricity": true,
"Gas": false,
"Home": true,
"Company": false,
"UnixTimeStamp": 1621313800
},
...
]
}
```
---
### **/list/supplier-line-without-price**
Seznam produktových Řad s neuvedenými (interní ceníky) nebo nulovými cenami za komoditu.
Zaměrně jsou ze seznamu vyloučeny záznamy s nulovými stálými platy, kde to může být obchodní záměr.
EndPoint je primárně určen pro [TargetSystemId = 2](#Cílový-systém).
#### **Požadavek:**
* **StateId** `int` - [Stát](#Stát)
#### **Odpověď:** [TargetSystemId = 2](#Cílový-systém)
Při absenci ceníku Odpověď obsahuje jen SupplierLineId, CommodityId, SegmentId a DistributorId.
* **SupplierLines** `array of objects` - objekt se seznamem Dodavatelů
* **SupplierLineId** `int` [produktová Řada](#/list/supplier-line)
* **CommodityId** `int` - [Komodita](#Komodita)
* **SegmentId** `int` - [Segment](#Segment)
* **DistributorId** `int` - [Distributor](/list/distributor)
* **RateId** `int`- [Distribuční sazba](#/list/rate)
* **~~TariffType~~** `int`- VT / NT (jen elektřina) [name=ovlasek] 11.6.2021 zrušeno na základě závěrů z konzultace s eMan.
* **UnixTimeStamp** `timestamp` - Unix timestamp poslední změny záznamu
---
#### **Příklad:**
##### Požadavek: [TargetSystemId = 2](#Cílový-systém)
```json=
{"StateId":1}
```
##### Odpověď: [TargetSystemId = 2](#Cílový-systém)
```json=
{
"RequestId": "TEST list/supplier-line-without-price",
"SupplierLines": [
{
"SupplierLineId": 802,
"ComodityId": 1,
"SegmentId": 1,
"DistributorId": 100,
"UnixTimeStamp": 1620985500
},
{
"SupplierLineId": 551,
"ComodityId": 1,
"SegmentId": 1,
"DistributorId": 100,
"RateId": 74,
"UnixTimeStamp": 1620985500
},
{
"SupplierLineId": 22,
"ComodityId": 2,
"SegmentId": 1,
"DistributorId": 328,
"RateId": 133,
"UnixTimeStamp": 1620985500
},
...
]
}
```
---
### **/price/electricity**
Kalkulace nabídky pro OPM elektřiny
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* ==**TemplateId**== `int` - [Šablona](#Šablona) specifikuje formát výstupu nabídky
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**SegmentId**== `int` - [Segment](#Segment)
* **BusinessLineId** `int` - Obchodní [produktová Řada](#/list/supplier-line) Účetního okruhu (0 = výchozí)
* **SupplierId** `int` - Současný [Dodavatel](#/list/supplier) (0 = dominant v Distribučním území) (0 = výchozí)
* **SupplierLineId** `int` - Konkurenční [produktová Řada](#/list/supplier-line) [současného Dodavatele](#/list/supplier) (0 = výchozí)
* **SupplierHighTariffPayment** `real` - Konkurenční individuální cena za Vysoký tarif v jednotce definované parametrem ConsumptionHighTariff
* **SupplierLowTariffPayment** `real` - Konkurenční individuální cena za Nízký tarif v jednotce definované parametrem ConsumptionLowTariff
* **SupplierFixedPayment** `real` - Konkurenční individuální cena stálého platu v jednotce definované parametrem SupplierFixedPaymentMeasureUnit
* **SupplierFixedPaymentMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) individuálního konkurenčního stálého platu
* ==**RateId**== `int`- [Distribuční sazba](#/list/rate)
* ==**BreakerTariffId**== `int`- [Tarif hlavního jističe](#/list/circuit-breaker) lze specifikovat Počtem fází a Velikostí hlavního jističe
* **BreakerPhases** `int`- Počet fází hlavního jističe 1 nebo 3
* **BreakerSize** `int`- Velikost hlavního jističe v A (Přesnější výpočet OZE než na základě Tarifu hlavního jističe)
* ==**ConsumptionHighTariff**== `real` - Spotřeba ve vysokém tarifu a definované [měrné jednotce](#/list/measure-unit)
* ==**ConsumptionHighTariffMeasureUnit**== `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby vysokého tarifu např. MWh
* **ConsumptionHighTariffMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby vysokého tarifu je alternativou ke zkratce.
[name=ovlasek] Navrhuji přechod na zkratky a zrušení parametru.
* **ConsumptionLowTariff** `real` - Spotřeba v nízkém tarifu je pro dvoutarifní [Distribuční sazby](#/list/rate) společně s Měrnou jednotkou povinná
* **ConsumptionLowTariffMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby nízkého tarifu např. MWh
* **ConsumptionLowTariffMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby nízkého tarifu je alternativou ke zkratce.
[name=ovlasek] Navrhuji přechod na zkratky a zrušení parametru.
* **~~Date~~** `string` - nabídka k datu => platnost Ceníků
[name=ovlasek] Parametr potlačen v souvislosti se zavedením příznaku Validita Ceníku v KCN.
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* ==**TemplateId**== `int` - [Šablona](#Šablona) specifikuje formát výstupu nabídky
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**BusinessLineId**== `int` - Obchodní [produktová Řada](#/list/supplier-line) Účetního okruhu
* **SupplierLineId** `int` - Konkurenční [produktová Řada](#/list/supplier-line) [současného Dodavatele](#/list/supplier)
* **SupplierHighTariffPayment** `real` - Konkurenční individuální cena za Vysoký tarif v jednotce definované parametrem ConsumptionHighTariff
* **SupplierLowTariffPayment** `real` - Konkurenční individuální cena za Nízký tarif v jednotce definované parametrem ConsumptionLowTariff
* **SupplierFixedPayment** `real` - Konkurenční individuální cena stálého platu v jednotce definované parametrem SupplierFixedPaymentMeasureUnit
* **SupplierFixedPaymentMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) individuálního konkurenčního stálého platu
* ==**RateId**== `int`- [Distribuční sazba](#/list/rate)
* **BreakerTariffId** `int`- [Tarif hlavního jističe](#/list/circuit-breaker)
* ==**BreakerPhases**== `int`- Počet fází hlavního jističe 1 nebo 3 alternativně lze definovat Tarifem hlavního jističe
* ==**BreakerSize**== `int`- Velikost hlavního jističe v A alternativně lze definovat Tarifem hlavního jističe (Přesnější výpočet OZE než na základě Tarifu hlavního jističe)
* ==**ConsumptionHighTariff**== `real` - Spotřeba ve vysokém tarifu a definované [měrné jednotce](#/list/measure-unit)
* ==**ConsumptionHighTariffMeasureUnit**== `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby vysokého tarifu např. MWh
* **ConsumptionHighTariffMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby vysokého tarifu je alternativou ke zkratce.
[name=ovlasek] Navrhuji přechod na zkratky a zrušení parametru.
* **ConsumptionLowTariff** `real` - Spotřeba v nízkém tarifu je pro dvoutarifní [Distribuční sazby](#/list/rate) společně s Měrnou jednotkou povinná
* **ConsumptionLowTariffMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby nízkého tarifu např. MWh
* **ConsumptionLowTariffMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby nízkého tarifu je alternativou ke zkratce.
[name=ovlasek] Navrhuji přechod na zkratky a zrušení parametru.
* **~~Date~~** `string` - nabídka k datu => platnost Ceníků
[name=ovlasek] Parametr potlačen v souvislosti se zavedením příznaku Validita Ceníku v KCN.
#### **Odpověď:** [TemplateId = 1](#Šabloha)
* **Prices** `array of objects` - objekt se seznamem kalkulací nabídek
* **BusinessProductLineName** `string` - Název obchodní [produktové Řady](#/list/supplier-line) Účetního okruhu
* **BusinessPrice** `real` - Nabídková celková roční platba za komoditu včetně DPH Účetního okruhu
* **CompetitionSupplierName** `string` - Název [současného Dodavaele](#/list/supplier)
* **CompetitionProductLineName** `string` - Název konkurenční [produktové Řady](#/list/supplier-line) současného Dodavatele
* **CompetitionPrice** `real` - Celková roční platba za komoditu včetně DPH u současného Dodavatele
* **Savingd** `real` - Roční úspora (CompetitionPrice - BusinessPrice)
* **SavingdPercentage** `real` - Úspora v procentech (((CompetitionPrice / BusinessPrice) - 1) * 100)
* **Rate** `string` - [Distribuční sazba](#/list/rate)
* **CircuitBreaker**`string` - [Tarif hlavního jističe](#/list/circuit-breaker)
* **ConsumptionVTMWh** `real` - Spotřeba ve vysokém tarifu v MWh
* **ConsumptionNTMWh** `real` - Spotřeba v nízkém tarifu v MWh
#### **Odpověď:** [TemplateId = 2](#Šabloha)
* **Prices** `array of objects` - objekt se seznamem kalkulací nabídek
* **Regulated** `objects` - objekt Regulovaných cen
* **PaymentYear** `objects` - objekt Celkových ročních plateb (Základ DPH, Cena včetně DPH)
* **TaxElectricity**`objects` - objekt Daně z elektřiny (Základ DPH, Cena včetně DPH)
* **Business** `objects` - objekt obchodních cen Účetního okruhu
* **CommodityPaymentHighTariffMWh** `objects` - objekt Cen silové elektřiny VT za MWh (Základ DPH, Cena včetně DPH)
* **CommodityPaymentLowTariffMWh** `objects` - objekt Cen silové elektřiny NT za MWh (Základ DPH, Cena včetně DPH)
* **FixedPaymentMonth** `objects` - objekt Stálých měsíčních platů (Základ DPH, Cena včetně DPH)
* **PaymentYear** - `objects` - objekt Celkových ročních plateb obchodníkovi (Základ DPH, Cena včetně DPH)
* **TotalPaymentYear** - `objects` - objekt Celkových ročních plateb včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **CommodityPaymentHighTariffkWh** `objects` - objekt Cen za kWh ve vysokém tarifu včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **CommodityPaymentLowTariffkWh** `objects` - objekt Cen za kWh v nízkém tarifu včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **TotalFixedPaymentMonth** `objects` - objekt Cen měsíčního platu včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **Supplier** `objects` - objekt konkurenčních cen současného Dodavatele se strukturou shodnou s objektem obchodních cen Účetního okruhu není vrácen, pokud není zadáno relevantní SupplierLineId (nabídka bez porovnání).
---
#### **Příklad 1:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"ZIP": "12000",
"BusinessLineId": 234,
"SupplierId": 307,
"SupplierLineId": 286,
"RateId": 70,
"BreakerTariffId": 34,
"ConsumptionHighTariff": 1.5,
"ConsumptionHighTariffMeasureUnit": "MWh",
"ConsumptionLowTariff": 2.5,
"ConsumptionLowTariffMeasureUnit": "MWh"
}
```
##### Odpověď: [TemplateId = 1](#Šabloha)
```json=
{
"RequestId": "TEST price/electricity",
"Prices": [
{
"BusinessProductLineName": "eDomácnost",
"BusinessPrice": 23198.3378,
"CompetitionSupplierName": "ČEZ Prodej, a.s.",
"CompetitionProductLineName": "Elektřina na dobu neurčitou",
"CompetitionPrice": 24431.9328
}
]
}
```
---
#### **Příklad 2:**
##### Požadavek: [TargetSystemId = 2](#Cílový-systém)
```json=
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"DistributorId": 346,
"BusinessLineId": 234,
"SupplierId": 307,
"SupplierLineId": 286,
"RateId": 70,
"BreakerTariffId": 34,
"ConsumptionHighTariff": 1.5,
"ConsumptionHighTariffMeasureUnit": "MWh",
"ConsumptionLowTariff": 2.5,
"ConsumptionLowTariffMeasureUnit": "MWh"
}
```
##### Odpověď:[TemplateId = 2](#Šabloha)
```json=
{
"RequestId": "TEST price/electricity",
"Prices": [
{
"Regulated": {
"PaymentYear": {
"PriceWithoutVAT": 6410.56,
"PriceWithVAT": 7756.7776
},
"TaxElectricity": {
"PriceWithoutVAT": 113.2,
"PriceWithVAT": 136.972
}
},
"Business": {
"CommodityPaymentHighTariffMWh": {
"PriceWithoutVAT": 1425,
"PriceWithVAT": 1724.25
},
"CommodityPaymentLowTariffMWh": {
"PriceWithoutVAT": 1425,
"PriceWithVAT": 1724.25
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 59,
"PriceWithVAT": 71.39
},
"PaymentYear": {
"PriceWithoutVAT": 6408,
"PriceWithVAT": 7753.68
},
"TotalPaymentYear": {
"PriceWithoutVAT": 12931.76,
"PriceWithVAT": 15647.4296
},
"CommodityPaymentHighTariffkWh": {
"PriceWithoutVAT": 2.64441,
"PriceWithVAT": 3.199736
},
"CommodityPaymentLowTariffkWh": {
"PriceWithoutVAT": 2.14921,
"PriceWithVAT": 2.600544
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 289.91,
"PriceWithVAT": 350.7911
}
},
"Supplier": {
"CommodityPaymentHighTariffMWh": {
"PriceWithoutVAT": 1688,
"PriceWithVAT": 2042.48
},
"CommodityPaymentLowTariffMWh": {
"PriceWithoutVAT": 1579,
"PriceWithVAT": 1910.59
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 79,
"PriceWithVAT": 95.59
},
"PaymentYear": {
"PriceWithoutVAT": 7427.5,
"PriceWithVAT": 8987.275
},
"TotalPaymentYear": {
"PriceWithoutVAT": 13951.26,
"PriceWithVAT": 16881.0246
},
"CommodityPaymentHighTariffkWh": {
"PriceWithoutVAT": 2.90741,
"PriceWithVAT": 3.517966
},
"CommodityPaymentLowTariffkWh": {
"PriceWithoutVAT": 2.30321,
"PriceWithVAT": 2.786884
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 309.91,
"PriceWithVAT": 374.9911
}
}
}
]
}
```
---
### **/price/gas**
Kalkulace nabídky pro OPM plynu s podporou individuálních cen konkurence
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* ==**TemplateId**== `int` - [Šablona](#Šablona) specifikuje formát výstupu nabídky
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**SegmentId**== `int` - [Segment](#Segment)
* **BusinessLineId** `int` - Obchodní [produktová Řada](#/list/supplier-line) Účetního okruhu (0 = výchozí)
* **SupplierId** `int` - Současný [Dodavatel](#/list/supplier) (0 = dominant v Distribučním území) (0 = výchozí)
* **SupplierLineId** `int` - Konkurenční [produktová Řada](#/list/supplier-line) [současného Dodavatele](#/list/supplier) (0 = výchozí)
* **SupplierCommodityPayment** `real` - Konkurenční individuální cena za komoditu v jednotce definované parametrem ConsumptionMeasureUnit
* **SupplierFixedPayment** `real` - Konkurenční individuální cena stálého platu v jednotce definované parametrem SupplierFixedPaymentMeasureUnit
* **SupplierFixedPaymentMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) individuálního konkurenčního stálého platu
* ==**Consumption**== `real` - Spotřeba v definované [měrné jednotce](#/list/measure-unit)
* ==**ConsumptionMeasureUnit**== `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby např. kWh
* **ConsumptionMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby je alternativou ke zkratce.
* **~~Date~~** `string` - nabídka k datu => platnost Ceníků
[name=ovlasek] Parametr potlačen v souvislosti se zavedením příznaku Validita Ceníku v KCN.
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**TargetSystemId**== `int` - [Cílový systém](#Cílový-systém) určuje sadu parametrů Požaddavku a jejich povinnost
* ==**TemplateId**== `int` - [Šablona](#Šablona) specifikuje formát výstupu nabídky
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**BusinessLineId**== `int` - Obchodní [produktová Řada](#/list/supplier-line) Účetního okruhu
* **SupplierLineId** `int` - Konkurenční [produktová Řada](#/list/supplier-line) [současného Dodavatele](#/list/supplier)
* **SupplierCommodityPayment** `real` - Konkurenční individuální cena za komoditu v jednotce definované parametrem ConsumptionMeasureUnit
* **SupplierFixedPayment** `real` - Konkurenční individuální cena stálého platu v jednotce definované parametrem SupplierFixedPaymentMeasureUnit
* **SupplierFixedPaymentMeasureUnit** `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) individuálního konkurenčního stálého platu
* ==**Consumption**== `real` - Spotřeba v definované [měrné jednotce](#/list/measure-unit)
* ==**ConsumptionMeasureUnit**== `string` - Kód (zkratka) [Měrné jednotky](#/list/measure-unit) spotřeby např. kWh
* **ConsumptionMeasureUnitId** `int` - Id [Měrné jednotky](#/list/measure-unit) spotřeby je alternativou ke zkratce.
* **~~Date~~** `string` - nabídka k datu => platnost Ceníků
[name=ovlasek] Parametr potlačen v souvislosti se zavedením příznaku Validita Ceníku v KCN.
#### **Odpověď:** [TemplateId = 1](#Šabloha)
* **Prices** `array of objects` - objekt se seznamem kalkulací nabídek
* **BusinessProductLineName** `string` - Název obchodní [produktové Řady](#/list/supplier-line) Účetního okruhu
* **BusinessPrice** `real` - Nabídková celková roční platba za komoditu včetně DPH Účetního okruhu
* **CompetitionSupplierName** `string` - Název [současného Dodavaele](#/list/supplier)
* **CompetitionProductLineName** `string` - Název konkurenční [produktové Řady](#/list/supplier-line) současného Dodavatele
* **CompetitionPrice** `real` - Celková roční platba za komoditu včetně DPH u současného Dodavatele
* **Savingd** `real` - Roční úspora (CompetitionPrice - BusinessPrice)
* **SavingdPercentage** `real` - Úspora v procentech (((CompetitionPrice / BusinessPrice) - 1) * 100)
* **Rate** `string` - [Pásmo spotřeby plynu](#/list/rate)
* **ConsumptionMWh** `real` - Spotřeba v MWh
#### **Odpověď:** [TemplateId = 2](#Šabloha)
* **Prices** `array of objects` - objekt se seznamem kalkulací nabídek
* **Regulated** `objects` - objekt Regulovaných cen
* **PaymentYear** `objects` - objekt Celkových ročních plateb (Základ DPH, Cena včetně DPH)
* **Business** `objects` - objekt obchodních cen Účetního okruhu
* **CommodityPaymentMWh** `objects` - objekt Cen za komoditu v MWh (Základ DPH, Cena včetně DPH)
* **FixedPaymentMonth** `objects` - objekt Stálých měsíčních platů (Základ DPH, Cena včetně DPH)
* **PaymentYear** - `objects` - objekt Celkových ročních plateb obchodníkovi (Základ DPH, Cena včetně DPH)
* **TotalPaymentYear** - `objects` - objekt Celkových ročních plateb včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **CommodityPaymentkWh** `objects` - objekt Cen za komoditu v kWh včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **CommodityPaymentm3** `objects` - objekt Cen za komoditu v m³ včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **TotalFixedPaymentMonth** `objects` - objekt Cen měsíčního platu včetně regulovaných cen (Základ DPH, Cena včetně DPH)
* **Supplier** `objects` - objekt konkurenčních cen současného Dodavatele se strukturou shodnou s objektem obchodních cen Účetního okruhu není vrácen, pokud není zadáno relevantní SupplierLineId (nabídka bez porovnání).
---
#### **Příklad 1:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"AccountingArea": "3E",
"CommodityId": 2,
"SegmentId": 1,
"ZIP": "12000",
"BusinessLineId": 234,
"SupplierId": 109,
"SupplierLineId": 798,
"Consumption": 2500,
"ConsumptionMeasureUnit": "kWh"
}
```
##### Odpověď: [TemplateId = 1](#Šablona)
```json=
{
"RequestId": "TEST price/gas",
"Prices": [
{
"BusinessProductLineName": "eDomácnost",
"BusinessPrice": 7071.8208,
"CompetitionSupplierName": "innogy Energie, s.r.o.",
"CompetitionProductLineName": "Standard",
"CompetitionPrice": 7610.2708
}
]
}
```
---
#### **Příklad 2:**
##### Požadavek: [TargetSystemId = 2](#Cílový-systém)
```json=
{
"StateId": 1,
"AccountingArea": "3E",
"CommodityId": 2,
"SegmentId": 1,
"DistributorId": 204,
"BusinessLineId": 234,
"SupplierId": 109,
"SupplierLineId": 798,
"Consumption": 2500,
"ConsumptionMeasureUnit": "kWh"
}
```
##### Odpověď: [TemplateId = 2](#Šablona)
```json=
{
"RequestId": "TEST price/gas",
"Prices": [
{
"Regulated": {
"PaymentYear": {
"PriceWithoutVAT": 1793.68,
"PriceWithVAT": 2170.3528
}
},
"Business": {
"CommodityPaymentMWh": {
"PriceWithoutVAT": 699,
"PriceWithVAT": 845.79
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 29,
"PriceWithVAT": 35.09
},
"PaymentYear": {
"PriceWithoutVAT": 2095.5,
"PriceWithVAT": 2535.555
},
"TotalPaymentYear": {
"PriceWithoutVAT": 3889.18,
"PriceWithVAT": 4705.9078
},
"CommodityPaymentkWh": {
"PriceWithoutVAT": 0.9466,
"PriceWithVAT": 1.145386
},
"CommodityPaymentm3": {
"PriceWithoutVAT": 9.98663,
"PriceWithVAT": 12.083823
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 126.89,
"PriceWithVAT": 153.5369
}
},
"Supplier": {
"CommodityPaymentMWh": {
"PriceWithoutVAT": 877,
"PriceWithVAT": 1061.17
},
"FixedPaymentMonth": {
"Supplier": {
"PriceWithoutVAT": 29,
"PriceWithVAT": 35.09
}
},
"PaymentYear": {
"PriceWithoutVAT": 2540.5,
"PriceWithVAT": 3074.005
},
"TotalPaymentYear": {
"PriceWithoutVAT": 4334.18,
"PriceWithVAT": 5244.3578
},
"CommodityPaymentkWh": {
"PriceWithoutVAT": 1.1246,
"PriceWithVAT": 1.360766
},
"CommodityPaymentm3": {
"PriceWithoutVAT": 11.86453,
"PriceWithVAT": 14.356082
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 126.89,
"PriceWithVAT": 153.5369
}
}
}
]
}
```
---
### **/price/calculate**
Hromadná kalkulace nabídky pro seznam OPM interně volá dílčí EndPoints dle komodity OPM.
* [/price/electricity](#/price/electricity)
* [/price/gas](#/price/gas)
#### **Požadavek:**
* **ConsumptionPlaces** `array of objects` - objekt se seznamem OPM
Požadavek v poli má shodnou strukturu prvků s dílčími Endpoints komodit.
* [Elektřina](#/price/electricity)
* [Plyn](#/price/gas)
#### **Odpověď:**
* **Prices** `array of objects` - objekt se seznamem cen
Odpověď v poli má shodnou strukturu prvků s dílčími Endpoints komodit.
* [Elektřina](#/price/electricity)
* [Plyn](#/price/gas)
---
#### **Příklad 1:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"ConsumptionPlaces": [
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"DistributorId": 346,
"BusinessLineId": 234,
"SupplierId": 307,
"SupplierLineId": 286,
"RateId": 70,
"BreakerTariffId": 34,
"ConsumptionHighTariff": 1.5,
"ConsumptionHighTariffMeasureUnit": "MWh",
"ConsumptionLowTariff": 2.5,
"ConsumptionLowTariffMeasureUnit": "MWh"
},
{
"AccountingArea": "3E",
"CommodityId": 2,
"SegmentId": 1,
"DistributorId": 204,
"BusinessLineId": 234,
"SupplierId": 109,
"SupplierLineId": 798,
"Consumption": 2500,
"ConsumptionMeasureUnit": "kWh"
}
]
}
```
##### Odpověď: [TemplateId = 1](#Šablona)
```json=
{
"RequestId": "TEST price/calculate",
"Prices": [
{
"BusinessProductLineName": "eDomácnost",
"BusinessPrice": 15647.4297,
"CompetitionSupplierName": "ČEZ Prodej, a.s.",
"CompetitionProductLineName": "Elektřina na dobu neurčitou",
"CompetitionPrice": 16881.0247
},
{
"BusinessProductLineName": "eDomácnost",
"BusinessPrice": 4705.9078,
"CompetitionSupplierName": "innogy Energie, s.r.o.",
"CompetitionProductLineName": "Standard",
"CompetitionPrice": 5244.3578
}
]
}
```
---
#### **Příklad 2:**
##### Požadavek: [TargetSystemId = 2](#Cílový-systém)
```json=
{
"ConsumptionPlaces": [
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"DistributorId": 346,
"BusinessLineId": 234,
"SupplierId": 307,
"SupplierLineId": 286,
"RateId": 70,
"BreakerTariffId": 34,
"ConsumptionHighTariff": 1.5,
"ConsumptionHighTariffMeasureUnit": "MWh",
"ConsumptionLowTariff": 2.5,
"ConsumptionLowTariffMeasureUnit": "MWh"
},
{
"AccountingArea": "3E",
"CommodityId": 2,
"SegmentId": 1,
"DistributorId": 204,
"BusinessLineId": 234,
"SupplierId": 109,
"SupplierLineId": 798,
"Consumption": 2500,
"ConsumptionMeasureUnit": "kWh"
}
]
}
```
##### Odpověď: [TemplateId = 2](#Šablona)
```json=
{
"RequestId": "TEST price/calculate",
"Prices": [
{
"Regulated": {
"PaymentYear": {
"PriceWithoutVAT": 6410.56,
"PriceWithVAT": 7756.7776
},
"TaxElectricity": {
"PriceWithoutVAT": 113.2,
"PriceWithVAT": 136.972
}
},
"Business": {
"CommodityPaymentHighTariffMWh": {
"PriceWithoutVAT": 1425,
"PriceWithVAT": 1724.25
},
"CommodityPaymentLowTariffMWh": {
"PriceWithoutVAT": 1425,
"PriceWithVAT": 1724.25
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 59,
"PriceWithVAT": 71.39
},
"PaymentYear": {
"PriceWithoutVAT": 6408,
"PriceWithVAT": 7753.68
},
"TotalPaymentYear": {
"PriceWithoutVAT": 12931.76,
"PriceWithVAT": 15647.4296
},
"CommodityPaymentHighTariffkWh": {
"PriceWithoutVAT": 2.64441,
"PriceWithVAT": 3.199736
},
"CommodityPaymentLowTariffkWh": {
"PriceWithoutVAT": 2.14921,
"PriceWithVAT": 2.600544
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 289.91,
"PriceWithVAT": 350.7911
}
},
"Supplier": {
"CommodityPaymentHighTariffMWh": {
"PriceWithoutVAT": 1688,
"PriceWithVAT": 2042.48
},
"CommodityPaymentLowTariffMWh": {
"PriceWithoutVAT": 1579,
"PriceWithVAT": 1910.59
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 79,
"PriceWithVAT": 95.59
},
"PaymentYear": {
"PriceWithoutVAT": 7427.5,
"PriceWithVAT": 8987.275
},
"TotalPaymentYear": {
"PriceWithoutVAT": 13951.26,
"PriceWithVAT": 16881.0246
},
"CommodityPaymentHighTariffkWh": {
"PriceWithoutVAT": 2.90741,
"PriceWithVAT": 3.517966
},
"CommodityPaymentLowTariffkWh": {
"PriceWithoutVAT": 2.30321,
"PriceWithVAT": 2.786884
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 309.91,
"PriceWithVAT": 374.9911
}
}
},
{
"Regulated": {
"PaymentYear": {
"PriceWithoutVAT": 1793.68,
"PriceWithVAT": 2170.3528
}
},
"Business": {
"CommodityPaymentMWh": {
"PriceWithoutVAT": 699,
"PriceWithVAT": 845.79
},
"FixedPaymentMonth": {
"PriceWithoutVAT": 29,
"PriceWithVAT": 35.09
},
"PaymentYear": {
"PriceWithoutVAT": 2095.5,
"PriceWithVAT": 2535.555
},
"TotalPaymentYear": {
"PriceWithoutVAT": 3889.18,
"PriceWithVAT": 4705.9078
},
"CommodityPaymentkWh": {
"PriceWithoutVAT": 0.9466,
"PriceWithVAT": 1.145386
},
"CommodityPaymentm3": {
"PriceWithoutVAT": 9.98663,
"PriceWithVAT": 12.083823
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 126.89,
"PriceWithVAT": 153.5369
}
},
"Supplier": {
"CommodityPaymentMWh": {
"PriceWithoutVAT": 877,
"PriceWithVAT": 1061.17
},
"FixedPaymentMonth": {
"Supplier": {
"PriceWithoutVAT": 29,
"PriceWithVAT": 35.09
}
},
"PaymentYear": {
"PriceWithoutVAT": 2540.5,
"PriceWithVAT": 3074.005
},
"TotalPaymentYear": {
"PriceWithoutVAT": 4334.18,
"PriceWithVAT": 5244.3578
},
"CommodityPaymentkWh": {
"PriceWithoutVAT": 1.1246,
"PriceWithVAT": 1.360766
},
"CommodityPaymentm3": {
"PriceWithoutVAT": 11.86453,
"PriceWithVAT": 14.356082
},
"TotalFixedPaymentMonth": {
"PriceWithoutVAT": 126.89,
"PriceWithVAT": 153.5369
}
}
}
]
}
```
---
### **/price/monthly-advance**
Kalkulace nabídky dle výše Měsíční zálohy po doplnění chybějících dat na základě MDS metadat interně volá.
* [/price/electricity](#/price/electricity)
* Spotřeba
* Distribuční sazba
* Velikost hlavního jističe
* Poměr spotřeb VT / NT
* [/price/gas](#/price/gas)
* Spotřeba
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* **BusinessLineId** `int` - Obchodní produktová [Řada](#/list/supplier-line) Účetního okruhu (0 = výchozí)
* ==**CommodityId**== `int` - [Komodita](#Komodita)
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* **SupplierId** `int` - Současný [Dodavatel](#/list/supplier) (0 = Dominant v Distribučním území)
* **SupplierLineId** `int` - Produktová Řada současného Dodavatele (0 = výchozí)
* ==**MonthlyAdvance**== `int` - Výše měsíční zálohy
* **GreenCertificate** `bool` - Příznak požadavku na Zelený certfikát
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**CommodityId**== `int` - [Komodita](#Komodita)
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**BusinessLineId**== `int` - Obchodní produktová [Řada](#/list/supplier-line) Účetního okruhu
* **SupplierLineId** `int` - Produktová Řada současného Dodavatele
* ==**MonthlyAdvance**== `int` - Výše měsíční zálohy
#### **Odpověď:**
Struktura odpovědi v závislosti na [Šabloně](#Šablona) a [Komoditě](#Komodita) viz. vlastní výpočet.
* [Elektřina](#/price/electricity)
* [Plyn](/price/gas)
---
#### **Příklad:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"ZIP": "12000",
"MonthlyAdvance": 1500
}
```
##### Odpověď:
Příklad odpovědi v závislosti na [TemplateId](#Šabloně) a [Komoditě](#Komodita) viz. vlastní výpočet.
* [Elektřina](#/price/electricity)
* [Plyn](#/price/gas)
---
### **/price/type-of-use**
Kalkulace nabídky dle [Velikosti odběratele](#/list/household) a [Typu využití](#Typ-využití) komodit po doplnění chybějících dat na základě MDS metadat interně volá.
* [/price/electricity](#/price/electricity)
* Spotřeba
* Distribuční sazba
* Velikost hlavního jističe
* Poměr spotřeb VT / NT
* [/price/gas](#/price/gas)
* Spotřeba
#### **Požadavek:** [TargetSystemId = 1](#Cílový-systém)
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* **BusinessLineId** `int` - Obchodní produktová [Řada](#/list/supplier-line) Účetního okruhu (0 = výchozí)
* ==**CommodityId**== `int` - [Komodita](#Komodita)
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* **SupplierId** `int` - Současný [Dodavatel](#/list/supplier) (0 = Dominant v Distribučním území)
* **SupplierLineId** `int` - Produktová Řada současného Dodavatele (0 = výchozí)
* ==**HouseholdId**== `int` - [Velikost odběratele](#/list/household)
* **Lighting** `int` - Svícení - [Typ využití](#Typ-využití) 0 a 1
* **Cooking** `int` - Vaření - [Typ využití](#Typ-využití) 0 až 3
* **Heating** `int` - Topení - [Typ využití](#Typ-využití) 0 až 3
* **WaterHeating** `int` - Ohřev vody - [Typ využití](#Typ-využití) 0 až 3
* **HeatPump** `int` - Tepelné čerpadlo - [Typ využití](#Typ-využití) 0 a 1
* **GreenCertificate** `bool` - Příznak požadavku na Zelený certfikát
#### **Požadavek:** [TargetSystemId = 2](#Cílový-systém)
* ==**AccountingArea**== `string` - Zkratka Účetního okruhu
* **StateId** `int` - [Stát](#Stát) definuje Účetníh okruh.
* ==**CommodityId**== `int` - [Komodita](#Komodita)
* ==**SegmentId**== `int` - [Segment](#Segment)
* ==**DistributorId**== `int` - Distributor nemusí být zadán, pokud je zadané PSČ
* **ZIP** `string` - PSČ ve formátu ##### nebo ### ##
* ==**BusinessLineId**== `int` - Obchodní produktová [Řada](#/list/supplier-line) Účetního okruhu
* **SupplierLineId** `int` - Produktová Řada současného Dodavatele
* ==**HouseholdId**== `int` - [Velikost odběratele](#/list/household)
* **Lighting** `int` - Svícení - [Typ využití](#Typ-využití) 0 a 1
* **Cooking** `int` - Vaření - [Typ využití](#Typ-využití) 0 až 3
* **Heating** `int` - Topení - [Typ využití](#Typ-využití) 0 až 3
* **WaterHeating** `int` - Ohřev vody - [Typ využití](#Typ-využití) 0 až 3
* **HeatPump** `int` - Tepelné čerpadlo - [Typ využití](#Typ-využití) 0 a 1
* **GreenCertificate** `bool` - Příznak požadavku na Zelený certfikát
#### **Odpověď:**
Struktura odpovědi v závislosti na [Šabloně](#Šablona) a [Komoditě](#Komodita) viz. vlastní výpočet.
* [Elektřina](#/price/electricity)
* [Plyn](#/price/gas)
---
#### **Příklad:**
##### Požadavek: [TargetSystemId = 1](#Cílový-systém)
```json=
{
"AccountingArea": "3E",
"CommodityId": 1,
"SegmentId": 1,
"ZIP": "12000",
"HouseholdId": 3,
"Lighting": 1,
"Cooking": 3,
"Heating": 2,
"WaterHeating": 1
}
```
##### Odpověď:
Příklad odpovědi v závislosti na [TemplateId](#Šabloně) a [Komoditě](#Komodita) viz. vlastní výpočet.
* [Elektřina](#/price/electricity)
* [Plyn](#/price/gas)
---
Sign in with Wallet
Connect another wallet