POST api/EnergyPrices/CalculatePrices/Electricity

Request Information

Requires Authorization!

Add to HTTP Headers "Authorization" => "Bearer " + access_token from api/User/LoginWithApiKEY?ApiKEY={ApiKEY}
for example: "Authorization" => "Bearer aBc123-D1eF3...rS45q-XyZ879"

URI Parameters

None.

Body Parameters

EnergyPrices_ElectricityPricesQueryModel
NameTypeAdditional informationDescription
UsageHT integer

Required

UsageNT integer

None.

VoltageLevel integer

None.

OverWrite_Provision decimal number

None.

Check_MinValues boolean

None.

HPFC_UsageProfileId integer

None.

TariffId integer

Required

SignatureDate date

Required

DateFrom date

Required

DateTo date

Required

TradeId integer

None.

Request Formats

application/json, text/json

Sample:
{
  "UsageHT": 1,
  "UsageNT": 1,
  "VoltageLevel": 1,
  "OverWrite_Provision": 1.0,
  "Check_MinValues": true,
  "HPFC_UsageProfileId": 1,
  "TariffId": 3,
  "SignatureDate": "2025-12-06T05:50:03.0246764+01:00",
  "DateFrom": "2025-12-06T05:50:03.0246764+01:00",
  "DateTo": "2025-12-06T05:50:03.0246764+01:00",
  "TradeId": 7
}

application/xml, text/xml

Sample:
<EnergyPrices_ElectricityPricesQueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Energy">
  <DateFrom>2025-12-06T05:50:03.0246764+01:00</DateFrom>
  <DateTo>2025-12-06T05:50:03.0246764+01:00</DateTo>
  <SignatureDate>2025-12-06T05:50:03.0246764+01:00</SignatureDate>
  <TariffId>3</TariffId>
  <TradeId>7</TradeId>
  <Check_MinValues>true</Check_MinValues>
  <HPFC_UsageProfileId>1</HPFC_UsageProfileId>
  <OverWrite_Provision>1</OverWrite_Provision>
  <UsageHT>1</UsageHT>
  <UsageNT>1</UsageNT>
  <VoltageLevel>1</VoltageLevel>
</EnergyPrices_ElectricityPricesQueryModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EnergyPrices_PricesResultModel
NameTypeAdditional informationDescription
ContractLenght integer

None.

Price_Base decimal number

None.

Price_HT decimal number

None.

Price_NT decimal number

None.

Unit_Price_HT decimal number

None.

Unit_Price_NT decimal number

None.

Provision decimal number

None.

FixedProvision decimal number

None.

DebugInfo Collection of string

None.

L_Gas decimal number

None.

L_Gas_Addon decimal number

None.

Price_H_Gas decimal number

None.

Price_L_Gas decimal number

None.

Service_Price_HT decimal number

None.

Service_Price_NT decimal number

None.

CalculatedPrices CalculatedEnergyPricesData

None.

PricesForYears boolean

None.

LowerPriceMonths integer

None.

LowerPricePercent decimal number

None.

LowerPriceUnitPrice decimal number

None.

LowerPriceTotalYearyCost decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "ContractLenght": 1,
  "Price_Base": 1.0,
  "Price_HT": 2.0,
  "Price_NT": 1.0,
  "Unit_Price_HT": 3.0,
  "Unit_Price_NT": 1.0,
  "Provision": 1.0,
  "FixedProvision": 1.0,
  "DebugInfo": [
    "sample string 1",
    "sample string 2"
  ],
  "L_Gas": 1.0,
  "L_Gas_Addon": 1.0,
  "Price_H_Gas": 1.0,
  "Price_L_Gas": 1.0,
  "Service_Price_HT": 1.0,
  "Service_Price_NT": 1.0,
  "CalculatedPrices": {
    "Energy_Costs_with_Base_Price": 1.0,
    "Network_charges_Cost_Sum": 71.0,
    "Network_charges_Cost_HT_Sum": 32.0,
    "Network_charges_Cost_NT_Sum": 2.0,
    "State_taxes_Cost_Sum": 69.0,
    "Total_Netto_Cost_Sum": 141.0,
    "VAT_Percent": 0.19,
    "Total_VAT_Cost": 26.79,
    "Total_Brutto_Cost_Sum": 167.79,
    "DebugInfo": "sample string 2",
    "TariffId": 3,
    "Provision": 4.0,
    "UsageProvision": 5.0,
    "EnergyType": "sample string 6",
    "Trade": "sample string 7",
    "ContractDateFrom": "2025-12-06T05:50:03.0408275+01:00",
    "ContractDateTo": "2025-12-06T05:50:03.0408275+01:00",
    "VoltageLevel": 1,
    "PowerPeak": 1,
    "ControlArea": "sample string 10",
    "GasType": "sample string 11",
    "MarketArea": "sample string 12",
    "EnergyCost_AP_HT": 13.0,
    "EnergyCost_AP_NT": 1.0,
    "EnergyCost_GP": 14.0,
    "Cost_AP_HT": 15.0,
    "Cost_AP_NT": 1.0,
    "Cost_AP_ValidFrom": "2025-12-06T05:50:03.0408275+01:00",
    "Cost_GP": 16.0,
    "Cost_Concession_HT": 17.0,
    "Cost_Operation": 18.0,
    "Cost_Operation_ValidFrom": "2025-12-06T05:50:03.0408275+01:00",
    "Cost_Concession_NT": 1.0,
    "Cost_Performance_AP": 1.0,
    "Cost_Performance_GP": 1.0,
    "Cost_Measurement": 1.0,
    "Cost_Measurement_ValidFrom": "2025-12-06T05:50:03.0408275+01:00",
    "Cost_EEG": 1.0,
    "Cost_Delivery": 1.0,
    "Cost_Accounting": 19.0,
    "Cost_SpecialCustomerLocation": 1.0,
    "Cost_Offshore": 1.0,
    "Cost_SwitchingLoad": 1.0,
    "Cost_PeriodOfUse": 1.0,
    "Cost_Tax": 20.0,
    "Cost_CO2_Tax": 21.0,
    "Cost_Allocation_26_EnSiG": 1.0,
    "Cost_Conversion": 1.0,
    "Cost_Storage_allocation": 1.0,
    "Cost_Sum": 22.0,
    "Cost_HT_Sum": 23.0,
    "Cost_NT_Sum": 1.0,
    "Usage_Divider": 1.0,
    "Cost_Sum_Elems": [
      "sample string 1",
      "sample string 2"
    ],
    "FixedContractLenght": 1,
    "IsFixedProvision": true,
    "ProvInType": 64,
    "FolgeInType": 64,
    "ProvOutType": 64,
    "FolgeOutType": 64,
    "LowerPriceTotalYearyCost": 25.0,
    "TradeId": 1,
    "TradeName": "sample string 26",
    "SupplierTradeId": "sample string 27",
    "SupplierTradeName": "sample string 28"
  },
  "PricesForYears": true,
  "LowerPriceMonths": 5,
  "LowerPricePercent": 6.0,
  "LowerPriceUnitPrice": 7.0,
  "LowerPriceTotalYearyCost": 8.0
}

application/xml, text/xml

Sample:
<EnergyPrices_PricesResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Energy">
  <CalculatedPrices xmlns:d2p1="http://schemas.datacontract.org/2004/07/Global_classes.BusinessObject.Orders">
    <d2p1:ContractDateFrom>2025-12-06T05:50:03.0408275+01:00</d2p1:ContractDateFrom>
    <d2p1:ContractDateTo>2025-12-06T05:50:03.0408275+01:00</d2p1:ContractDateTo>
    <d2p1:ControlArea>sample string 10</d2p1:ControlArea>
    <d2p1:Cost_AP_HT>15</d2p1:Cost_AP_HT>
    <d2p1:Cost_AP_NT>1</d2p1:Cost_AP_NT>
    <d2p1:Cost_AP_ValidFrom>2025-12-06T05:50:03.0408275+01:00</d2p1:Cost_AP_ValidFrom>
    <d2p1:Cost_Accounting>19</d2p1:Cost_Accounting>
    <d2p1:Cost_Allocation_26_EnSiG>1</d2p1:Cost_Allocation_26_EnSiG>
    <d2p1:Cost_CO2_Tax>21</d2p1:Cost_CO2_Tax>
    <d2p1:Cost_Concession_HT>17</d2p1:Cost_Concession_HT>
    <d2p1:Cost_Concession_NT>1</d2p1:Cost_Concession_NT>
    <d2p1:Cost_Conversion>1</d2p1:Cost_Conversion>
    <d2p1:Cost_Delivery>1</d2p1:Cost_Delivery>
    <d2p1:Cost_EEG>1</d2p1:Cost_EEG>
    <d2p1:Cost_GP>16</d2p1:Cost_GP>
    <d2p1:Cost_HT_Sum>23</d2p1:Cost_HT_Sum>
    <d2p1:Cost_Measurement>1</d2p1:Cost_Measurement>
    <d2p1:Cost_Measurement_ValidFrom>2025-12-06T05:50:03.0408275+01:00</d2p1:Cost_Measurement_ValidFrom>
    <d2p1:Cost_NT_Sum>1</d2p1:Cost_NT_Sum>
    <d2p1:Cost_Offshore>1</d2p1:Cost_Offshore>
    <d2p1:Cost_Operation>18</d2p1:Cost_Operation>
    <d2p1:Cost_Operation_ValidFrom>2025-12-06T05:50:03.0408275+01:00</d2p1:Cost_Operation_ValidFrom>
    <d2p1:Cost_Performance_AP>1</d2p1:Cost_Performance_AP>
    <d2p1:Cost_Performance_GP>1</d2p1:Cost_Performance_GP>
    <d2p1:Cost_PeriodOfUse>1</d2p1:Cost_PeriodOfUse>
    <d2p1:Cost_SpecialCustomerLocation>1</d2p1:Cost_SpecialCustomerLocation>
    <d2p1:Cost_Storage_allocation>1</d2p1:Cost_Storage_allocation>
    <d2p1:Cost_Sum>22</d2p1:Cost_Sum>
    <d2p1:Cost_Sum_Elems xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Cost_Sum_Elems>
    <d2p1:Cost_SwitchingLoad>1</d2p1:Cost_SwitchingLoad>
    <d2p1:Cost_Tax>20</d2p1:Cost_Tax>
    <d2p1:EnergyCost_AP_HT>13</d2p1:EnergyCost_AP_HT>
    <d2p1:EnergyCost_AP_NT>1</d2p1:EnergyCost_AP_NT>
    <d2p1:EnergyCost_GP>14</d2p1:EnergyCost_GP>
    <d2p1:EnergyType>sample string 6</d2p1:EnergyType>
    <d2p1:FixedContractLenght>1</d2p1:FixedContractLenght>
    <d2p1:FolgeInType>64</d2p1:FolgeInType>
    <d2p1:FolgeOutType>64</d2p1:FolgeOutType>
    <d2p1:GasType>sample string 11</d2p1:GasType>
    <d2p1:IsFixedProvision>true</d2p1:IsFixedProvision>
    <d2p1:LowerPriceTotalYearyCost>25</d2p1:LowerPriceTotalYearyCost>
    <d2p1:MarketArea>sample string 12</d2p1:MarketArea>
    <d2p1:PowerPeak>1</d2p1:PowerPeak>
    <d2p1:ProvInType>64</d2p1:ProvInType>
    <d2p1:ProvOutType>64</d2p1:ProvOutType>
    <d2p1:Provision>4</d2p1:Provision>
    <d2p1:SupplierTradeId>sample string 27</d2p1:SupplierTradeId>
    <d2p1:SupplierTradeName>sample string 28</d2p1:SupplierTradeName>
    <d2p1:TariffId>3</d2p1:TariffId>
    <d2p1:Trade>sample string 7</d2p1:Trade>
    <d2p1:TradeId>1</d2p1:TradeId>
    <d2p1:TradeName>sample string 26</d2p1:TradeName>
    <d2p1:UsageProvision>5</d2p1:UsageProvision>
    <d2p1:Usage_Divider>1</d2p1:Usage_Divider>
    <d2p1:VoltageLevel>1</d2p1:VoltageLevel>
    <d2p1:DebugInfo>sample string 2</d2p1:DebugInfo>
    <d2p1:Energy_Costs_with_Base_Price>1</d2p1:Energy_Costs_with_Base_Price>
  </CalculatedPrices>
  <ContractLenght>1</ContractLenght>
  <DebugInfo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DebugInfo>
  <FixedProvision>1</FixedProvision>
  <FixedProvision_100>1</FixedProvision_100>
  <FixedProvisionkWh_100>1</FixedProvisionkWh_100>
  <L_Gas>1</L_Gas>
  <L_Gas_Addon>1</L_Gas_Addon>
  <LowerPriceMonths>5</LowerPriceMonths>
  <LowerPricePercent>6</LowerPricePercent>
  <LowerPriceTotalYearyCost>8</LowerPriceTotalYearyCost>
  <LowerPriceUnitPrice>7</LowerPriceUnitPrice>
  <Price_Base>1</Price_Base>
  <Price_HT>2</Price_HT>
  <Price_H_Gas>1</Price_H_Gas>
  <Price_L_Gas>1</Price_L_Gas>
  <Price_NT>1</Price_NT>
  <PricesForYears>true</PricesForYears>
  <Provision>1</Provision>
  <Service_Price_HT>1</Service_Price_HT>
  <Service_Price_NT>1</Service_Price_NT>
  <Unit_Price_HT>3</Unit_Price_HT>
  <Unit_Price_NT>1</Unit_Price_NT>
</EnergyPrices_PricesResultModel>