![GETAG-Logo-Weiss-417x91-230411-AM.png]](https://service.get-ag.com/hs-fs/hubfs/Assets/GETAG-Logo-Weiss-417x91-230411-AM.png?height=33&name=GETAG-Logo-Weiss-417x91-230411-AM.png){kind=logo}
Wofür wird die Gas Netzentgelt-API eingesetzt?
Die Gas Netzentgelt - API ermöglicht die tagesaktuelle Berechnung von Gasnetzentgelten für Abnahmestellen mit Standardlastprofil (SLP) und registrierender Leistungsmessung (RLM) sowie den Abruf von Preisblatt-Rohdaten. Gasnetzentgelte können stichtags- oder zeitraumbezogen ermittelt werden. Die Ergebnisse lassen sich in eigene Systeme beispielsweise zur INVOIC-Prüfung, für Abrechnung und Kalkulation oder zum Ausweis auf Kundenrechnungen integrieren.
Die wichtigsten Informationen auf einen Blick
|
Produktmerkmal |
Gas Netzentgelt-API |
|
Funktion |
Berechnung und Rohdatenintegration von Gasentgelten |
|
Berechnungsarten |
Stichtags- und zeitraumbezogene Berechnung |
|
Aktualität der Daten |
Tagesaktuelle Berechnung von Gasnetzentgelten |
|
Lasttypen |
Standardlastprofil (SLP) und registrierende Leistungsmessung (RLM) |
|
Rohdaten |
Preisblatt-Rohdaten der deutschen Gas-Verteilnetzbetreiber sowie Abgaben und Umlagen |
|
Berechnungsergebnisse |
Gesamtentgelt sowie einzelne Entgeltbestandteile, z. B. Grundpreis, Arbeitspreis, Leistungspreis und Konzessionsabgaben |
|
Standortbezug |
Verbrauchsstelle, Netzgebiet und Netzbetreiber |
|
Zielgruppen |
Energieversorger, Stadtwerke, energiewirtschaftliche Dienstleister sowie Product Owner und Entwickler von Kalkulations- und Abrechnungslösungen |
|
Typische Einsatzbereiche |
Netzentgelt- und Angebotskalkulation, Abrechnung, INVOIC-Prüfung, Kundenrechnungen und Rohdatenintegration, Marktbeobachtungsanalysen |
|
Schnittstellen |
SOAP/JAX-WS und REST/JAX-RS |
|
API-Dokumentation |
SwaggerUI |
|
Systemumgebungen |
Test- und Produktivsystem |
Vorteile der Gas Netzentgelt-API
- Tagesaktuelle Berechnung von Gasnetzentgelten für SLP- und RLM-Abnahmestellen
- Stichtags- und zeitraumbezogene Berechnung für Kalkulations-, Abrechnungs- und Prüfprozesse
- Prüfung von Netzbetreiberrechnungen (INVOIC) durch detaillierte Zeitscheibenberechnungen
- Ausweis einzelner Entgeltbestandteile, z. B. Grundpreis, Arbeitspreis, Leistungspreis, Konzessionsabgabe und Umlagen
- Bereitstellung vollständiger Preisblatt-Rohdaten zur Integration und Weiterverarbeitung in eigenen Systemen
- Standortbezogene Zuordnung von Gasentgelten zum jeweiligen Netzbetreiber
- Gezielte Aktualisierung integrierter Gasentgelt-Daten über geänderte Entgelt-IDs
- Nutzung berechneter Werte für Angebotskalkulationen, Margenbetrachtungen und Marktbeobachtungsanalysen
- Bulk-Berechnung mehrerer Abnahmestellen innerhalb einer Anfrage
- 25 Jahre Erfahrung in der Datenbereitstellung für den Energiemarkt und Aufbau von API
- Unkomplizierte Beantragung eines kostenlosen Testzugangs über das unten stehende Kontaktformular
Anwendungsfälle
Für welche Anwendungsfälle eignet sich die Gas Netzentgelt-API?
- Netzbetreiberscharfe Netzentgeltkalkulation
- Prüfung von Netzbetreiberrechnungen (INVOIC)
- Integration in Abrechnungssysteme
- Integration von Gasentgelt-Preisblättern (Preisblattrohdaten)
- Aktualisierung eigener Gasentgelt-Daten
Netzbetreiberscharfe Netzentgeltkalkulation für konkrete Gas-Abnahmestellen
Beschreibung:
Für eine konkrete Gas-Abnahmestelle können die Netzentgelte des jeweils zuständigen Netzbetreibers berechnet werden. Für eine hausnummernscharfe Kalkulation kann zunächst über PLZ, Ort, Straße und Hausnummer der zuständige Netzbetreiber per Ortsinfo-API ermittelt werden. Dessen Verbandsnummer (DVGWID) wird anschließend zusammen mit der PLZ für die Netzentgeltberechnung verwendet. Die berechneten Werte können beispielsweise in Angebots- und Kalkulationsprozessen eingesetzt werden.
Nutzen:
- Netzentgeltkalkulation für konkrete Kundenstandorte
- Berücksichtigung des jeweils zuständigen Netzbetreibers
- Einsatz in Angebots- und Preiskalkulationen
- Berechnung für SLP- und RLM-Abnahmestellen
Tipp: Benötigen Sie für eine hausnummernscharfe Netzentgeltkalkulation den zuständigen Netzbetreiber und dessen Verbandsnummer, können Sie hierfür den GET AG Ortsinformations-Webservice nutzen. Die ermittelte Verbandsnummer kann anschließend zusammen mit der PLZ an die Gas Netzentgelt API übergeben werden.
Prüfung von Netzbetreiberrechnungen (INVOIC)
Beschreibung:
Mit der Gas Netzentgelt API können Gasnetzentgelte für den jeweiligen Rechnungszeitraum nachberechnet und für die Prüfung von Netzbetreiberrechnungen verwendet werden. Die Methode getBerechnungenZeitscheibe wurde speziell für die Prüfung von INVOIC entwickelt und ermöglicht eine detaillierte Berechnung für den jeweiligen Abrechnungszeitraum.
Zusätzlich können die für eine Abnahmestelle relevanten Preisblatt-Rohdaten und Konzessionsabgaben ermittelt und für eigene Prüfverfahren genutzt werden.
Nutzen:
- Nachberechnung der auf Netzbetreiberrechnungen ausgewiesenen Gasnetzentgelte
- Prüfung einzelner Entgeltbestandteile und Abrechnungszeiträume
- Verwendung von Preisblatt-Rohdaten als Grundlage eigener Prüfverfahren
- Integration in bestehende Rechnungseingangs- und Prüfsysteme
Gasnetzentgelte für Abrechnung und Kundenrechnungen
Beschreibung:
Die über die API berechneten Gasnetzentgelte können in eigene Abrechnungssysteme übernommen und für nachgelagerte Abrechnungsprozesse verwendet werden. Neben dem Gesamtentgelt stehen einzelne Entgeltbestandteile wie Grundpreis, Arbeitspreis, Leistungspreis, Konzessionsabgabe sowie Messstellenbetriebs-, Mess- und Abrechnungskosten zur Verfügung.
Dadurch können die berechneten Netzentgelte und ihre Bestandteile beispielsweise in der Abrechnung oder beim Ausweis auf Kundenrechnungen weiterverarbeitet werden.
Nutzen:
- Integration der Gasnetzentgeltberechnung in eigene Abrechnungssysteme
- separater Ausweis relevanter Entgeltbestandteile
- Nutzung der Werte für Kundenrechnungen und Abrechnungsübersichten
- Bereitstellung strukturierter Daten für nachgelagerte Prozesse
Integration von Gasnetzentgelt-Preisblättern in eigene Systeme
Beschreibung:
Neben berechneten Werten stellt die API auch die zugrunde liegenden Preisblatt-Rohdaten zur Verfügung. Mit getEntgelte und getEntgelteUniversal können vollständige Rohdaten eines Gasentgelts abgerufen und in eigene Abrechnungs-, Kalkulations- oder Prüfsysteme übernommen werden. Die Preisblätter sind grundsätzlich nach SLP und RLM getrennt.
Mit getEntgelteUniversal werden die einzelnen Preisbestandteile in einer einheitlichen Struktur ausgegeben und über preisArt und preisID unterschieden.
Nutzen:
- Übernahme vollständiger Gasentgelt-Preisblätter in eigene Systeme
- Nutzung der Rohdaten für eigene Berechnungs- und Prüfverfahren
- strukturierte Verarbeitung von SLP- und RLM-Entgelten
- einheitliche Verarbeitung unterschiedlicher Preisbestandteile
Aktualisierung eigener Gasnetzentgelt-Daten
Beschreibung:
Bereits integrierte Gasnetzentgelt-Daten können gezielt auf Änderungen geprüft werden. Über getEntgeltAenderungen lässt sich ermitteln, welche Entgelt-IDs seit der letzten Aktualisierung geändert wurden. Die betroffenen Preisblätter können anschließend erneut abgerufen und im Zielsystem aktualisiert werden.
Nutzen:
- gezielte Aktualisierung bereits integrierter Gasentgelt-Daten
- Erkennung neuer und geänderter Preisblätter
- Berücksichtigung nachträglicher Korrekturen und zurückgezogener Entgelte
- Aktualisierung nur der tatsächlich betroffenen Datenbestände
Hinweise zur Integration
Für Product Owner
Die Gas Netzentgelt-API eignet sich sowohl für die direkte Berechnung von Gasnetzentgelten als auch für die Integration und eigene Verarbeitung von Preisblatt-Rohdaten. Product Owner sollten daher zunächst festlegen, welche Daten und Funktionen für den jeweiligen Anwendungsfall benötigt werden.
Product-Owner-Checkliste:
- Soll für einen bestimmten Stichtag oder einen Abrechnungszeitraum berechnet werden?
- Handelt es sich um eine SLP- oder RLM-Abnahmestelle?
- Welche Ortsschärfe wird benötigt?
- Sollen nur Berechnungsergebnisse oder auch Preisblatt-Rohdaten im eigenen System gespeichert werden?
- Sollen integrierte Preisblatt-Rohdaten laufend aktualisiert werden?
- Werden größere Datenmengen verarbeitet?
- Muss bei der CO₂-Preisberechnung ein Biogasanteil berücksichtigt werden?
Hinweise für Softwareentwickler - Cliententwicklung
Die Gas Netzentgelt-API kann über SOAP/JAX-WS und REST/JAX-RS angebunden werden. Für Test- und Produktivsystem stehen WSDL- bzw. WADL-Adressen sowie eine API-Dokumentation über SwaggerUI zur Verfügung.
- Authentifizierung: Die Version 2.0 wurde laut Dokumentation auf „Basis Authentifizierung“ umgestellt.
- Dynamische Angaben: Zusätzliche fachliche Angaben können über das Objekt
dynamischeAngabenübertragen werden. - Schnittstellen: SOAP/JAX-WS und REST/JAX-RS.
Tipps für Softwareentwickler zur Clientgenerierung gibt es hier. Darüber hinaus empfehlen wir, die technische Dokumentation zu lesen.
SwaggerUI
Testsystem
Produktivsystem
Weitere Informationen zur technischen Anbindung, insbesondere zu WSDL, WADL, Authentifizierung, Zertifikaten und Freischaltung, finden Sie in der technischen Dokumentation.
FAQ
Wofür wird die Gas Netzentgelt-API primär eingesetzt?
Die Gas Netzentgelt-API dient der Berechnung und Rohdatenintegration von Gasnetzentgelten für SLP- und RLM-Abnahmestellen. Typische Einsatzbereiche sind Netzentgeltkalkulation, Abrechnung und die Prüfung von Netzbetreiberrechnungen (INVOIC). Preisblatt-Rohdaten können zusätzlich in eigene Systeme übernommen und dort weiterverarbeitet werden.
Wie werden Änderungen und neue Umlagen wie die Gasspeicherumlage über die API bereitgestellt?
Über das Objekt dynamischeAngaben können zusätzliche Preis- und Abgabeninformationen bereitgestellt werden, ohne die grundlegende Struktur des Webservice anzupassen.
Die Gasspeicherumlage wird in der API Dokumentation als Beispiel für eine solche dynamische Angabe dargestellt.
Welche Angaben werden für die standortbezogene Ermittlung von Gasnetzentgelten benötigt?
Für die Ermittlung von Gasnetzentgeltinformationen werden Angaben zur Verbrauchsstelle, zum Netzgebiet bzw. Netzbetreiber und zum Lasttyp (SLP oder RLM) verwendet. Mit getLokationsEntgeltInfo können dazu unter anderem PLZ sowie entweder eine GET-Region (idRegion) oder die Verbandsnummer des Netzbetreibers übergeben werden. Optional lässt sich die Verbrauchsstelle durch Ort, Ortsteil, Straße, Hausnummer oder Zählpunkt weiter konkretisieren.
Über stichtagVon und stichtagBis kann zudem festgelegt werden, für welchen Zeitraum die Entgelte gültig sein müssen. Wird stichtagVon nicht angegeben, verwendet die API den Tag der Abfrage.
Welche Rolle spielt der Biogasanteil bei der Berechnung des CO₂-Preises?
Über den optionalen Parameter biogasAnteil kann ein prozentualer Biogasanteil bei der Berechnung des CO₂-Preises für Erdgas berücksichtigt werden. Wird kein Biogasanteil übergeben, verwendet die API hierfür einen Wert von 0 %.
API Dokumentation
Beschreibung
Die API Dokumentation dient dem inhaltlichen Verständnis der Methoden, Objekte und Parameter. Sie bildet die Grundlage für die technische Implementierung in Abrechnungs- und Kalkulationssystemen der Energiewirtschaft.
Einbindung und API BeschreibungBitte nutzen Sie folgende WSDL und WADL für die Anbindung des Webservice.
WSDL für Testservice
https://webservicetest1.ag-server.de/getagWSCore/jaxws/GasentgeltService20x0?wsdl
WSDL für produktiven Service (SSL) / JAX
https://webservice1.ag-server.de/getagWSCore/jaxws/GasentgeltService20x0?wsdl
WADL für Testservice
https://webservicetest1.ag-server.de/getagWSCore/jaxrs/GasentgeltService20x0/application.wadl
WADL für produktiven Service (SSL) / REST
https://webservice1.ag-server.de/getagWSCore/jaxrs/GasentgeltService20x0/application.wadl
Weiterhin steht Ihnen eine API-Dokumentation per Swagger zur Verfügung:
Swagger produktiver Service
Swagger Testservice
Weitere technische Merkmale und Anforderungen, wie z.B. zu Zertifikaten, Authentifizierung, Freischaltung oder Hinweise zum Anfrageverhalten finden Sie in der Technischen Dokumentation zu den APIs.
Methoden-Übersicht
getVersion
Eingabe: <BasisAnfrage>
Ausgabe: <VersionAntwort>
Liefert die Version des Services als Zeichenkette zurück.
getBerechnungenStichtag
Eingabe: < ParamBerechnungStichtag >
Ausgabe: <BerechnungStichtag >
Gibt die Entgelte zu den ausgewählten Parametern zurück. Zusätzlich dazu werden Netzbetreiberinformationen aufgeführt.
Im Request können mehrere Anfrage-Objekte übergeben werden. Siehe dazu auch Abschnitt Verwendung der Bulk-Berechnungsmethoden
getLokationsEntgeltinfo
Eingabe: < ParamLokationsEntgeltInfo >
Ausgabe: < LokationsEntgeltInfo>
Gibt eine Liste von EntgeltIDs und Konzessionsabgaben zurück, die im Zeitraum an der Örtlichkeit gültig waren/sind. Zusätzlich werden auch zukünftige EntgeltIDs zurückgegeben - sofern vorhanden. Außerdem ist die Angabe der notwendigen Ortstiefe zur eindeutigen Identifikation des Entgelts enthalten.
getEntgeltAenderungen
Eingabe: < ParamEntgeltAenderungen >
Ausgabe: < EntgeltAenderungen>
Gibt bei neuerem Datenbankstand die Liste der geänderten EntgeltIDs zurück.
getEntgelte
Eingabe: <BasisAnfrage> <id (int)>
Ausgabe: < Entgelt>
Gibt das Preisblatt (Rohdaten) des Entgelts zur entsprechenden EntgeltID zurück.
getEntgelteUniversal
Eingabe: <BasisAnfrage> <id (int)>
Ausgabe: <EntgeltUniversal>
Gibt alle Netzentgelte zur übergebenen ID-Liste in einer universalen Preisblatt-Struktur (Rohdaten) zurück. Weitere Hinweise zur Benutzung siehe Abschnitt Hinweise zur Methode getEntgelteUniversal
getParameter
Eingabe: <BasisAnfrage>
Ausgabe: <ParameterAntwort >
Die Methode liefert die Namensauflösung der ParameterIDs.
getAbgaben
Eingabe: <BasisAnfrage>
Ausgabe: <AbgabenAntwort>
Die Methode liefert die Namensauflösung der ParameterIDs.
getBerechnungenZeitscheibe
Eingabe: <ParamBerechnungZeitscheibe >
Ausgabe: <BerechnungZeitscheibe>
Gibt eine detaillierte Liste mit berechneten Entgelten für einen Zeitraum zu den weiteren Input-Parametern zurück.
Bitte beachten Sie hierzu unbedingt Abschnitt Verwendung der Methode getBerechnungenZeitscheibe.
Im Request können mehrere Anfrage-Objekte übergeben werden. Siehe dazu auch Abschnitt Verwendung der Bulk-Berechnungsmethoden
Objektdefinitionen
AbgabenAntwort
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
abgaben |
object |
siehe Objekt Abgabe ID der Abgabe aus getParameter => abgabe |
|
steuern |
object |
siehe Objekt Abgabe ID der Steuer aus getParameter => steuer |
BasisAnfrage
|
Parameter |
Typ |
Beschreibung |
|
dynamischeAngaben |
object |
Siehe Objekt IdObjGruppe; weiterführende Informationen siehe Abschnitt „Übergabe des Objektes dynamische Angaben“ |
|
konfiguration |
int |
unbenutzter Parameter |
|
filter |
int |
unbenutzter Parameter |
BasisAntwort
|
Parameter |
Typ |
Beschreibung |
|
BasisAnfrage |
object |
siehe Objekt BasisAnfrage |
|
berechnungsKonfiguration |
object |
Definition einer Berechnungskonfiguration; siehe Objekt IntIdObj und ergänzend Abschnitt zur Nutzung der Berechnungskonfiguration |
|
ausgabeKonfiguration (optional) |
int |
Parameter im Moment nicht belegt |
|
abrechnungIntervall |
int |
0 = keine Vorgabe (beachte Berechnungshinweise) 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
details |
int |
0 = keine Details 1 = detaillierte Preisaufschlüsselung 2 = Rückgabe mit Input-Parametern 3 = 1 und 2 |
|
druckstufe |
int |
1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck 0 = alle Druckstufen |
|
gkz |
string |
Gemeindekennzahl der Verbrauchsstelle |
|
gueltigBis |
date |
Enddatum des Abrechnungszeitraums |
|
gueltigVon |
date |
Startdatum der Abrechnungszeitraums |
|
konzessionsabgabe |
int |
1 = TarifKA 2 = Kochen und Warmwasser 3 = SonderKA 4 = keine KA |
|
lasttyp |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
leistung (0:n Beziehung) |
object |
Siehe Objekt Menge; wenn nicht vorhanden dann wird mit Leistungswert gleich 0 gerechnet |
|
mdl |
string |
Kennung des Messdienstleisters 0 = ohne Kosten für MDL leer = regulatorischer MDL |
|
mehrUndMindermenge (0:n Beziehung) |
object |
Siehe Objekt Menge; Verbräuche in kWh zu Mehr- und Mindermengen |
|
mengenmodell |
int |
Übersteuerungsmöglichkeit des Mengenmodells 0 = GET-Erfassung 1 = auffüllendes/kumulierendes Modell 2 = Monatsmodell |
|
msb |
string |
Kennung des Messstellenbetreibers 0 = ohne Kosten für MSB leer = regulatorischer MSB |
|
nb |
string |
Kennung des Netzbetreibers leer = alle Netzbetreiber der Örtlichkeit |
|
plz |
string |
Postleitzahl der Verbrauchsstelle |
|
rabatte (optional) |
object |
Siehe Objekt Rabatt |
|
rechnungstyp |
int |
1 = Jahresrechnung 2 = Monatsrechnung |
|
uid (optional) |
string |
Vom Nutzer wählbare ID zur Kennzeichnung der Anfrage |
|
verbrauch (0:n Beziehung) |
object |
Siehe Objekt Menge; Verbräuche je Zeitscheibe in kWh |
|
verbrauchVorjahr |
int |
Vorjahresverbrauch bzw. prognostizierter Jahresverbrauch in kWh; wenn nicht vorhanden, dann wird ggf. dieser Wert anhand der Gradtagstabelle ermittelt |
|
zaehlerGroesse |
double |
Zählergröße (beachte Berechnungshinweise) |
|
zaehlerTyp |
int |
0 = keine Angabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter |
|
zeitfaktor |
int |
Übersteuerungsmöglichkeit des Zeitfaktors 0 = GET-Erfassung 1 = Monat 2 = Tag |
|
zusatzkostenGruppen |
object |
Siehe Objekt ZusatzkostenGruppen |
|
idRegion (optional) |
int |
Liste der einzuschränkenden GET-Netzgebiete |
|
biogasAnteil (optional) |
double |
Biogasanteil in % für die anteilige Berechnung des CO2-Preises. Wenn kein biogasanteil übergeben wird ist dies 0 %. |
Meldung
|
Parameter |
Typ |
Beschreibung |
|
dynamischeAngaben |
object |
Siehe Objekt IdObjGruppe; weiterführende Informationen siehe Abschnitt „Übergabe des Objektes dynamische Angaben“ |
|
code |
int |
Ausgabe des Codes des Fehlers bzw. der Warnung; Ausprägungen siehe Methode getParameter |
|
beschreibung |
stringt |
Beschreibung des Fehlers bzw. der Warnung |
ParamBerechnungStichtag
|
Parameter |
Typ |
Beschreibung |
|
BasisAnfrage |
object |
siehe Objekt BasisAnfrage |
|
berechnungsKonfiguration |
object |
Definition einer Berechnungskonfiguration; siehe Objekt IntIdObj und ergänzend Abschnitt zur Nutzung der Berechnungskonfiguration |
|
ausgabeKonfiguration (optional) |
int |
Parameter im Moment nicht belegt |
|
abrechnungIntervall |
int |
0 = keine Vorgabe (beachte Berechnungshinweise) 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
druckstufe |
int |
0 = alle Druckstufen (beachte Berechnungshinweise) 1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck |
|
gkz (optional) |
string |
Gemeindekennzahl zur Verbrauchsstelle |
|
konzessionsabgabe
|
int |
1 = TarifKA 2 = Kochen und Warmwasser 3 = SonderKA 4 = keine KA |
|
lasttyp |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
leistung |
double |
Jahreshöchstleistung in kW |
|
mdl (optional) |
string |
Kennung des Messdienstleisters 0 = ohne Kosten für MDL leer = regulatorischer MDL |
|
msb (optional) |
string |
Kennung des Messstellenbetreibers 0 = ohne Kosten für MSB leer = regulatorischer MSB |
|
nb (optional) |
string |
Kennung des Netzbetreibers leer = alle Netzbetreiber der Örtlichkeit |
|
plz |
string |
Postleitzahl der Verbrauchsstelle |
|
stichtag (optional) |
date |
Stichtag für Entgeltberechnung leer = aktueller Tag |
|
uid (optional) |
string |
Vom Nutzer wählbare ID zur Kennzeichnung der Anfrage |
|
verbrauch |
int |
Jahresverbrauch in kWh |
|
zaehlerGroesse |
double |
Zählergröße (beachte Berechnungshinweise) |
|
zaehlerTyp |
int |
0 = keine Vorgabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter (beachte Berechnungshinweise) |
|
zusatzkostenGruppen (optional) |
object |
Siehe Objekt ZusatzkostenGruppen |
|
idRegion (optional) |
int |
Liste der einzuschränkenden GET-Netzgebiete |
|
biogasAnteil (optional) |
double |
Biogasanteil in % für die anteilige Berechnung des CO₂-Preises. Wenn kein biogasanteil übergeben wird ist dies 0 %. |
Empfohlene Defaultwerte:
abrechnungIntervall = 0
gkz = NULL/leer
mdl = NULL/leer
msb = NULL/leer
uid = NULL/leer
zaehlerGroesse = 0
zaehlerTyp = 0
ZusatzkostenGruppen
|
Parameter |
Typ |
Beschreibung |
|
fernauslesung |
int |
Fernauslesung berücksichtigen 0 = nein 1 = ja |
|
kommunikationseinrichtung |
int |
Kommunikationseinrichtung berücksichtigen 0 = nein 1 = ja |
|
mengenumwerter |
int |
Mengenumwerter berücksichtigen 0 = nein 1 = ja |
|
technischeSteuereinrichtung |
int |
Techn. Steuereinrichtung berücksichtigen 0 = nein 1 = ja |
|
zaehleinrichtung |
int |
Zähleinrichtung berücksichtigen 0 = nein 1 = ja |
|
zusaetzlicheAblesung |
int |
Anzahl zusätzliche Ablesungen |
|
zusaetzlicheAbrechnung |
int |
Anzahl zusätzliche Abrechnungen |
|
zusatzkostenExtended (0:n Beziehung, optional) |
int |
ID des Zusatzkostentyps; siehe Objekte zusatzkostenGas in Methode getParameter |
Beachte Abschnitt Hinweise zur Berücksichtigung von Zusatzkosten
BerechnungStichtag
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
abrechnungIntervall (optional) |
int |
Intervall der Abrechnung: 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
apArt (optional) |
int |
Staffelspezifische AP-Berechnung: 1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
druckstufe (optional) |
int |
1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck 0 = alle Druckstufen |
|
entgeltFuerAbrechnung (optional) |
double |
Abrechnungskosten in €/Jahr (inkl. abrechnungZs) |
|
entgeltFuerEinbauBetriebWartungMesstechnik (optional) |
double |
Messstellenbetriebskosten in €/Jahr |
|
entgeltFuerMessungUndAblesung (optional) |
double |
Summe aus Mess- und Ablesungskosten in €/Jahr |
|
entgeltInformationen |
object |
siehe Objekt EntgeltInformationen |
|
gesamtpreis (optional) |
double |
Gesamtpreis Entgelt in €/Jahr |
|
grundpreis (optional) |
double |
Grundpreis in €/Jahr (beachte Berechnungshinweise) |
|
grundpreisLeistung (optional) |
double |
Grundpreis in €/Jahr bezogen auf die Leistung |
|
grundpreisWirkarbeit (optional) |
double |
Grundpreis in €/Jahr bezogen auf die Wirkarbeit |
|
gueltigBis (optional) |
date |
Gültigkeitsende |
|
gueltigVon (optional) |
date |
Gültigkeitsbeginn |
|
input |
object |
Ausgabe der Input-Parameter, siehe Objekt ParamBerechnungStichtag |
|
konzessionsabgabe (optional) |
double |
Konzessionsabgabe in ct/kWh |
|
leistung (optional) |
double |
Leistungspreis in €/Jahr |
|
leistungFix (optional) |
double |
Fixer Anteil am Leistungspreis in €/Jahr |
|
leistungUebergeben (optional) |
double |
Zur Berechnung ermittelte Leistung in kW, falls vom Nutzer nicht angegeben |
|
lpArt |
int |
Staffelspezifische LP-Berechnung: 1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
regelenergieumlage |
object |
siehe Objekt Marktgebiet |
|
bilanzierungsumlage |
object |
siehe Objekt Marktgebiet |
|
uid (optional) |
string |
Vom Nutzer übergebene Anfrage-ID |
|
wirkarbeit (optional) |
double |
Arbeitspreis in €/Jahr |
|
wirkarbeitFix (optional) |
double |
Fixer Anteil am Arbeitspreis in €/Jahr nur bei entsprechenden Entgeltmodell |
|
zaehlerGroesseBis (optional) |
double |
Obergrenze der Zählergrößenstaffel |
|
zaehlerGroesseVon (optional) |
double |
Untergrenze der Zählergrößenstaffel |
|
zaehlerTyp (optional) |
int |
0 = keine Angabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter |
|
arbeitspreis |
double |
Arbeitspreis in ct/kWh |
|
arbeitspreisFix |
double |
Fixer Anteil am Arbeitspreis in ct/kWh nur bei entsprechenden Entgeltmodell |
|
co2PreisErdgas |
double |
CO₂-Preis Erdgas in €/Jahr unter Berücksichtigung des übergebenen biogasAnteil |
|
referenzCo2PreisErdgas |
double |
CO₂-Preis Erdgas in ct/kWh unter Berücksichtigung des übergebenen biogasAnteil |
EntgeltInformationen
|
Parameter |
Typ |
Beschreibung |
|
entgeltID |
int |
interne ID des Entgelts |
|
entgeltName (optional) |
string |
Name des Entgelts |
|
entgeltRootID |
int |
GET AG interne Historien-ID des Entgelts |
|
gueltigBis (optional) |
date |
Gültigkeit des Entgelts (Enddatum) |
|
gueltigVon (optional) |
date |
Gültigkeit des Entgelts (Startdatum) |
|
idRegion |
int |
GET-Gas Netzgebiet |
|
pauschalkostenZeitscheibe (optional) |
object |
Siehe Objekt PauschalkostenZeitscheibe |
|
versorgerInformationen |
object |
siehe Objekt VersorgerInformationen |
|
vorlaeufig (optional) |
int |
0 = Entgelt ist final 1 = Entgelt ist vorläufig |
PauschalkostenZeitscheibe
|
Parameter |
Typ |
Beschreibung |
|
bdewArtikel |
string |
BDEW-Artikelnummer |
|
details |
object |
Siehe Objekt PreisDetails |
|
id |
int |
Pauschalkosten-ID |
|
imGesamtpreisEnthalten |
int |
Kennzeichnung, ob Zusatzkostentyp im Gesamtpreis enthalten 0 = nicht enthalten 1 = enthalten |
VersorgerInformationen
|
Parameter |
Typ |
Beschreibung |
|
gueltigBis |
date |
Enddatum der Gültigkeit |
|
gueltigVon |
date |
Startdatum der Gültigkeit |
|
marktrolleID |
int |
ID der Marktrolle; siehe Methode getParameter |
|
verbandsnummer |
string |
13-stellige BDEW/DVGW-Nummer oder ILN |
|
verbandsnummerKurz (optional) |
string |
kurze Nummer des BDEW/DVGW (Netzbetreibernummer) |
|
versorgerID |
int |
interne ID des Versorgers |
|
versorgerName (optional) |
string |
Name des Versorgers |
Angaben zum Marktgebiet bei Regelenergieumlage / Bilanzierungsumlage
|
Parameter |
Typ |
Beschreibung |
|
marktgebietEIC (optional) |
string |
EIC des Marktgebiets |
|
marktgebietID |
int |
ID des Marktgebiets |
|
marktgebietName (optional) |
string |
Name des Marktgebiets |
|
wert |
double |
Höhe der Regelenergieumlage bzw. der Bilanzierungsumlage in ct/kWh |
ParamBerechnungZeitscheibe
|
Parameter |
Typ |
Beschreibung |
|
BasisAnfrage |
object |
siehe Objekt BasisAnfrage |
|
berechnungsKonfiguration |
object |
Definition einer Berechnungskonfiguration; siehe Objekt IntIdObj und ergänzend Abschnitt zur Nutzung der Berechnungskonfiguration |
|
ausgabeKonfiguration (optional) |
int |
Parameter im Moment nicht belegt |
|
abrechnungIntervall |
int |
0 = keine Vorgabe (beachte Berechnungshinweise) 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
details |
int |
0 = keine Details 1 = detaillierte Preisaufschlüsselung 2 = Rückgabe mit Input-Parametern 3 = 1 und 2 |
|
druckstufe |
int |
1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck 0 = alle Druckstufen |
|
gkz |
string |
Gemeindekennzahl der Verbrauchsstelle |
|
gueltigBis |
date |
Enddatum des Abrechnungszeitraums |
|
gueltigVon |
date |
Startdatum der Abrechnungszeitraums |
|
konzessionsabgabe |
int |
1 = TarifKA 2 = Kochen und Warmwasser 3 = SonderKA 4 = keine KA |
|
lasttyp |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
leistung (0:n Beziehung) |
object |
Siehe Objekt Menge; Wenn nicht vorhanden, dann wird mit Leistungswert gleich 0 gerechnet. |
|
mdl |
string |
Kennung des Messdienstleisters 0 = ohne Kosten für MDL leer = regulatorischer MDL |
|
mehrUndMindermenge (0:n Beziehung) |
object |
Siehe Objekt Menge; Verbräuche in kWh zu Mehr- und Mindermengen |
|
mengenmodell |
int |
Übersteuerungsmöglichkeit des Mengenmodells 0 = GET-Erfassung 1 = auffüllendes/kumulierendes Modell 2 = Monatsmodell |
|
msb |
string |
Kennung des Messstellenbetreibers 0 = ohne Kosten für MSB leer = regulatorischer MSB |
|
nb |
string |
Kennung des Netzbetreibers leer = alle Netzbetreiber der Örtlichkeit |
|
plz |
string |
Postleitzahl der Verbrauchsstelle |
|
rabatte (optional) |
object |
Siehe Objekt Rabatt |
|
rechnungstyp |
int |
1 = Jahresrechnung 2 = Monatsrechnung |
|
uid (optional) |
string |
Vom Nutzer wählbare ID zur Kennzeichnung der Anfrage |
|
verbrauch (0:n Beziehung) |
object |
Siehe Objekt Menge; Verbräuche je Zeitscheibe in kWh |
|
verbrauchVorjahr |
int |
Vorjahresverbrauch bzw. prognostizierter Jahresverbrauch in kWh; Wenn nicht vorhanden, dann wird ggf. dieser Wert anhand der Gradtagstabelle ermittelt. |
|
zaehlerGroesse |
double |
Zählergröße (beachte Berechnungshinweise) |
|
zaehlerTyp |
int |
0 = keine Angabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter |
|
zeitfaktor |
int |
Übersteuerungsmöglichkeit des Zeitfaktors 0 = GET-Erfassung 1 = Monat 2 = Tag |
|
zusatzkostenGruppen |
object |
Siehe Objekt ZusatzkostenGruppen |
|
idRegion (optional) |
int |
Liste der einzuschränkenden GET-Netzgebiete |
|
biogasAnteil (optional) |
double |
Biogasanteil in % für die anteilige Berechnung des CO₂-reises. Wenn kein biogasanteil übergeben wird ist dies 0 %. |
Menge
|
Parameter |
Typ |
Beschreibung |
|
gueltigBis |
date |
Enddatum der Verbrauchsermittlung |
|
gueltigVon |
date |
Stardatum der Verbrauchsermittlung |
|
menge |
double |
Menge in Abhängigkeit vom Oberobjekt |
Rabatt
|
Parameter |
Typ |
Beschreibung |
|
rabattArt |
string |
Nur im Output belegt: R = Rabatt Z = Zuschlag |
|
rabattHoehe |
date |
Höhe des anzusetzenden Rabattes |
|
rabattTyp |
string |
Rabatt-Typ gemäß BDEW: „Z01“ (Gemeinderabatt gemäß KAV § 3) |
|
rabattWert |
double |
Wert des Rabattes in €; nur im Output belegt |
BerechnungZeitscheibe
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
abschlag |
double |
Höhe der anhand des Gesamtpreises errechneten Abschlagszahlung in €/Monat |
|
entgeltFuerAbrechnung |
double |
Abrechnungskosten in € |
|
entgeltFuerEinbauBetriebWartungMesstechnik |
double |
Messstellenbetriebskosten in € |
|
entgeltFuerMessungUndAblesung |
double |
Summe aus Mess- und Ablesungskosten in € |
|
entgeltInformationenZeitscheibe |
object |
Siehe Objekt EntgeltInformationenZeitscheibe |
|
gesamtpreis |
double |
Gesamtpreis Entgelt in € |
|
grundpreis |
double |
Grundpreis in € |
|
grundpreisLeistung |
double |
Grundpreis der Leistung in € |
|
grundpreisWirkarbeit |
double |
Grundpreis der Wirkarbeit in € |
|
input |
object |
Ausgabe der Input-Parameter, siehe Objekt ParamBerechnungZeitscheibe |
|
kaDetails |
object |
Siehe Objekt PreisDetails |
|
konzessionsabgabe |
double |
Konzessionsabgabe in € |
|
leistung |
double |
Leistungspreis in € |
|
leistungFix |
double |
Fixer Anteil am Leistungspreis in € |
|
marktgebiet |
object |
Siehe Objekt Marktgebiet |
|
rabatte (optional) |
object |
Siehe Objekt Rabatt |
|
uid (optional) |
string |
Vom Nutzer wählbare ID zur Kennzeichnung der Anfrage |
|
wirkarbeit |
double |
Arbeitspreis in € |
|
wirkarbeitFix |
double |
Fixer Anteil der Wirkarbeit |
|
co2PreisErdgasDetails |
object |
Details zum Grundpreis; Siehe Objekt PreisDetails |
EntgeltInformationenZeitscheibe
|
Parameter |
Typ |
Beschreibung |
|
entgeltID |
int |
GET AG interne (eindeutige) ID des Entgelts |
|
entgeltName |
string |
Name des Entgelts |
|
entgeltRootID |
int |
GET AG interne Historien-ID des Entgelts |
|
gueltigBis |
date |
Gültigkeit des Entgelts (Enddatum) |
|
gueltigVon |
date |
Gültigkeit des Entgelts (Startdatum) |
|
idRegion |
int |
GET-Gas Netzgebiet |
|
pauschalkostenZeitscheibe |
object |
Siehe Objekt PauschalkostenZeitscheibe |
|
versorgerInformationen |
object |
Siehe Objekt VersorgerInformationen |
|
vorlaeufig |
int |
0 = Entgelt ist final 1 = Entgelt ist vorläufig |
|
entgeltDetails |
object |
Siehe Objekt EntgeltDetails |
EntgeltDetails
|
Parameter |
Typ |
Beschreibung |
|
apArt |
int |
Staffelspezifische AP-Berechnung: 1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
grundpreisDetails |
object |
Details zum Grundpreis; Siehe Objekt PreisDetails |
|
grundpreisLeistungDetails |
objekt |
Details zum Grundpreis der Leistung; Siehe Objekt PreisDetails |
|
grundpreisWirkarbeitDetails |
objekt |
Details zum Grundpreis der Wirkarbeit; Siehe Objekt PreisDetails |
|
leistungDetails |
object |
Details zum Leistungspreis; Siehe Objekt PreisDetails |
|
leistungFixDetails |
object |
Details zum fixen Anteil des Leistungspreises; Siehe Objekt PreisDetails |
|
lpArt |
int |
Staffelspezifische LP-Berechnung: 1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
mengenmodell |
int |
Zur Berechnung genutztes Mengenmodell: 1 = auffüllendes/kumulierendes Modell 2 = Monatsmodell |
|
messungDetails |
object |
Siehe Objekt MessungDetails |
|
wirkarbeitDetails |
object |
Details zur Wirkarbeit; siehe Objekt PreisDetails |
|
wirkarbeitFixDetails |
object |
Details zum fixen Anteil der Wirkarbeit; siehe Objekt PreisDetails |
|
zeitfaktor |
Int |
Zur Berechnung genutzter Zeitfaktor: 1 = Monat 2 = Tag |
PreisDetails
|
Parameter |
Typ |
Beschreibung |
|
gueltigBis |
date |
Gültigkeitsende des Preises |
|
gueltigVon |
date |
Gültigkeitsbeginn des Preises |
|
id |
int |
Nur befüllt bei Preisen für Zusatzkosten; enthält ID des Zusatzkostentyps (siehe Methode getParameter) |
|
menge |
double |
Preisrelevante Menge |
|
mengeEinheit |
string |
Einheit der Menge (KWH,KWT,KAH,PCS) |
|
rabattWert |
double |
Gesamtwert des Rabattes; bei mehreren Rabatten zum Preisbestandteil ist dies die Summe der Einzel-Rabattwerte |
|
rabatte |
object |
Siehe Objekt Rabatt |
|
referenzwert |
double |
Referenzpreis im Zeitraum in €/Einheit |
|
wert |
double |
Preis für den Zeitraum in € |
|
zeit (optional) |
int |
Wert für die zeitliche Abhängigkeit |
|
zeitEinheit (optional) |
string |
Einheit der Zeit (DAY,MON,ANN,PCS) |
MessungDetails
|
Parameter |
Typ |
Beschreibung |
|
abrechnungIntervall |
int |
Intervall der Abrechnung: 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
entgeltFuerAbrechnung |
object |
Siehe Objekt PreisDetails |
|
entgeltFuerEinbauBetriebWartungMesstechnik |
object |
Siehe Objekt PreisDetails |
|
entgeltFuerMessungUndAblesung |
object |
Siehe Objekt PreisDetails |
|
zaehlerGroesseBis |
double |
Obergrenze der Zählergrößenstaffel |
|
zaehlerGroesseVon |
double |
Untergrenze der Zählergrößenstaffel |
|
zaehlerTyp |
int |
0 = keine Angabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter |
Marktgebiet
|
Parameter |
Typ |
Beschreibung |
|
buDetails |
object |
Siehe Objekt PreisDetails |
|
buWert |
double |
Bilanzierungsumlage in € |
|
gueltigBis |
date |
Gültigkeitsende der Marktgebietszuordnung |
|
gueltigVon |
date |
Gültigkeitsbeginn der Marktgebietszuordnung |
|
marktgebietEIC |
string |
EIC des Marktgebiets |
|
marktgebietID |
int |
ID des Marktgebiets |
|
marktgebietName |
string |
Name des Marktgebiets |
|
mumDetails |
object |
Siehe Objekt PreisDetails |
|
mumWert |
double |
Kosten für Mehr- und Mindermengen in € |
|
reuDetails |
object |
Siehe Objekt PreisDetails |
|
reuWert |
double |
Regelenergieumlage in € |
ParamLokationsEntgeltInfo
|
Parameter |
Typ |
Beschreibung |
|
BasisAnfrage |
object |
siehe Objekt BasisAnfrage |
|
hausnummer (optional) |
string |
Hausnummer der Verbrauchsstelle |
|
idRegion (optional) |
int |
Liste der einzuschränkenden GET-Netzgebiete |
|
ort (optional) |
string |
Ort der Verbrauchsstelle |
|
ortsteil (optional) |
string |
Ortsteil der Verbrauchsstelle |
|
plz |
string |
Postleitzahl der Verbrauchsstelle |
|
stichtagVon |
date |
Stichtag, ab wann Entgelte mindestens gültig sein müssen Wenn leer, dann Tag der Abfrage. |
|
stichtagBis |
date |
Stichtag, bis wann Entgelte mindestens gültig sein müssen Wenn leer, dann alle verfügbaren seit stichtagVon |
|
strasse (optional) |
string |
Straße der Verbrauchsstelle |
|
verbandsnummer |
string |
13-stellige DVGWID bzw. ILN des Netzbetreibers |
|
zaehlpunkt (optional) |
string |
Zählpunkt der Verbrauchsstelle |
|
lasttyp |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
konzessionenAnzeige |
int |
Steuert die Rückgabe des Konzessionen-Objekts: 0 = nicht anzeigen 1 = anzeigen |
Hinweis zur Netzgebietszuordnung:
Es muss mindestens idRegion ODER Verbandsnummer übergeben werden.
LokationsEntgeltInfo
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
datenbankstand |
decimal |
Version des Datenbankstands |
|
entgeltInfo |
object |
Siehe Objekt EntgeltInfo |
|
konzessionen |
object |
Siehe Objekt Konzessionen |
|
ortstiefe (optional) |
int |
1 = PLZ; 2 = Ort; 3 = OTL; 4 = Straße; 5 = HsNr (keine Angabe, wenn Anfrage über idRegion) |
EntgeltInfo
|
Parameter |
Typ |
Beschreibung |
|
entgeltID |
int |
Eindeutige ID des Entgeltes |
|
entgeltRootID |
int |
RootID des Entgeltes |
|
gueltigBis |
date |
Gültigkeit des Entgelts (Enddatum) |
|
gueltigVon |
date |
Gültigkeit des Entgelts (Startdatum) |
|
lasttyp |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
idRegion |
int |
GET-Gas Netzgebiet |
Konzessionen
|
Parameter |
Typ |
Beschreibung |
|
gkz (optional) |
string |
Gemeindekennzahl |
|
ka |
object |
siehe Objekt Ka |
|
ort[] (optional) |
string |
alle Ortsnamen innerhalb der GKZ-PLZ-Kombination |
|
plz (optional) |
string |
Postleitzahl |
Ka
|
Parameter |
Typ |
Beschreibung |
|
gueltigBis |
date |
Gültigkeit der KA (Enddatum) |
|
gueltigVon |
date |
Gültigkeit der KA (Startdatum) |
|
kochenUndWarmwasser |
double |
Konzessionsabgabe für Kochen und Warmwasser in ct/kWh |
|
sondervertragskunde |
double |
Konzessionsabgabe für Sondervertragskunden in ct/kWh |
|
tarifkunde |
double |
Konzessionsabgabe für Tariflieferungen in ct/kWh |
ParamEntgeltAenderungen
|
Parameter |
Typ |
Beschreibung |
|
BasisAnfrage |
object |
siehe Objekt BasisAnfrage |
|
datenbankstand |
decimal |
Version des Datenbankstands |
|
stichtag (optional) |
date |
Stichtag, ab wann Entgelte mindestens gültig sein müssen |
|
entgeltRootID[] (optional) |
int |
Liste der einzuschränkende Entgelt RootIDs |
|
idRegion [] (optional) |
int |
Liste der einzuschränkenden GET-Netzgebiete |
Um die Ausgabedaten konsistent zu halten dürfen entgeltRootID und idRegion
nicht gleichzeitig übergeben werden. Demzufolge sind nur nachstehende
Input-Kombinationen möglich:
- datenbankstand
- datenbankstand + entgeltRootID
- datenbankstand + idRegion
- datenbankstand + stichtag
- datenbankstand + stichtag + entgeltRootID
- datenbankstand + stichtag + idRegion
EntgeltAenderungen
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
datenbankstand (optional) |
decimal |
Version des Datenbankstands mit dem zuletzt angefragt wurde um alle Änderungen seitdem zu erhalten. |
|
daten |
object |
Siehe Objekt EntgeltAenderung |
EntgeltAenderung
|
Parameter |
Typ |
Beschreibung |
|
aktion |
string |
CREATE = Entgelt neu UPDATE = Entgelt aktualisiert DELETE = Entgelt gelöscht |
|
entgeltID |
int |
Eindeutige ID des Entgeltes |
|
entgeltRootID |
int |
RootID des Entgeltes |
|
letztesUpdate |
decimal |
Datum der letzten Änderung |
|
idRegion |
int |
Netzgebiet für die die Änderung gilt. |
Entgelt
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
entgeltID (optional) |
int |
GET AG interne ID des Entgelts |
|
entgeltName (optional) |
string |
Name des Entgelts |
|
entgeltRootID (optional) |
int |
GET AG interne RootID des Entgelts |
|
gueltigBis (optional) |
date |
Gültigkeit des Entgelts (Enddatum) |
|
gueltigVon (optional) |
date |
Gültigkeit des Entgelts (Startdatum) |
|
lasttyp (optional) |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
leistungsFormel (optional) |
string |
Individuelle Formel zur Berechnung des Leistungswertes |
|
leistungsStaffel (0:n Beziehung) |
object |
Siehe Objekt LeistungsStaffel |
|
letztesUpdate |
decimal |
Datum des letzten Updates |
|
idRegion |
int |
GET-Gas Netzgebiet |
|
pauschalkosten (0:n Beziehung) |
object |
Siehe Objekt Pauschalkosten |
|
urlNEUebersicht (optional) |
string |
Link zur Entgelt-Seite des Netzbetreibers |
|
verbrauchsStaffel (0:n Beziehung) |
object |
Siehe Objekt VerbrauchsStaffel |
|
versorgerInformationen (0:n Beziehung) |
object |
Siehe Objekt VersorgerInformationen |
|
vorlaeufig (optional) |
int |
0 = Entgelt ist final 1 = Entgelt ist vorläufig |
|
zaehlerKostenStaffel (0:n Beziehung) |
object |
Siehe Objekt ZaehlerKostenStaffel |
LeistungsStaffel
|
Parameter |
Typ |
Beschreibung |
|
ap |
double |
Arbeitspreis in ct/kWh |
|
benhBis |
double |
Obergrenze bzgl. Benutzungsdauerstunden |
|
benhVon |
double |
Untergrenze bzgl. Benutzungsdauerstunden |
|
druckstufeBis |
int |
Obergrenze bzgl. Druckstufe 1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck |
|
druckstufeVon |
int |
Untergrenze bzgl. Druckstufe 1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck |
|
gp (optional) |
double |
Grundpreis in €/Jahr |
|
gpArt |
int |
0 – Sockelbetrag 1 – Grundpreis |
|
leistungBis (optional) |
double |
Leistungsobergrenze der Staffel |
|
leistungVon (optional) |
double |
Leistungsuntergrenze der Staffel |
|
lp (optional) |
double |
Leistungspreis in €/kW |
|
lpArt (optional) |
int |
1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
lpBerechnung (optional) |
object |
Siehe Objekt Berechnungsformel
|
Pauschalkosten
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
interne ID des Kostentyps siehe Methode getParameter (zusatzkostenGas) |
|
wert |
double |
Höhe der Kosten in €/Jahr |
VerbrauchsStaffel
|
Parameter |
Typ |
Beschreibung |
|
ap |
double |
Arbeitspreis in ct/kWh |
|
apArt |
int |
1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis (siehe Berechnungsarten) |
|
apBerechnung (optional) |
object |
Siehe Objekt Berechnungsformel |
|
gp (optional) |
double |
Grundpreis in €/Jahr |
|
gpArt |
int |
0 – Sockelbetrag 1 – Grundpreis |
|
verbrauchBis |
int |
Verbrauchsobergrenze der Staffel |
|
verbrauchVon |
int |
Verbrauchsuntergrenze der Staffel |
ZaehlerKostenStaffel
|
Parameter |
Typ |
Beschreibung |
|
abrechnungIntervall |
int |
Intervall der Abrechnung: 1 = jährlich 2 = halbjährlich 3 = vierteljährlich 4 = monatlich |
|
abrechnungPreisart |
int |
1 = pro Jahr 2 = pro Vorgang |
|
abrechnungZs |
double |
Kosten für zusätzliche Abrechnung in €/Vorgang |
|
druckstufeBis (optional) |
int |
Obergrenze der Staffel bzgl. Druckstufe |
|
druckstufeVon (optional) |
int |
Untergrenze der Staffel bzgl. Druckstufe |
|
entgeltFuerAbrechnung |
double |
Kosten für Abrechnung in € in Abhängigkeit von ‚abrechnungPreisart‘ auf Jahresbasis |
|
entgeltFuerEinbauBetriebWartungMesstechnik |
double |
Kosten für Messstellenbetrieb in €/Jahr |
|
entgeltFuerMessungUndAblesung |
double |
Kosten für Messung und Zählung in € in Abhängigkeit von ‚messungPreisart‘ auf Jahresbasis |
|
messungPreisart |
int |
1 = pro Jahr 2 = pro Vorgang |
|
zaehlerGroesseBis |
double |
Obergrenze der Staffel bzgl. Zählergröße |
|
zaehlerGroesseVon |
double |
Untergrenze der Staffel bzgl. Zählergröße |
|
zaehlerTyp |
int |
0 = keine Angabe 1 = Balgengas 2 = Drehkolben 3 = Turbinenrad 4 = Ultraschall 5 = SmartMeter |
Berechnungsformel
|
Parameter |
Typ |
Beschreibung |
|
berechnungsart |
int |
Der Arbeits-/Leistungspreis wird durch eine Formel in Abhängigkeit vom Verbrauch/Leistung X ermittelt:
0: (Sigmoid) Preis = parameter1 + (parameter2 / (1 + (X / parameter3)^parameter4))
1: (Abschlag) Preis = parameter1 – (X / parameter3) (parameter2 und parameter4 stehen dabei fest auf -1) |
|
parameter1 (optional) |
double |
Erste Parameter (entspricht bei Sigmoid dem Wert des Minimums) |
|
parameter2 (optional) |
double |
Zweiter Parameter (entspricht bei Sigmoid dem Wert des Startwertes) |
|
parameter3 (optional) |
double |
Dritter Parameter (entspricht bei Sigmoid dem Wert des Wendepunktes) |
|
parameter4 (optional) |
double |
Vierter Parameter (entspricht bei Sigmoid dem Wert der Steigung) |
Ergebnis der Berechnung ist bei lpBerechnung ein lp in €/kW und bei apBerechnung ein ap in ct/kWh.
EntgeltUniversal
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
aenderungsgrund |
int |
Id des Änderungsgrundes |
|
entgeltID (optional) |
int |
GET AG interne ID des Entgelts |
|
entgeltName (optional) |
string |
Name des Entgelts |
|
entgeltRootID (optional) |
int |
GET AG interne RootID des Entgelts |
|
gueltigBis (optional) |
date |
Gültigkeit des Entgelts (Enddatum) |
|
gueltigVon (optional) |
date |
Gültigkeit des Entgelts (Startdatum) |
|
lasttyp (optional) |
int |
0 = Ohne Leistungsmessung (SLP) 1 = Mit Leistungsmessung (RLM) |
|
leistungsFormel |
string |
Individuelle Formel zur Berechnung des Leistungswertes |
|
letztesUpdate (optional) |
decimal |
Datum des letzten Updates |
|
medium (optional) |
int |
0 = Strom 1 = Erdgas |
|
idRegion |
int |
GET-Gas Netzgebiet |
|
preisstellung (0:n Beziehung) |
object |
Siehe Objekt Preisstellung |
|
versorgerInformationen (0:n Beziehung) |
object |
siehe Objekt VersorgerInformationen |
|
vorlaeufig |
int |
0 = Entgelt ist final 1 = Entgelt ist vorläufig |
Preisstellung
|
Parameter |
Typ |
Beschreibung |
|
ebeneEntnahme (optional) |
int |
Nutzung des Parameters für Ausgabe der Druckstufe: 1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck |
|
ebeneMessung (optional) |
int |
Nutzung des Parameters für Ausgabe der Druckstufe: 1 = Niederdruck 2 = Mitteldruck 3 = Hochdruck |
|
entgeltTyp (optional) |
int |
derzeit nur bei Strom relevant |
|
intervall (optional) |
string |
Intervall indem die Dienstleistung durchgeführt wird (unabhängig vom Zahlungintervall) jährlich, halbjährlich, quartalsweise, monatlich, wöchentlich, täglich, stündlich, 1/4-stündlich, … |
|
kundenGruppe (optional) |
int |
derzeit nur bei Strom relevant |
|
mengenAngaben (optional) |
string |
Preisabgrenzung Jahr, Monat, Tag |
|
preis (optional) |
double |
Preis, wenn keine Preisformel |
|
preisAngaben (optional) |
string |
kWh, kW, Benh, kvarh, Stk (Vorgang), Jahr, Monat, Tag |
|
preisArt |
int |
Identifikation der Art des Preises z.B.: Preis, Zusatzkosten, Zählerkosten
1 - Preis: für Preis_ID siehe Methode getParameter, Objekte „preis“
13 - ZusatzkostenGas: für Preis_ID siehe Methode getParameter, Objekte „zusatzkostenGas“
|
|
preisEinheit (optional) |
string |
Euro, Cent, Prozent |
|
preisID |
int |
interne ID der GET AG für den Preis, Bezeichnung in der Methode getParameter |
|
preisformel (0:n Beziehung) |
object |
Preisformel, wenn kein Preis; siehe Objekr Berechnungsformel |
|
staffelKennzeichnung (optional) |
int |
1 = Stufenpreis 2 = Zonenpreis 3 = Staffelpreis |
|
staffelung (0:n Beziehung) |
object |
Siehe Objekt Staffelung |
|
zaehlerTyp (optional) |
int |
interne ID der GET AG für den Zählertyp Bezeichnung in der Tabelle Parameter |
Staffelung
|
Parameter |
Typ |
Beschreibung |
|
staffelBis (optional) |
double |
Staffelobergrenze des Preises |
|
staffelEinheit (optional) |
string |
kWh, kW, Benh, kvarh, ZG (Zählergröße), Prozent (für Freimengen BAI) |
|
staffelVon (optional) |
double |
Staffeluntergrenze des Preises |
ParameterAntwort
|
Parameter |
Typ |
Beschreibung |
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
berechnungsweise |
object |
Siehe Objekt ParameterBeschreibung |
|
druckstufen |
object |
Siehe Objekt Druckstufen |
|
intervall |
object |
Siehe Objekt ParameterBeschreibung |
|
kundenart |
object |
Siehe Objekt ParameterBeschreibung |
|
lasttyp |
object |
Siehe Objekt ParameterBeschreibung |
|
marktrolle |
object |
Siehe Objekt ParameterBeschreibung |
|
medium |
object |
Siehe Objekt ParameterBeschreibung |
|
preis |
object |
Siehe Objekt Preis |
|
zaehlertypGas |
object |
Siehe Objekt ParameterBeschreibung |
|
zusatzkostenGas |
object |
Siehe Objekt ZusatzkostenGas |
|
zyklus |
object |
Siehe Objekt ParameterBeschreibung |
|
abgabenTyp |
object |
Siehe Objekt ParamDetailsBdew |
|
steuer |
object |
Siehe Objekt ParameterBeschreibung |
ParameterBeschreibung
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
ID des Parameters |
|
beschreibung |
string |
Bezeichnung des Parameters |
Druckstufen
|
Parameter |
Typ |
Beschreibung |
|
beschreibung |
string |
Bezeichnung des Parameters |
|
id |
int |
ID des Parameters |
|
zusatzinformationEdi |
object |
Siehe Objekt ZusatzinformationEdi |
Preis
|
Parameter |
Typ |
Beschreibung |
|
beschreibung |
string |
Bezeichnung des Parameters |
|
id |
int |
ID des Parameters |
|
zusatzinformationBdew (0:n Beziehung, optional) |
object |
Siehe Objekt ZusatzinformationBdew |
|
zusatzinformationObis (0:n Beziehung, optional) |
object |
Siehe Objekt ZusatzinformationObis |
|
zusatzinformationPreistyp |
object |
Siehe Objekt ParameterBeschreibung |
ZusatzkostenGas
|
Parameter |
Typ |
Beschreibung |
|
beschreibung |
string |
Bezeichnung des Parameters |
|
id |
int |
ID des Parameters |
|
zusatzinformationBdew (optional) |
object |
Siehe Objekt ZusatzinformationBdew |
ZusatzinformationEdi
|
Parameter |
Typ |
Beschreibung |
|
beschreibung (optional) |
string |
Bezeichnung nach EDI@Energy |
|
gueltigBis (optional) |
date |
Gültigkeitsende |
|
gueltigVon (optional) |
date |
Gültigkeitsbeginn |
ParamDetailsBdew
|
zusatzinformationBdew |
object |
siehe Objekt ZusatzinformatonBdew |
|
id |
date |
ID |
|
beschreibung |
string |
Beschreibung |
ZusatzinformationBdew
|
Parameter |
Typ |
Beschreibung |
|
artikelnummer (optional) |
string |
Bezeichnung nach BDEW-Artikelnummerliste |
|
gueltigBis (optional) |
date |
Gültigkeitsende |
|
gueltigVon (optional) |
date |
Gültigkeitsbeginn |
ZusatzinformationObis
|
Parameter |
Typ |
Beschreibung |
|
gueltigBis (optional) |
date |
Gültigkeitsende |
|
gueltigVon (optional) |
date |
Gültigkeitsbeginn |
|
obiskennzahl (optional) |
string |
Bezeichnung nach OBIS-Kennzahlen-System |
Abgabe
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
ID der Abgabentyps aus getParameter => abgabenTyp |
|
gueltigVon |
date |
Gültigkeitsende |
|
gueltigBis |
date |
Gültigkeitsbeginn |
|
lasttyp |
int |
Lasttyp (SLP=0 oder RLM=1) |
|
wert |
double |
Preis |
|
preisEinheit |
string |
Einheit des Preises |
|
mengenAngaben |
string |
Mengenangabe |
|
marktgebietID |
int |
ID des Marktgebietes |
|
verbrauchVon |
int |
Verbrauch von |
|
verbrauchBis |
int |
Verbrauch bis |
VersionAntwort
|
BasisAntwort |
object |
siehe Objekt BasisAntwort |
|
version |
string |
Version des Webservices |
|
softwarestand |
decimal |
Version des Softwarestands |
Weitere Informationen
Ausgabeparameterzuordnung zu BDEW-Artikelnummern
|
Ausgabe Webservice Gas Entgelt |
BDEW Artikel |
BDEW Artikelnummer (4.1b) |
|
grundpreis |
Grundpreis |
9990001 00008 7 |
|
wirkarbeit |
Wirkarbeit |
9990001 00026 9 |
|
leistung |
Leistung |
9990001 00005 3 |
|
entgeltFuerEinbauBetrieb WartungMesstechnik |
Entgelt für Einbau, Betrieb und Wartung der Messtechnik |
9990001 00062 3 |
|
entgeltFuerAbrechnung |
Entgelt für Abrechnung |
9990001 00053 2 |
|
entgeltFuerMessung UndAblesung |
Entgelt für Messung und Ablesung |
9990001 00061 5 |
|
konzessionsabgabe |
Konzessionsabgabe |
9990001 00041 7 |
Prozess Rohdatenintegration und -aktualisierung
Für die Integration von Netzentgelten in andere Systeme können die Methoden getEntgelte und getEntgelteUniversal verwendet werden. Die hinterlegten Preisblätter enthalten die vollständigen Rohdaten zu einem Entgelt. Dabei sind die Entgelte generell in SLP und RLM getrennt.
Um ein Preisblatt abfragen zu können, werden die entsprechenden IDs benötigt. Dazu muss die Methode getLokationsEntgeltInfo verwendet werden. Mit Angabe der Örtlichkeit, je genauer desto besser, und Netzbetreiber werden alle seit dem Stichtag gültigen EntgeltIDs ausgegeben. Diese können dann an die Preisblatt-Methoden übergeben und die Rohdaten in das Zielsystem übernommen werden.
Für einen sauberen Updateprozess und die Nachvollziehbarkeit von Änderungen, müssen im Zielsystem folgende Parameter am Entgelt unbedingt mitgeführt werden:
entgeltID, entgeltRootID, gueltigVon, gueltigBis
Außerdem muss vom Zielsystem der zuletzt abgefragte Datenbankstand vorgehalten werden. Nur damit ist eine fehlerfreie Entgeltaktualisierung realisierbar.
Mit Übergabe des zuletzt abgefragten Datenbankstands an die Methode getEntgeltAenderungen werden alle EntgeltIDs zurück gegeben, die seitdem aktualisiert wurden. Gleichzeitig wird das aktuelle Datenbankstand-Datum zurückgegeben. Über die Preisblatt-Methoden können dann die geänderten Entgelte im Zielsystem aktualisiert werden.
Beispiel-Darstellung von Praxisfällen:
1. Fall - Neues Entgelt
Ein Netzbetreiber veröffentlicht ein völlig neues Entgelt zum 01.01.2025 (z.B. wird sein Netzgebiet / idRegion in 2 Gebiete aufgespalten):
a)
CREATEfür eine EntgeltID (In dem Beispiel für das neue Entgelt in dem neuen Gebiet.)
2. Fall - Änderung eines Entgelte
Ein Netzbetreiber veröffentlicht zu einem bestehenden Netzentgelt ein Nachfolgerentgelt zum 01.01.2026:
a)
UPDATEfür die EntgeltID des vorhandenen Entgelts (Dabei wird das Entgelt „abgeschalten", also in dem Beispiel das Gültigkeitsende auf 31.12.2025 gesetzt.)b)
CREATEfür eine EntgeltID (In dem Beispiel wird das Entgelt vom 01.01.2026 hinzugefügt.)
3. Fall - Korrektur eines Entgelts
Ein Netzbetreiber korrigiert ein Netzentgelt (z.B. von vorläufig auf final):
a)
DELETEfür die EntgeltID des bestehenden/alten Entgeltsb)
CREATEfür die EntgeltID, die jetzt als Korrektur des gelöschten Entgelts giltIn diesem Fall wird in der Regel kein UPDATE verwendet, um Inkonsistenzen auszuschließen. Im Einzelfall aber auch möglich:
UPDATEfür die EntgeltID des bestehenden Entgelts
4. Fall – Löschung eines Entgelts
Ein Netzbetreiber hatte ein neues (vorläufiges) Entgelt für 2026 veröffentlicht, welches erfasst wurde. Nachträglich widerruft er die neuen Angaben und das alte Entgelt von 2025 gilt weiterhin.
DELETEfür die EntgeltID des 2026er Entgelts
UPDATEfür die EntgeltID des 2025er Entgelts (Dabei wird das Entgelt wieder „aktiviert“, indem das Gültigkeitsende von 31.12.2025 auf 31.12.9999 gesetzt wird.)
Besonderheiten
Bei der Aktualisierung der Rohdaten sollte stets UPDATE vor CREATE eingespielt werden.
Bei Übergabe von idRegion (Netzgebiet) und/oder stichtag können keine EntgeltIDs mit DELETE übermittelt werden, d.h. ein Entgelt mit CREATE kann ein bestehendes Entgelt ersetzen.
Prozess Rechnungseingangsprüfung anhand von Rohdaten
Über die Methode getLokationsEntgeltInfo werden die notwendigen PreisblattIDs geliefert. Zusätzlich sind in der Rückgabe die entsprechenden Konzessionsabgaben und die zur eindeutigen Identifikation notwendige Ortsschärfe angegeben. Danach können mit der Liste der PreisblattIDs die zugehörigen Preisblätter über die Methode getEntgelte und getEntgelteUniversal abgerufen werden.
Es ist zu empfehlen, ein internes Caching für beide Methoden aufzubauen, denn dadurch können Webserviceanfragen vermieden werden. In Abhängigkeit von der zurückgegebenen notwendigen Ortsschärfe ist meistens nur eine Anfrage pro PLZ notwendig. Dazu müssen natürlich auch die Zeitscheiben beachtet werden.
Weiterhin kann durch Caching der Preisblätter während eines Abrechnungslaufs erheblich Traffic eingespart werden, da jedes Preisblatt nur ein einziges Mal abgerufen werden muss.
Es wäre auch möglich, den Abnahmestellen vorher (permanent) PreisblattIDs zuzuordnen. In diesem Fall müsste jedoch vor jedem Abrechnungslauf die Aktualität der PreisblattIDs geprüft werden.
Dies ist über die Methode getEntgeltAenderungen möglich.
Verwendung der Methode getBerechnungenZeitscheibe
Grundsätzlich wurde die Methode dazu entwickelt, um Netzbetreiberrechnungen (INVOIC) zu prüfen.
Zeiträume
gueltigVon-gueltigBis
Als Abrechnungszeitraum ist hier nicht der gesamte Zeitraum seit der letzten Jahresabrechnung gemeint, sondern der Zeitraum für den die Rechnung gestellt wird.
Abgedeckter Abrechnungszeitraum
Sind Angaben in einem Mengen-Objekte vorhanden, so müssen die übermittelten Zeitscheiben mindestens den Abrechnungszeitraum abdecken.
Überschneidende Zeiträume
Die Zeiträume dürfen sich innerhalb von Mengen, für positive und negative Mengen getrennt betrachtet, nicht überschneiden.
Lückenlose Zeiträume
Die übergebenen Zeiträume dürfen pro Mengen-Objekt keine Lücken aufweisen.
Mengen
Negative Mengen, z.B. bei bereits geleisteten Zahlungen, werden als negative Werte übergeben.
Generell müssen Mengen für denselben Zeitraum, aber getrennt nach positiv und negativ, zusammengefasst werden.
Bei der Verbrauchsaufteilung über die Zeitscheiben hinweg wird die Gradtagstabelle (DIN 4713) angewendet.
Der Nutzer hat die Möglichkeit bspw. über die Methode getLokationsEntgeltInfo die Aufteilung der Entgeltzeitscheiben je Netzbetreiber vorher abzurufen und Mengen selbst zu verteilen. Es werden jedoch meist schon die Zeiträume netzbetreiberseitig in der INVOIC übermittelt.
Vorjahresverbrauch
Über den Parameter verbrauchVorjahr kann der Vorjahresverbrauch oder auch ein eigens prognostizierter Verbrauch übergeben werden, welcher dann bei Identifikation der korrekten Verbrauchsstaffel angewendet wird. Ist kein verbrauchVorjahr übergeben, so wird ggf. eine eigene Hochrechnung anhand der vorhandenen Verbrauchswerte analog zur Verbrauchsaufteilung verwendet.
Abrechnungsmodelle
Die Abrechnungsmodelle werden von der GET AG gepflegt. Da es sich hierbei um nicht öffentliche Informationen handelt, bitten wir alle Nutzer des Services evtl. vorhanden Abweichungen an uns zu kommunizieren.
Als temporäre Lösung für den Anwender besteht die Möglichkeit, die erfassten Modelle zu übersteuern.
Zeitfaktor
Tag – Es wird tagesgenau abgerechnet.
Monat – Es wird monatsbasierend abgerechnet.
Mengenmodell
auffüllendes/kumulierendes Modell -
Die Verbräuche werden über das komplette Abrechnungsjahr stets aufsummiert, um die entsprechende Zielstaffel mit den Preisen zu identifizieren.
Monatsmodell
Es wird jeder Monat für sich allein betrachtet berechnet. Dazu werden die Staffelgrenzen entsprechend des Zeitfaktors gewichtet. Z.B. werden für einen Monat die Staffelgrenzen gezwölftelt. Die Verbräuche der Vorzeiträume werden dabei nicht berücksichtigt.
Netzbetreiber rechnen die Kosten für Messung bzw. Abrechnung entweder zeitbasiert oder vorgangsbasiert ab. Der vom Webservice zurück gegebene Preis (wert) ist immer zeitbasiert.
Eine Differenzierung ist über den Parameter zeitEinheit möglich. Rechnet der Netzbetreiber zeitbasiert ab, ist dies mit DAY gekennzeichnet, wohingegen eine vorgangsbasierte Abrechnung die zeitEinheit PCS besitzt.
Rabatte
Innerhalb der Zeitscheibenmethode (getBerechnungenZeitscheibe) können Rabatte übergeben werden, welche dann im Ergebnis gesondert ausgewiesen werden. Für den Bereich Gas kann der Z01 (Gemeinderabatt) übergeben und ausgewiesen werden:
Z01 Gemeinderabatt (KAV §3):
-
Übergeben wird innerhalb des rabatt-Objektes der Parameter rabattTyp mit „Z01“ und die rabattHoehe in Prozent
-
Der Gemeinderabatt wird auf die Preiskomponenten Arbeitspreis und Leistungspreis angewendet
Zusatzkostenobjekt
Innerhalb der Methode getBerechnungenStichtag können Zusatzkosten gezielt ausgewählt und in der Berechnung berücksichtigt werden. Über das Objekt ZusatzkostenGruppen ist es möglich, pauschal eine Zusatzkostentyp (z.B. Mengenumwerter enthalten: ja=1 /nein=0) auszuwählen, über eine interne Logik wird dann, sofern im Preisblatt angegeben, ein Element des Zusatzkostentyps (z.B. Kompaktmengenumwerter) ausgewählt und im Netzentgelt verrechnet.
Es ist ebenso möglich, über den Parameter zusatzkostenExtended direkt einen Zusatzkostentyp per id (z.B. Temperaturmengenumwerter) auszuwählen, welcher dann, sofern auf dem Preisblatt angegeben, in die Entgeltberechnung einfließt.
Verwendung der Bulk-Berechnungsmethoden
Die Methoden getBerechnungenStichtag und getBerechnungenZeitscheibe ermöglichen eine Bulk-Berechnung zur effizienteren Abfrage größerer Datenmengen.
Die Bulk-Methoden werden analog zu ihren Basis-Methoden befüllt, es ist jedoch möglich, innerhalb der Webservice-Anfrage mehrere Param-Objekte zu übergeben. Im Output werden dann ebenfalls mehrere Objekte zurückgegeben. Zur Identifizierung der Anfragen kann im Parameter uid eine eindeutige Kennung (Typ string) übergeben werden.
Hinweise zur Methode getEntgelteUniversal
Bei der Methode getEntgelteUniversal wird jeder Entgelt-Preisbestandteil in einem eigenen Objekt (preisstellung) ausgegeben. Da diese Objekte eine einheitliche Struktur aufweisen, werden die unterschiedlichen Preiskomponenten (AP, Zählerkosten,…) über eine Kombination aus preisArt und preisID gekennzeichnet.
Dabei ist folgendes zu beachten:
- preisID: eindeutige ID für den Preis in Abhängigkeit von der preisArt -> zu ermitteln über die Methode getParameter
- preisArt:
- 1 - Preis: für Preis_ID siehe Methode getParameter, Objekte „Preis“
- 12 - ZusatzkostenStrom: für Preis_ID siehe Methode getParameter, Objekte „zusatzkostenStrom“
- 13 - ZusatzkostenGas: für Preis_ID siehe Methode getParameter, Objekte „zusatzkostenGas“
Beispiel:
- In der Preisstellung ist die Kombination preisID=6 und preisArt=1 angegeben
- Nun muss in der Methode getParameter nach einem Objekt „Preis“ mit der id „6“ gesucht werden -> dies ist der Artikel „Messung“
Einbindung Ortsinformations-Webservice für netzbetreiberscharfe Kalkulation
Für den Kalkulationsprozess ist es mitunter erforderlich, zu einer konkreten Abnahmestelle (PLZ, Ort, Strasse, Hausnummer) die Netzentgelte zum dort zuständigen Netzbetreiber zu kalkulieren.
Bei den Berechnungsmethoden gibt es nur die Möglichkeit, als Lokation eine PLZ zu übergeben. Zusätzlich kann aber die Verbandsnummer des Netzbetreibers übergeben werden.
Um nun im Vorfeld zu der konkreten Abnahmestelle den Netzbetreiber zu ermitteln, sollte die Methode getOrtsinfoExtended des Ortsinformations-Webservice genutzt werden.
Der Prozess zur hausnummernscharfen Netzentgelt-Kalkulation würde somit wie folgt aussehen:
- Übergabe der Lokations-Parameter an die Methode getOrtsinfoExtended des Ortsinformations-Webservice
- Die ermittelte Verbandsnummer wird zusammen mit der PLZ an die Berechnungsmethode des Netzentgelte-Webservice übergeben
Einen Zugang für den Ortsinformations-Webservice können Sie unkompliziert über das Kontaktformular oder unserem Support (support@get-ag.com) beantragen.
Allgemeine Hinweise
|
Parameter |
Hinweis |
|
Datum |
Alle Datumsangaben sind im Format jjjj-mm-tt. |
|
gueltigBis |
|
|
gueltigVon |
|
|
Preise/Kosten |
|
Berechnungshinweise
Berechnungsarten
Es existieren drei verschiedene Arten wie der Grund-, Arbeits- bzw. Leistungspreis für einen bestimmten Abnahmefall berechnet werden kann.
Stufenpreis: kompletter Verbrauch/Leistung wird mit dem GP/AP/LP der zugehörigen Staffel/Stufe verrechnet
Zonenpreis: der/die gesamte oder anteilige Verbrauch/Leistung wird zur Berechnung in der jeweiligen Zone heran gezogen bzw. die Grundpreise entsprechende summiert.
Staffelpreis (Vorzonengrundpreis/Sockelpreis): lediglich der/die in der zugehörigen Staffel angefallene Verbrauch/Leistung wird verrechnet.
Diese werden nachstehend beispielhaft für den Arbeitspreis auf Grundlage folgender Angaben erläutert: Abnahme 15.000kWh
|
Abnahmemenge von in kWh |
Abnahmemenge bis in kWh |
Arbeitspreis in ct/kWh |
|
0 |
2.000 |
2,5 |
|
2.001 |
10.000 |
1,8 |
|
10.001 |
50.000 |
1,4 |
Stufenpreis = 15.000 * 1,4 = 210 €
Zonenpreis = (2.000 * 2,5) + (8.000 * 1,8) + (5.000*1,4) = 264 €
Staffelpreis = 5.000 * 1,4 = 70 €
Zählergrößenmapping
|
Leistung (exkl.) von in kW |
Leistung (inkl.) bis in kW |
Zählergröße |
|
0 |
17 |
1,6 |
|
17 |
26 |
2,5 |
|
26 |
48 |
4 |
|
48 |
80 |
6 |
|
80 |
100 |
8 |
|
100 |
128 |
10 |
|
128 |
200 |
16 |
|
200 |
320 |
25 |
|
320 |
520 |
40 |
|
520 |
560 |
45 |
|
560 |
800 |
65 |
|
800 |
1.280 |
100 |
|
1.280 |
2.000 |
160 |
|
2.000 |
2.500 |
200 |
|
2.500 |
3.200 |
250 |
|
3.200 |
3.750 |
300 |
|
3.750 |
5.000 |
400 |
|
5.000 |
7.500 |
600 |
|
7.500 |
8.000 |
650 |
|
8.000 |
12.800 |
1.000 |
|
12.800 |
18.000 |
1.500 |
|
18.000 |
20.000 |
1.600 |
|
20.000 |
32.000 |
2.500 |
|
32.000 |
52.000 |
4.000 |
|
52.000 |
0 |
6.500 |
Optionale Komponente
Nicht für alle Ausgaben stehen immer entsprechende Informationen zur Verfügung. Welche Parameter oder Objekte optional sind, ist in den jeweiligen Objekt- bzw. Felddefinitionen beschrieben.
Optionale Objekte sind durch die Kennzeichnung „(0:n-Beziehung)“ erkennbar. Parameter oder Felder, für die keine verwertbaren Informationen vorliegen können oder deren Angabe bei einer Anfrage nicht zwingend erforderlich ist, sind mit „(optional)“ gekennzeichnet. So verfügen beispielsweise nur wenige Netzbetreiber über eine ILN.
Wird für ein Ausgabefeld keine verwertbare Information gefunden, wird der Wert abhängig vom verwendeten Schnittstellenprotokoll leer bzw. als null geliefert.
Wird für den Parameter „stichtag“ kein Wert übergeben, wird standardmäßig das aktuelle Datum verwendet.
Objekt dynamischeAngaben
Das Objekt „dynamischeAngaben“ dient dem Zweck auf mögliche zukünftige Anforderungen hinsichtlich Steuerung bzw. Filterung der Ausgabe reagieren zu können, ohne eine Strukturanpassung am Webservice durchführen zu müssen.
Zum Objekt dynamischeAngaben gehören folgende Unterobjekte.
IdObjGruppe
|
Parameter |
Typ |
Beschreibung |
|
intIdObj |
object |
Siehe Objekt IntIdObj |
|
doubleIdObj |
object |
Siehe Objekt DoubleIdObj |
|
stringIdObj |
object |
Siehe Objekt StringIdObj |
|
dateIdObj |
object |
Siehe Objekt DateIdObj |
IntIdObj
|
Parameter |
Typ |
Beschreibung |
|
BasisIdObj |
object |
Siehe Objekt BasisIdObj |
|
listenWert |
int |
Übergabe eines int-Listenwertes |
|
wert |
int |
Übergabe eines int-Wertes |
DoubleIdObj
|
Parameter |
Typ |
Beschreibung |
|
BasisIdObj |
object |
Siehe Objekt BasisIdObj |
|
listenWert |
double |
Übergabe eines double-Listenwertes |
|
wert |
double |
Übergabe eines double-Wertes |
StringIdObj
|
Parameter |
Typ |
Beschreibung |
|
BasisIdObj |
object |
Siehe Objekt BasisIdObj |
|
listenWert |
string |
Übergabe eines string-Listenwertes |
|
wert |
string |
Übergabe eines string-Wertes |
DateIdObj
|
Parameter |
Typ |
Beschreibung |
|
BasisIdObj |
object |
Siehe Objekt BasisIdObj |
|
listenWert |
date |
Übergabe eines date-Listenwertes |
|
wert |
date |
Übergabe eines date-Wertes |
BasisIdObj
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
Übergabe einer ID |
|
name |
string |
Übergabe eines Namen |
|
beschreibung |
string |
Übergabe einer Beschreibung |
Beispiele der Ausgabe dynamischer Angaben
getBerechnungenStichtag (Gasbeschaffungsumlage)
getBerechnungenStichtag (Gasbeschaffungsumlage)
<ns2:dynamischeAngaben>
<ns2:intObj wert="7" name="marktgebietID"/>
<ns2:doubleObj wert="2.419" name="referenzwert"/>
<ns2:stringObj wert="beschaffungsumlage-details" name="bezeichner"/>
<ns2:stringObj wert="Trading Hub Europe H-Gas" name="marktgebietName"/>
<ns2:stringObj wert="37Y005053MH0000R" name="marktgebietEIC"/>
</ns2:dynamischeAngaben>
getBerechnungenZeitscheibe (Gasspeicherumlage)
<ns2:dynamischeAngaben>
<ns2:intObj wert="8" name="marktgebietID"/>
<ns2:doubleObj wert="10000.0" name="menge"/>
<ns2:doubleObj wert="5.9E-4" name="referenzwert"/>
<ns2:doubleObj wert="5.9" name="wert"/>
<ns2:stringObj wert="speicherumlage-details" name="bezeichner"/>
<ns2:stringObj wert="KWH" name="mengeEinheit"/>
<ns2:stringObj wert="NA" name="zeitEinheit"/>
<ns2:dateObj wert="2022-10-01" name="gueltigVon"/>
<ns2:dateObj wert="2023-03-31" name="gueltigBis"/>
</ns2:dynamischeAngaben>
Objekt berechnungsKonfiguration
Über das Objekt berechnungsKonfiguration können zusätzliche Einstellungen getätigt werden. Im Moment sind die folgenden Optionen definiert:
Rundung ausschalten
Standardmäßig werden die Parameter in den Berechnungsmethoden (getBerechnungenStichtag und getBerechnungenZeitscheibe) gerundet. Der Nutzer hat jedoch die Möglichkeit, die Rundung über die Berechnungskonfiguration auszuschalten.
Dies wird über die berechnungsKonfiguration id „2“ gesteuert.
berechnungsKonfiguration id="2" wert="0" (default)
Die Rundung ist eingeschaltet. Die Parameter werden somit wie folgt gerundet:
Methode getBerechnungenZeitscheibe:
-
Berechnete Werte werden mit 2 Nachkommastellen ausgegeben
-
Referenzwerte (Bezeichnung „referenzwert“) werden mit bis zu 6 Nachkommastellen ausgegeben; dies betrifft alle Detail-Objekte
Methode getBerechnungenStichtag:
-
Alle berechneten Werte werden mit 2 Nachkommastellen ausgegeben
-
Referenzwerte (Bezeichnung „referenzwert“) werden mit bis zu 6 Nachkommastellen ausgegeben; dies betrifft das Objekt „pauschalkosten“
-
Die berechneten Werte (Bezeichnung „wert“) innerhalb des „pauschalkosten“-Objektes werden mit 2 Nachkommastellen ausgegeben
-
Die Mengen (Bezeichnung „menge) innerhalb des „pauschalkosten“-Objektes werden mit bis zu 2 Nachkommastellen ausgegeben
berechnungsKonfiguration id="2" wert="1"
Die Rundung ist ausgeschaltet. Die berechneten Parameter werden somit ungerundet ausgegeben.
Einstellbare Rundungen
Mit der berechnungsKonfiguration id="20" kann die Rundung in den Berechnungsmethoden folgendermaßen übersteuert werden:
|
Request - Auszug |
Art der Rundung |
|
<objs1:berechnungsKonfiguration id="20" name="Rundungsmodus" wert="0"/>
|
Rundung für Rohdaten und berechnete Wert ist deaktiviert. Es werden alle Nachkommastellen ausgegeben |
|
<objs1:berechnungsKonfiguration id="20" name="Rundungsmodus" wert="1"/> |
Ist gleichzeitig die Defaulteinstellung, wenn die Berechnungskonfiguration nicht übergeben wird. Rohdaten werden mit 4 Nachkommastellen und berechnete Werte mit 2 Nachkommastellen gerundet ausgegeben. Fehlende Nachkommastellen werden mit 0en aufgefüllt. |
|
<objs1:berechnungsKonfiguration id="20" name="Rundungsmodus" wert="2"/> |
Rohdaten werden mit 2 Nachkommastellen und berechnete Werte mit 2 Nachkommastellen gerundet ausgegeben. Fehlende Nachkommastellen werden mit 0en aufgefüllt. |
|
<objs1:berechnungsKonfiguration id="20" name="Rundungsmodus" wert="3"/> |
Rohdaten werden mit 3 Nachkommastellen und berechnete Werte mit 3 Nachkommastellen gerundet ausgegeben. Fehlende Nachkommastellen werden mit 0en aufgefüllt. |
Beispiel für Ausgabe von ungerundeten Werten:
…
<objs1:berechnungsKonfiguration id="20" name="Rundungsmodus" wert="0"/>
…
Fehlersuche
Bei FehlerCode 1 sind keine Fehler bei der Anfrage des Webservice aufgetreten.
Bei FehlerCode 500 bis 600 überprüfen Sie bitte die eingegebenen Authentifizierungsdaten und wenden sich ggf. unter Angabe Ihres Benutzernamens an den Support der GET AG.
Bei FehlerCode 2 und 700 wenden Sie sich bitte unter Angabe der vollständigen Input-Parameter an den Support der GET AG.
Bei FehlerCode 700 ff. prüfen Sie bitte zuerst Ihre Eingabe. Der zurückgegebene Fehlertext gibt einen Hinweis darauf, an welcher Stelle der Fehler aufgetreten ist. Ggf. kann über die EntgeltID das Preisblatt abgerufen werden, um die Eingabe zu verifizieren.
Bitte senden Sie zu jeder Anfrage an den Support der GET AG auch folgende Angaben mit:
-
Webservice-Bezeichnung und –Versionsnummer
-
verwendete Methode
-
FehlerCode; iTag
Kontaktformular und Testzugang
Haben Sie Fragen zur API oder möchten eine Dokumentation erhalten oder einen Testzugang beantragen, dann nutzen sie bitte unser Kontaktformular: