Reading backend interfaces
Read price sheet
Read price sheet
GET
https://mock.macoapp.de
/getPriceSheetBasic
Reading a price sheet based on processDate / gueltigAb
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1 | Location ID · Example: 74018657187 · Default: 74018657187 | string |
parameter2 | Location type · Example: MALO · Default: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Date (valid from) or key date if parameter4 is not set · Example: 2024-06-28T12:18:00Z · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter4 | Date (Valid until) · Example: 2024-06-28T12:18:00Z · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
command | Corresponds to the operationId of this interface. This operation ID corresponds to the command in the Camunda connector process. If the backend provides a generic endpoint, this command can be used to define which operation is to be executed. | string |
Read price sheet › Responses
Successful reading of the grid location | Successful reading of the network location
Array of: Price sheet — the response is a list of these objects, not a single object. Every entry has this structure:
| Structure (BO4E) | Description | Format |
|---|---|---|
boTyp* | Type of the BO | stringANSPRECHPARTNER, AVIS, ENERGIEMENGE GESCHAEFTSOBJEKT, GESCHAEFTSPARTNER, MARKTLOKATION, MARKTTEILNEHMER, MESSLOKATION, ZAEHLER, KOSTEN, TARIF, PREISBLATT, PREISBLATTNETZNUTZUNG, PREISBLATTMESSUNG, PREISBLATTUMLAGEN, PREISBLATTDIENSTLEISTUNG, PREISBLATTKONZESSIONSABGABE, ZEITREIHE, LASTGANG, HANDELSUNSTIMMIGKEIT, ANFRAGE, AUFTRAG, STATUSMITTEILUNG, BERECHNUNGSFORMEL, RECHNUNG, BILANZIERUNG, NETZNUTZUNGSVERTRAG, MESSSTELLENBETRIEBSVERTRAG, ENERGIELIEFERVERTRAG, SPERRAUFTRAG, ANGEBOT, TRANCHE, KOMMUNIKATIONSDATEN, ZAEHLZEITDEFINITION, SCHALTZEITDEFINITION, LEISTUNGSKURVENDEFINITION, NETZLOKATION, STEUERBARE_RESSOURCE, TECHNISCHE_RESSOURCE, AD_HOC_STEUERKANAL, LOKATIONSBUENDEL, WERTE_NACH_TYP2, REKLAMATION, STATUSBERICHT, VERTRAG, BILANZKREIS, VERWENDUNGSZEITRAUM, TARIFINFO, SUMMENZEITREIHE |
versionStruktur* | versionStruktur | string |
bezeichnung | Designation of the surcharge/discount | string |
| gueltigkeit | The time period for which the price is fixed. Start of validity DTM 157 PI 27002 27003 | object |
zeiteinheit | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Time span, value | integer |
startdatum | Date from DTM Z25 Use of the data from DTM 163 Processing, start date/time DTM 155 Invoicing period, start date DTM Z42 Provisional billing period start | string (date-time) |
enddatum | Date from DTM Z26 Use of the data until DTM164 Processing, end date/time DTM 156 Invoicing period, end date DTM Z43 Provisional billing period end | string (date-time) |
einheit | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Periodic meter reading of the NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Date on which the grid usage settlement of the NB takes place DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | Period text | string |
zeitraumId | Reference to period ID RFF Z46 PI 25001 | integer |
preisstatus | Indicates the status of the published price | stringVORLAEUFIG, ENDGUELTIG |
sparte | Electricity or gas | stringSTROM, GAS, FERNWAERME NAHWAERME, WASSER, ABWASSER |
preisNetzbetreiberCodenummer | Prices of the grid operator | string |
bilanzierungsdatum | Balancing date DTM 492 PI 27001 | string (date-time) |
regelzone | Control area LOC 231 PI 27001 | string |
leistungstyp | Standardized designation for the billed service provided. Details service type | stringARBEITSPREIS_WIRKARBEIT, LEISTUNGSPREIS_WIRKLEISTUNG, ARBEITSPREIS_BLINDARBEIT_IND ARBEITSPREIS_BLINDARBEIT_KAP, GRUNDPREIS, MEHRMINDERMENGE, MESSSTELLENBETRIEB, MESSDIENSTLEISTUNG, MESSDIENSTLEISTUNG_INKL_MESSUNG, ABRECHNUNG, KONZESSIONS_ABGABE, KWK_UMLAGE, OFFSHORE_UMLAGE, ABLAV_UMLAGE, REGELENERGIE_UMLAGE, BILANZIERUNG_UMLAGE, AUSLESUNG_ZUSAETZLICH, ABLESUNG_ZUSAETZLICH, ABRECHNUNG_ZUSAETZLICH, SPERRUNG, ENTSPERRUNG, MAHNKOSTEN, INKASSOKOSTEN |
nichtGenutzt | not used | boolean |
| preispositionen[ ] | The individual items that can be billed with the price sheet. E.g. energy price, base price etc. Code of the price key master data PIA 1 PI 27002 | object[] |
berechnungsmethode | The model on which the price calculation is based. Details calculation method | stringKEINE, STAFFELN, ZONEN VORZONEN_GP, SIGMOID, BLINDARBEIT_GT_50_PROZENT, BLINDARBEIT_GT_40_PROZENT, AP_GP_ZONEN, LP_INSTALL_LEISTUNG, AP_TRANSPORT_ODER_VERTEILNETZ, AP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID, LP_JAHRESVERBRAUCH, LP_TRANSPORT_ODER_VERTEILNETZ, LP_TRANSPORT_ODER_VERTEILNETZ_ORTSVERTEILNETZ_SIGMOID, FUNKTIONEN, VERBRAUCH_UEBER_SLP_GRENZE_FUNKTIONSBEZOGEN_WEITERE_BERECHNUNG_ALS_LGK |
leistungstyp | Standardized designation for the billed service provided. Details service type | stringARBEITSPREIS_WIRKARBEIT, LEISTUNGSPREIS_WIRKLEISTUNG, ARBEITSPREIS_BLINDARBEIT_IND ARBEITSPREIS_BLINDARBEIT_KAP, GRUNDPREIS, MEHRMINDERMENGE, MESSSTELLENBETRIEB, MESSDIENSTLEISTUNG, MESSDIENSTLEISTUNG_INKL_MESSUNG, ABRECHNUNG, KONZESSIONS_ABGABE, KWK_UMLAGE, OFFSHORE_UMLAGE, ABLAV_UMLAGE, REGELENERGIE_UMLAGE, BILANZIERUNG_UMLAGE, AUSLESUNG_ZUSAETZLICH, ABLESUNG_ZUSAETZLICH, ABRECHNUNG_ZUSAETZLICH, SPERRUNG, ENTSPERRUNG, MAHNKOSTEN, INKASSOKOSTEN |
leistungsbezeichnung | Designation of the service provision represented in the item. Z15 POG for a consuming market location > 100.000 kWh/a with iMS Z16 POG for a consuming market location ]50.000 kWh/a; 100.000 kWh/a] with iMS Z17 POG for a consuming market location ]20.000 kWh/a; 50.000 kWh/a] with iMS Z18 POG for a consuming market location ]10.000 kWh/a; 20.000 kWh/a] with iMS Z19 POG for a consuming market location with interruptible consumption devices under § 14a EnWG with iMS Z20 POG for a consuming market location ]6.000 kWh/a; 10.000 kWh/a] with iMS Z21 POG for a generating market location ]7 kW; 15kW] with iMS Z22 POG for a generating market location ]15 kW; 30 kW] with iMS Z23 POG for a generating market location ]30 kW; 100 kW] with iMS Z24 POG for a generating market location > 100 kW with iMS Z25 POG for a market location with mME Z28 POG for a consuming market location ]4.000 kWh/a; 6.000 kWh/a] with iMS Z29 POG for a consuming market location ]3.000 kWh/a; 4.000 kWh/a] with iMS Z30 POG for a consuming market location ]2.000 kWh/a; 3.000 kWh/a] with iMS Z31 POG for a consuming market location [0 kWh/a; 2.000 kWh/a] with iMS Z32 POG for optional equipping with iMS of new installations of a generating market location Z41 Additional service IMD C PI 27002 | stringPOG_VERBRAUCH_IMS_UEBER_100K, POG_VERBRAUCH_IMS_50K_BIS_100K, POG_VERBRAUCH_IMS_20K_BIS_50K POG_VERBRAUCH_IMS_10K_BIS_20K, POG_VERBRAUCH_IMS_UNTERBRECHBAR, POG_VERBRAUCH_IMS_6K_BIS_10K, POG_ERZEUGUNG_IMS_7_BIS_15, POG_ERZEUGUNG_IMS_15_BIS_30, POG_ERZEUGUNG_IMS_30_BIS_100, POG_ERZEUGUNG_IMS_UEBER_100, POG_MME, POG_VERBRAUCH_IMS_4K_BIS_6K, POG_VERBRAUCH_IMS_3K_BIS_4K, POG_VERBRAUCH_IMS_2K_BIS_3K, POG_VERBRAUCH_IMS_0_BIS_2K, POG_ERZEUGUNG_IMS_OPTIONAL, ZUSATZLEISTUNG |
preiseinheit | Currency details for the entire price list CUX 2 EUR PI 27001 27002 27003 | stringEUR, CT |
bezugsgroesse | This specifies the reference quantity to which the price relates, e.g. kWh or piece. Details unit of measurement | stringW, WH, KW KWH, KVARH, MW, MWH, STUECK, KUBIKMETER, STUNDE, TAG, MONAT, JAHR, PROZENT, ANZAHL, VAR, KVAR, VARH, KWHK, Z16, KWT, WATT_PRO_QUADRATMETER, METER_PRO_SEKUNDE |
zeitbasis | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
tarifzeit | Determination of the tariff period for which the price is specified here. | stringTZ_STANDARD, TZ_HT, TZ_NT |
bdewArtikelnummer | Article number of the BDEW Z01 article number PI 27001 27002 27003 | stringLEISTUNG, LEISTUNG_PAUSCHAL, GRUNDPREIS REGELENERGIE_ARBEIT, REGELENERGIE_LEISTUNG, NOTSTROMLIEFERUNG_ARBEIT, NOTSTROMLIEFERUNG_LEISTUNG, RESERVENETZKAPAZITAET, RESERVELEISTUNG, ZUSAETZLICHE_ABLESUNG, PRUEFGEBUEHREN_AUSSERPLANMAESSIG, WIRKARBEIT, SINGULAER_GENUTZTE_BETRIEBSMITTEL, ABGABE_KWKG, ABSCHLAG, KONZESSIONSABGABE, ENTGELT_FERNAUSLESUNG, UNTERMESSUNG, BLINDMEHRARBEIT, ENTGELT_ABRECHNUNG, SPERRKOSTEN, ENTSPERRKOSTEN, MAHNKOSTEN, MEHR_MINDERMENGEN, INKASSOKOSTEN, BLINDMEHRLEISTUNG, ENTGELT_MESSUNG_ABLESUNG, ENTGELT_EINBAU_BETRIEB_WARTUNG_MESSTECHNIK, AUSGLEICHSENERGIE, AUSGLEICHSENERGIE_UNTERDECKUNG, ZAEHLEINRICHTUNG, WANDLER_MENGENUMWERTER, KOMMUNIKATIONSEINRICHTUNG, TECHNISCHE_STEUEREINRICHTUNG, PARAGRAF_19_STROM_NEV_UMLAGE, BEFESTIGUNGSEINRICHTUNG, OFFSHORE_HAFTUNGSUMLAGE, FIXE_ARBEITSENTGELTKOMPONENTE, FIXE_LEISTUNGSENTGELTKOMPONENTE, UMLAGE_ABSCHALTBARE_LASTEN, MEHRMENGE, MINDERMENGE, ENERGIESTEUER, SMARTMETER_GATEWAY, STEUERBOX, MSB_INKL_MESSUNG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_1_MSBG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_2_MSBG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_3_MSBG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_4_MSBG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_5_MSBG, ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_3_MSBG, ENTGELT_KAPAZITAETEN |
zonungsgroesse | The tiering/zoning is carried out using the quantity of the variable specified here. E.g. full-load hours. | stringWIRKARBEIT_EL, LEISTUNG_EL, BLINDARBEIT_KAP BLINDARBEIT_IND, BLINDLEISTUNG_KAP, BLINDLEISTUNG_IND, WIRKARBEIT_TH, LEISTUNG_TH, VOLUMEN, VOLUMENSTROM, BENUTZUNGSDAUER, ANZAHL |
preisschluesselstamm | Price key master data | string |
positionsnummer | Sequential number for the price item LIN PI 27001 27002 27003 | integer |
messebene | Voltage level of the primary winding of the transformer CAV E06 PI 27002 | stringNSP, MSP, HSP HSS, MSP_NSP_UMSP, HSP_MSP_UMSP, HSS_HSP_UMSP, HD, MD, ND |
beschreibung | Product/service description, if IMD+X is present | string |
beschreibungsformat | Cf. PRICAT IMD 7077 | stringCODE, FREIER_TEXT, TEILSTRUKTURIERT |
artikelId | Article ID of the BDEW Z09 article ID PI 27001 27002 27003 | string |
| verarbeitungszeitraum | The time period for which the price is fixed. Start of validity DTM 157 PI 27002 27003 | object |
zeiteinheit | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Time span, value | integer |
startdatum | Date from DTM Z25 Use of the data from DTM 163 Processing, start date/time DTM 155 Invoicing period, start date DTM Z42 Provisional billing period start | string (date-time) |
enddatum | Date from DTM Z26 Use of the data until DTM164 Processing, end date/time DTM 156 Invoicing period, end date DTM Z43 Provisional billing period end | string (date-time) |
einheit | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Periodic meter reading of the NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Date on which the grid usage settlement of the NB takes place DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | Period text | string |
zeitraumId | Reference to period ID RFF Z46 PI 25001 | integer |
| zu_abschlaege[ ] | Surcharges or discounts on the line item. | object[] |
bezeichnung | Designation | string |
beschreibung | Description | string |
aufAbschlagstyp | not in use | stringRELATIV, ABSOLUT |
aufAbschlagswert | surcharge or discount value | number (float) |
aufAbschlagswaehrung | Currency details for the entire price list CUX 2 EUR PI 27001 27002 27003 | stringEUR, CT |
| preisstaffeln[ ] | Price details, net price for the current line item PRI CAL PI 27001 27002 27003 | object[] |
einheitspreis | Calculation price PRI CAL PI | number (float) |
zeitbasis | The time (duration) to which the price refers. E.g. one year for a demand price that is stated in €/kW/Jahr. | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
staffelgrenzeVon | Zone limits from RGN 10 | number (float) |
staffelgrenzeBis | Zone limits to RGN 10 | number (float) |
einheit | Unit: measurands that can be determined by measurement or by specification | stringW, WH, KW KWH, KVARH, MW, MWH, STUECK, KUBIKMETER, STUNDE, TAG, MONAT, JAHR, PROZENT, ANZAHL, VAR, KVAR, VARH, KWHK, Z16, KWT, WATT_PRO_QUADRATMETER, METER_PRO_SEKUNDE |
| sigmoidparameter | not in use | object |
A | A | number (float) |
B | B | number (float) |
C | C | number (float) |
D | D | number (float) |