Wofür wird die GET AG Unternehmensinformation 2.1 API eingesetzt?
Die GET AG Unternehmensinformation 2.1 API ermöglicht die gebündelte Abfrage unterschiedlicher Unternehmensdaten zu Versorgungsunternehmen im Bereich Strom und Gas. Dazu gehören unteranderem Unternehmensstammdaten, Marktrollen und Verbandsnummern, EDIFACT-Daten, Ansprechpartner, Bankdaten, Servicedaten sowie weitere relevante Informationen der Energiewirtschaft.
Die bereitgestellten Daten können für die manuelle oder automatisierte Verarbeitung z.B. in in bestehende Abrechnungs-, ERP- und Fachanwendungen wie SAP, DATEV, Wilken ENER:GY, Schleupen CS.MP oder SIV kVASy genutzt werden.
Je nach Anwendungsfall unterstützen die Daten beispielsweise die Stammdatenpflege, Zahlungs-und Abrechnungswesen, sowie Lieferantenwechsel, Bilanzkreismanagement, Netzanmeldungen und Netzabmeldungen sowie die Marktkommunikation.
Die wichtigsten Informationen auf einen Blick
|
Produktmerkmal |
GET AG Unternehmensinformation 2.1 API |
|
Funktion |
Bereitstellung von Unternehmensinformation und weiteren Informationen zu Marktpartnern der Energiewirtschaft im Bereich Strom und Gas, korrekte Adressierung von Marktinformationen |
|
Unternehmensstammdaten |
Firmierung, Rechtsform, Anschrift, Handelsregister-, Steuer- und Kontaktdaten |
|
Marktrollen und Verbandsnummern |
Marktrollen sowie 13-stellige BDEW-, VDEW- und DVGW-Nummern beziehungsweise ILN |
|
Marktkommunikationsdaten |
EDIFACT-Adressen inkl. Angaben zu Verschlüsselung, Signatur, Komprimierung, Zertifikaten und EDIFACT-Formaten |
|
Kontakt- und Servicedaten |
Ansprechpartner oder Abteilung mit Angabe der Marktrolle, dem Typ (z.B. Netznutzung, Bilanzkreismanagement, Netzanmeldung oder Netzabmeldung), Kontaktdaten; sowie Serviceart, Servicezeiten |
|
Bank- und Nachweisdaten |
Bankverbindungen inkl. IBAN/Kontonummer, Bankinformationen und Gläubiger-ID. Wiederverkäuferbescheinigung einschließlich Wiederverkäufereigenschaft mit Gültigkeitsangaben als Nachweis für Reverse-Charge-Verfahren (RC-Verfahren) |
|
Netz-und Gebietsdaten |
Bilanzierungsgebiet-EIC, Regelzone-EIC und Schaltzeiten |
|
Zeitbezug |
Berücksichtigung von Gültigkeitszeiträumen bei verschiedenen Unternehmens-, Marktrollen- und weiteren Angaben |
|
Zielgruppen |
Energieversorger, Stadtwerke, Netzbetreiber, energiewirtschaftliche Dienstleister sowie Product Owner und Entwickler |
|
Typische Einsatzbereiche |
Stammdatenpflege, Marktpartneridentifikation, Marktkommunikation, Zahlungs-, Netz- und Abrechnungsprozesse |
|
Schnittstellen |
SOAP/JAX-WS und REST/JAX-RS |
|
API-Dokumentation |
SwaggerUI |
|
Systemumgebungen |
Test- und Produktivsystem |
Vorteile der GET AG Unternehmensinformation 2.1 API
-
Zentraler und Vereinfachter Zugriff auf unterschiedliche Unternehmensdaten:
Stammdaten, Marktrollen, EDIFACT-Adressen, Ansprechpartner, Bankdaten und weitere Informationen über einen Webservice statt aus mehreren Quellen - Eindeutige Identifikation und Zuordnung von Versorgungsunternehmen und Marktrollen: Unternehmen, Marktrollen und zugehörige Verbandsnummern können eindeutig verknüpft und für weitere Abfragen genutzt werden
- Einfacher Abruf von EDIFACT-Adressen und technischen Angaben für den elektronischen Datenaustausch, Verschlüsselung, Signatur, Komprimierung, Zertifikate sowie Ansprechperson und Servicedaten stehen für Marktkommunikation, Lieferantenwechsel, sowie Netzanmeldungen und Netzabmeldungen zur Verfügung
- Eine Anbindung für mehrere Geschäftsprozesse: Die API kann für Stammdatenpflege, Marktkommunikation sowie Zahlungs-, Netz- und Abrechnungsprozesse genutzt werden.
- Direkte Einbindung in bestehende Systeme: Die Daten können in bestehende Abrechnungs-, ERP- und Fachanwendungen wie SAP, DATEV, Wilken ENER:GY, Schleupen CS.MP oder SIV kVASy integriert werden
- 25 Jahre Erfahrung in der Datenbereitstellung für den Energiemarkt und Aufbau von Webservices
- Unkomplizierte Beantragung eines kostenlosen Testzugangs über das unten stehende Kontaktformular
Anwendungsfälle im Überblick
-
Anlegen und Aktualisieren der Stammdaten von Versorgungsunternehmen in eigene IT-Systeme
-
Identifikation von Marktpartner für Lieferantenwechsel sowie Netzanmeldung und Netzabmeldungen
-
Bereitstellen von Bankdaten und Wiederverkäuferbescheinigungen für kaufmännische Prozesse
Anlegen und Aktualisieren der Stammdaten von Versorgungsunternehmen in eigene IT-Systeme
Beschreibung:
Unternehmensstammdaten wie Firmierung, Rechtsform, Anschrift sowie Register-, Steuer- und Kontaktdaten können in bestehende Abrechnungs-, ERP- oder andere Fachsysteme übernommen und dort gepflegt werden.
Für die Identifikation des Unternehmens und dessen Marktrollen steht die Methode getVersorgerInfo zur Verfügung. Weitere Detailinformationen wie z.B. Firmierung, Rechtsform, Anschrift, Handelsregisternummer oder Steuerinformationen werden über getVersorgerDetailInfo bereitgestellt.
Nutzen:
-
zentrale Bereitstellung und Aktualisierung von Stammdaten
-
Reduzierung manueller Recherche- und Stammdatenpflege
Identifikation von Marktpartner für Lieferantenwechsel sowie Netzanmeldung und Netzabmeldungen
Beschreibung:
Für Lieferantenwechsel sowie Netzan- und -abmeldungen werden das relevante Versorgungsunternehmen, seine Marktrolle und die zugehörige Verbandsnummer benötigt. Diese Informationen können über die Methode getVersorgerInfo ermittelt und bei Bedarf über getParameter fachlich zugeordnet werden.
Nutzen:
-
Identifikation des richtigen Marktpartners und Bestimmung der relevanten Marktrolle
-
Ermittlung der zugehörige Verbandsnummer
Abruf von Marktkommunikation und EDIFACT-Daten
Beschreibung:
Für die elektronische Marktkommunikation können die zur jeweiligen Marktrolle gehörenden EDIFACT E-Mail-Adressen sowie Angaben zu Verschlüsselung, Signatur, Komprimierung, Zertifikaten und Formaten bereitgestellt werden. Der Abruf erfolgt über getEdifactDaten.
Die Daten können unter anderem in der Marktkommunikation für UTILMD, INVOIC, PARTIN und PRICAT verwendet werden.
Nutzen:
-
Bereitstellung marktrollenbezogener Kommunikationsadressen
-
Unterstützung elektronischer Marktkommunikation inkl. Bereitstellung technischer Angaben zu Verschlüsselung, Signatur und Komprimierung nach BDEW
- Pflege von EDIFACT-Kommunikationsdaten in eigene IT-Systeme
Ermittlung von Ansprechpartner und Servicedaten
Beschreibung:
Für fachliche Rückfragen oder operative Betriebsvorgänge können zuständige Personen und Abteilungen einschließlich Funktion und Kontaktdaten ermittelt werden.
getAnsprechpartner liefert Ansprechpartner beziehungsweise zuständige Abteilungen eines Unternehmens. Die Abfrage kann unter anderem nach Marktrolle und Funktion erfolgen.
Über getServiceDaten können zusätzlich veröffentlichte Servicezeiten sowie Telefon- und Faxnummern von Strom- und Gaslieferanten abgerufen werden.
Nutzen:
-
Ermittlung zuständiger Personen und Abteilungen
-
Unterstützung von Netzanmeldungs-, Netzabmeldungs- und weiteren Prozessen
-
Pflege von Kontakt- und Servicedaten, z.B. in CRM-Systemen
Bereitstellen von Bankdaten und Wiederverkäuferbescheinigungen für kaufmännische Prozesse
Beschreibung:
Für das Rechnungswesen und den Zahlungsverkehr können hinterlegte Bankverbindungen eines Marktpartners abgerufen und in eigene Abrechnungs- oder ERP-Systeme gepflegt und verwendet werden. Zusätzlich stellt die API Wiederverkäuferbescheinigungen für steuerliche Nachweiszwecke bereit.
Der Abruf erfolgt über die Methoden getBankdaten und getWiederverkaeuferbescheinigung.
Nutzen:
-
Bereitstellung von Bankdaten für Stammdaten- und Zahlungsprozesse
-
marktrollenbezogene Zuordnung von Bankverbindungen eines Marktparners
-
Abruf von Wiederverkäufernachweisen
-
Unterstützung umsatzsteuerlicher Prozesse
Ermitteln der Bilanzierungsgebiet-EIC und Schaltzeiten
Beschreibung:
Über getBilanzierungsgebietEIC können der EIC eines Bilanzierungsgebiets und der EIC der zugehörigen Regelzone abgerufen werden.
Mit getSchaltzeiten können veröffentlichte Schaltzeiten eines Netzbetreibers für einen ausgewählten Zeitraum ausgegeben werden. Die Abfrage kann unter anderem nach SLP/RLM, Entgelttyp sowie Schwachlast- oder Sperrzeit eingeschränkt werden.
Nutzen:
-
Bereitstellung von Bilanzierungsgebiet- und Regelzoneninformationen
-
Abruf veröffentlichter HT-/NT-, Schwachlast- und Sperrzeiten
-
Nutzung in netz- und tarifbezogenen Prozessen
-
Weiterverarbeitung in eigenen Anwendungen
Hinweise zur Integration
Für Product Owner
Vor der Integration sollte festgelegt werden, welche Daten der Unternehmensinformation 2.1 API für den jeweiligen Anwendungsfall benötigt werden.
Checkliste für Product Owner
-
Passt der Webservice zu meinem Anwendungsfall?
Z. B. Stammdatenpflege, Marktpartneridentifikation, Marktkommunikation oder Rechnungswesen, Zahlungsverkehr, Lieferantenwechsel, Netzan-/abmeldung - Für welche Marktrollen werden die Daten benötigt und für welchen Bereich?
Z.B. Marktrollen wie z.B. Lieferant, Netzbetreiber oder Messtellenbetreiber, sowie Bereiche wie Strom oder Gas - Welche Daten werden für den Anwendungsfall bzw. Prozess benötigt?
Z. B. Nur Unternehmensstammdaten wie Firmierung, Anschrift, Marktpartnerkennungen, steuerliche Angaben, Unternehmenslogos oder auch EDIFACT-Adressen, Bank- und Nachweisdaten und Serviceinformation -
Benötige ich weitere energiewirtschaftliche Fachdaten?
Z. B. Bilanzierungsgebiet-EIC oder Schaltzeiten
Hinweise für Softwareentwickler - SwaggerUI und API Cliententwicklung
SwaggerUI
Für die Anbindung stehen ein Test- und ein Produktivservice zur Verfügung. Für beide Systeme ist eine Swagger-Dokumentation für Test- und Produktivservice verfügbar.
Die WSDL- und WADL-URLs sowie die Links zur SwaggerUI für Test- und Produktivservice finden Sie hier in der Technischen Dokumentation.
Für den Einstieg in die SwaggerUI steht dort außerdem eine Anleitung am Beispiel der Methode getVersion zur Verfügung.
Für die Nutzung des Testservices sind Zugangsdaten erforderlich. Diese werden über den GET AG Support bereitgestellt beziehungsweise können über das Kontaktformular angefragt werden.
Client-Entwicklung
Für die Cliententwicklung stehen SOAP- und REST-Schnittstellen zur Verfügung. Beim SOAP-Protokoll wird die WSDL verwendet. Für REST kann die YAML-/OpenAPI-Beschreibung aus der SwaggerUI verwendet werden.
Mehr Informationen für Softwareentwickler zur Clientgenerierung gibt es hier.
Weitere Hinweise zu Zertifikaten, Authentifizierung, Freischaltung und Anfrageverhalten finden Sie in der Technischen Dokumentation.
FAQ
Wofür wird die GET AG Unternehmensinformation 2.1 API eingesetzt?
Die API stellt Stammdaten und prozessrelevante Informationen zu Marktpartnern der Energiewirtschaft bereit. Sie kann z.B. für Stammdatenpflege, Marktpartneridentifikation, Marktkommunikation sowie für Zahlungs-, Netz- und Abrechnungsprozesse eingesetzt werden.
Welche Daten stellt die GET AG Unternehmensstammdaten 2.1 API bereit?
Die API stellt unterschiedliche Unternehmensdaten zu Versorgungsunternehmen bereit. Dazu gehören Stammdaten, Marktrollen und Verbandsnummern, EDIFACT-Daten, Ansprechpartner, Servicedaten, Bankdaten, Wiederverkäuferbescheinigungen, Bilanzierungsgebiet-EIC sowie Schaltzeiten. Die jeweils verfügbaren Informationen werden über unterschiedliche Methoden des Webservices abgefragt.
Welche Unternehmensstammdaten können über die API abgefragt werden?
Die API liefert Stammdaten eines ausgewählten Versorgungsunternehmens. Dazu gehören unter anderem Versorgername, Kurzname, Rechtsform, Anschrift, Homepage, E-Mail-Adresse, Telefonnummer, Handelsregisternummer, Amtsgericht, Steuernummer und Umsatzsteuer-Identifikationsnummer.
Welche Daten stehen für die Marktkommunikation zur Verfügung?
Über die Methoden getEdifactDaten kann z.B. die EDIFACT-Adressen der Marktpartner bereitgestellt werden, welche in der Marktkommunikation Verwendung finden (z.B. UTILMD, INVOIC, PARTIN, PRICAT). Die erfolgreiche Serviceantwort liefert dann unter anderem die Marktrollen, die E-Mail-Adresse zur Marktkommunikation und Informationen zur Verschlüsselung, Signatur, Komprimierungen und Formaten, Zusätzlich können Sie die Abfrage anhand der gezielten Marktrolle, wie zum Beispiel Lieferant, Netzbetreiber oder Messstellenbetreiber konkretisieren.
Können Marktrollen und zugehörige Kennungen abgefragt werden?
Ja. Über die Methode getVersorgerInfo können Basisinformationen des Versorgungsunternehmens und die zugehörigen Marktrollen ausgegeben werden. Die Marktrollen enthalten unter anderem eine Marktrollen-ID, die zugehörige Verbandsnummer sowie Angaben zur zeitlichen Gültigkeit.
Können Ansprechpartner und Kontaktadressen abgefragt werden?
Ja. Über getAnsprechpartner können marktrollen- und funktionsbezogene Ansprechpartner beziehungsweise Abteilungen sowie deren Kontaktdaten abgerufen werden. Der Service liefert Information mit Angabe der Marktrolle, dem Typ (z.B. Netznutzung, Bilanzkreismanagement, Netzanmeldung oder Netzabmeldung) und den Kontaktdetails, wie Telefonnummer oder E-Mail-Adresse.
Können Bankdaten von Marktpartnern über die API abgerufen werden?
Ja. Über die Methode getBankdaten liefert die zu einem Versorgungsunternehmen hinterlegten Bankverbindungen. Dazu gehören unter anderem die IBAN beziehungsweise Kontonummer, der Bankverbindungstyp, der Name der Bank und die Gläubiger-ID.
Die Bankverbindungen können je nach Abfrage für einen konkreten Versorger oder für mehrere Versorger innerhalb eines Zeitraums ausgegeben werden.
Können Wiederverkäuferbescheinigungen abgefragt werden?
Ja. Die API kann Informationen zu Wiederverkäuferbescheinigungen einschließlich Gültigkeitszeitraum und Dokumentverweisen bereitstellen.
Können Bilanzierungsgebiet-EIC und Regelzone-EIC abgefragt werden?
Ja. getBilanzierungsgebietEIC liefert sowohl den EIC des Bilanzierungsgebiets als auch den EIC der zugehörigen Regelzone.
Stellt die API Unternehmenslogos bereit?
Logos werden nicht standardmäßig ausgeliefert. Sie stehen über ein separates Untermodul zur Verfügung, sofern eine entsprechende Freischaltung und Freigabe des Versorgers vorliegt.
Können Schaltzeiten von Versorgungsunternehmen abgefragt werden?
Ja. Der Zugriff erfolgt über getSchaltzeiten und stellt die am Versorger hinterlegten Schaltzeiten als Rohdaten bereit. Die Daten können unter anderem Angaben zu SLP und RLM, Entgelttyp, Schwachlast- beziehungsweise Sperrzeit, Gültigkeitszeitraum, Tagestyp, Uhrzeiten und Zeitzonentyp enthalten.
Welche Schnittstellen stehen zur Verfügung?
Die Unternehmensinformation 2.1 API unterstützt SOAP/JAX-WS und REST/JAX-RS. Zusätzlich stehen SwaggerUI sowie WSDL, WADL und YAML-/OpenAPI-Beschreibungen zur Verfügung.
Technische Dokumentation
Beschreibung
API Stammdaten Unternehmen - URL und Endpunkte
WSDL für Testservice
http://webservicetest1.ag-server.de/getagWSCore/jaxws/UnternehmensInfoService21x0?wsdl
WADL für Testservice
http://webservicetest1.ag-server.de/getagWSCore/jaxrs/UnternehmensInfoService21x0/application.wadl
WSDL für produktiven Service (SSL)
https://webservice1.ag-server.de/getagWSCore/jaxws/UnternehmensInfoService21x0?wsdl
WADL für produktiven Service (SSL)
https://webservice1.ag-server.de/getagWSCore/jaxrs/UnternehmensInfoService21x0/application.wadl
Weiterhin steht Ihnen eine API-Dokumentation per Swagger zur Verfügung:
Produktiver Service
Test-Service
Weitere technische Merkmale und Anforderungen, wie z.B. zu Zertifikaten, Authentifizierung, Freischaltung oder Hinweise zum Anfrageverhalten, finden Sie in der Technischen Dokumentation zu den Webservices.
Anleitung Nutzung SwaggerUI am Beispiel getVersion
Für einen einfachen Einstieg in unsere Welt der API steht Ihnen die Swagger UI unseres Testsystems zur Verfügung:
SwaggerUI für Stammdaten Unternehmen Webservice
Bitte beachten Sie, dass es sich hierbei um die Testservices handelt, welche nur Testdaten (Region Sachsen) enthalten und nicht permanent erreichbar sein müssen. Die GET AG aktualisiert das Testsystem zudem planmäßig jeden Donnerstag von 10-11 Uhr.
Ihre Zugangsdaten haben Sie über unseren Support erhalten oder, falls noch nicht, können Sie sich im Kontaktformular der GET AG Webservices eigene anfordern.
Die Zugangsdaten tragen Sie bitte nach Klick auf „Authorize“ der Swagger UI unter „Username:“ und „Password:“ ein und bestätigen mittels „Authorize“.
Client-Entwicklung
Bei der Implementierung können Sie den SOAP-Endpunkt und die clientseitige Komprimierung verwenden. Für die Client-Entwicklung nutzen Sie entweder die YAML Datei aus der Swagger UI oder die hier aufgeführten URL und Endpunkte der API.
Hinweis: Beim SOAP-Protokoll verwenden Sie bitte die WSDL und für das REST-Protokoll ist die YAML-Spezifikation entscheidend.
Tipps für Softwareentwickler zur Clientgenerierung aus der OpenAPI Beschreibung oder YAML Datei gibt es hier.
Methoden-Übersicht
getVersion
Eingabe: <>
Ausgabe: <Version>
getVersion liefert Ihnen, ohne die Übergabe von spezifischer Request-Daten, die Versionsinformationen bzw. den Softwarestand des Service zurück und sie ist nützlich, um die grundsätzliche Service-Erreichbarkeit des anfragenden Systems zu testen.
getVersorgerInfo
Eingabe:<VersorgerInfo>
Ausgabe:<VersorgerInfoResponse> < VersorgerMarktrolle>
Diese Methode kann von Ihnen als Einstieg für den Webservice verwendet werden, um die Marktpartner-ID der Marktrollen zu den übergebenen Parametern zu bestimmen. Das ist unter anderem die Unternehmensbezeichnung, die BDEW / DVGEW Codenummer / GLN (global location number) sowie die Marktrollen, wie zum Beispiel Lieferant, Netzbetreiber oder Messstellenbetreiber.
Weitere Informationen siehe auch Kapitel 7, Punkt „getVersorgerInfo“.
getVersorgerDetailInfo
Eingabe:<VersorgerInfo>
Ausgabe:<VersorgerDetailInfo> <VersorgerDetailInfoUrl>
Liefert die Stammdaten zu dem ausgewählten Versorgungsunternehmen zurück.
Über die interne versorgerID und das Medium Strom oder Erdgas können unter anderem :
-
Firmierung (z.B. Stromnetz Berlin GmbH),
-
Firmenadresse, Handelsregisternummer
-
Steuernummer
-
verschiedene URL-Typen wieder, deren Aufruf auf die unterschiedlichen Datenblätter der Unternehmen führt (z.B. Kontaktdatenblatt Westnetz),
-
Impressum
-
sowie Ansprechpartner abgerufen werden.
Hinweis zu Unternehmenslogos:
Logos werden über ein separates Untermodul bereitgestellt und erfordern eine vorherige Freischaltung. Aufgrund der Nutzungsrechte dürfen die Logos-URLS nicht direkt verlinkt werden;. Der Hintergrund ist, dass wir von den jeweiligen Versorgern eine Freigabe für die Verwendung der Logos in unserem System erhalten haben und nicht für die Weitergabe. Damit Ihnen immer die gesamten Logos zur Verfügung stehen, bitten wir Sie 1x täglich die Daten zu cachen.
getEdifactDaten
Eingabe:<VersorgerInfo>
Ausgabe:<EdifactDaten>
Die Methode getEdifactDaten dient der Bereitstellung von EDIFACT-Adressen der Marktpartner, welche in der Marktkommunikation Verwendung finden (z.B. UTILMD, INVOIC, PARTIN, PRICAT).
Die erfolgreiche Serviceantwort liefert unter anderem:
-
die Marktrolle,
-
die E-Mail-Adresse zur Marktkommunikation
-
und Information zur Verschlüsselung, Signatur und Komprimierung.
Zusätzlich können Sie die Abfrage anhand der gezielten Marktrolle, wie zum Beispiel Lieferant, Netzbetreiber oder Messstellenbetreiber, präzisieren.
getAnsprechpartner
Eingabe:<VersorgerInfo>
Ausgabe:<Ansprechpartner>
Mit Hilfe dieser Methode erhalten Sie die richtigen Ansprechpartner des gewünschten Unternehmens.
Mit der Webservice-Anfrage ist es Ihnen möglich, gezielt nach den in der GET AG Datenbank gespeicherten Kontaktdaten einer Person oder Abteilung der Firma zu suchen.
Der Service liefert Information mit Angabe:
- der Marktrolle,
- dem Typ (z.B. Netznutzung, Bilanzkreismanagement, Netzanmeldung oder Netzabmeldung)
- und den Kontaktdetails, wie Telefonnummer oder E-Mail-Adresse.
Die Online-Bereitstellung der Stammdaten von Ansprechpartnern in der Energiewirtschaft vereinfacht die Stammdatenpflege in Ihrem genutzten System.
getParameter
Eingabe: <>
Ausgabe: <Parameter>
Bei der Methode getParameter handelt es sich um eine wichtige informatorische Methode, welche die Namensauflösung der Parameter-IDs ausgibt. Sie ist vor allem bei der Anbindung hilfreich, um die Parameter-IDs in den jeweiligen Methoden zuordnen zu können. Beispielsweise können Sie darüber die im System verwendeten Markrollen-IDs oder Ansprechpartnertypen nachschlagen.
getWiederverkaeuferbescheinigung
Eingabe: <VersorgerInfo>
Ausgabe: <Wiederverkäuferbescheinigung>
Die Methode getWiederverkaeuferbescheinigung ermöglicht die Abfrage von Wiederverkäufernachweisen / Wiederverkäuferbescheinigungen und im Ergebnis wird, neben der Marktrolle und dem Gültigkeitsdatum, eine URL ausgegeben, über die Sie sich das Dokument ansehen können.
Damit erhalten Sie einen Nachweis für die korrekte Umsetzung des umsatzsteuerlichen Reverse-Charge-Verfahren (Umkehr der Steuerschuldnerschaft bzw. RC-Verfahren).
getBankdaten
Eingabe: <VersorgerInfo>
Ausgabe: <BankDaten>
Mit der Methode getBankdaten wird die zu einem Marktpartner gespeicherte Bankverbindungen bereitgestellt.
Die Ausgabe von Bankdaten bzw. Kontodaten ist Ihnen mit der Methode getBankdaten möglich. Marktrollenspezifisch können Sie pro Marktpartner den SWIFT-Code (BIC), die Bankverbindung (IBAN) und die Gläubiger-Identifikationsnummer abfragen. Zusätzlich wird die Information zur Quelle, z.B. vom Kontaktdatenblatt, der Kontodaten geliefert. Diese Daten eignen sich nicht nur für die Aktualisierung der Stammdaten, sondern auch für automatische Zahlungsprozesse.
Eingabe: <VersorgerInfo>
Ausgabe:<Servicedaten>
Mit dem Abruf der Service-Daten erhalten Sie die von Strom- bzw. Gaslieferanten veröffentlichen Zeiten der Erreichbarkeit. Neben den Wochentagen und den Uhrzeiten, in dem der Service des Unternehmen erreichbar ist, wird durch die Methode auch die hinterlegte Telefonnummer bzw. Faxnummer wiedergegeben.
Eingabe: <VersorgerInfo>
Ausgabe:<BilanzierungsgebietEIC>
Durch Übergabe der versorgerspezifischen internen ID oder der BDEW Codenummer, zusätzlich zur Wahl des Mediums Strom oder Gas, ermöglicht Ihnen diese Methode die Ausgabe des EIC (Energy Identification Code) des Bilanzierungsgebiets des Unternehmens. Neben dem Gültigkeitszeitraum wird auch der EIC der zuständigen Regelzone angezeigt.
Eingabe: <Schaltzeiten>
Ausgabe:<SchaltzeitenResponse>
Liefert die Schaltzeiten eines Netzbetreibers für den gewählten Zeitraum zurück.
Die veröffentlichten Schaltzeiten eines Netzbetreibers, auch HT/NT, Schwachlastzeiten oder Sperrzeit genannt, können Sie sich anhand dieser Methode ausgegeben lassen. Nach Angabe des Unternehmens und Wahl von Filterparametern (z.B. SLP/RLM, allgemeiner Entgelttyp, steuerbare Verbrauchseinrichtung, etc.) liefert Ihnen diese Methode, neben der Gültigkeit im Jahr, Angaben zum Wochentagestyp, zur Uhrzeit bzw. zum Zeitzonentyp (HT/NT) und ob die Schaltzeitangabe durch die Umstellung der Sommerzeit beeinflusst wird.
Objektdefinitionen
Version
|
Parameter |
Typ |
Beschreibung |
|
softwarestand |
int |
Zeitpunkt des Servicestarts |
|
version |
string |
Version des Webservices |
|
Parameter |
Typ |
Beschreibung |
|
medium |
int |
0 = Strom 1 = Erdgas |
|
gueltigVon |
date |
Startdatum der Abfrage |
|
gueltigBis (optional) |
date |
Enddatum der Abfrage |
|
versorgerID (0:n) |
int |
Interne ID des Versorgers |
|
marktrolleID (0:n) |
int |
ID der Marktrolle, siehe ID-Spezifikation der Parameter |
|
verbandsnummer (0:n) |
string |
13-stellige BDEW/VDEW/DVGW-Nummer oder ILN |
|
versorgerName |
string |
Name des Versorgers |
|
versorgerSitz |
string |
Sitz des Versorgers |
VersorgerInfoResponse
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
versorgerRootID |
int |
Interne Root ID des Versorgers |
|
versorgerName |
string |
Name des Versorgers |
VersorgerMarktrolle
|
Parameter |
Typ |
Beschreibung |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode ID-Spezifikation der Parameter |
|
verbandsnummer |
string |
13-stellige BDEW/VDEW/DVGW-Nummer oder ILN |
|
verbandsnummerKurz |
string |
VDEW ID |
|
gueltigVon |
date |
Gültigkeit der Marktrolle (Startdatum) |
|
gueltigBis* |
date |
Gültigkeit der Marktrolle (Enddatum) |
*wenn gueltigBis nicht angegeben, dann ist marktrolleID bis auf Weiteres gültig
VersorgerDetailInfo
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
versorgerName |
string |
Name des Versorgers |
|
kurzName |
string |
Kurzname des Versorgers |
|
gueltigVon |
date |
Gültigkeit des Versorgers (Startdatum) |
|
gueltigBis |
date |
Gültigkeit des Versorgers (Enddatum) |
|
rechtsForm |
string |
Rechtsform des Versorgers |
|
markenID |
int |
Interne ID der Marke des Versorgers |
|
plz |
string |
Postleitzahl |
|
ort |
string |
Ort |
|
strasse |
string |
Straße |
|
hausnummer |
string |
Hausnummmer |
|
postfach |
string |
Postfach |
|
postfachPLZ |
string |
Postfach PLZ |
|
postfachORT |
string |
Postfach ort |
|
staat |
string |
Staat |
|
homepage |
string |
Internetseite des Versorgers |
|
|
string |
Mailadresse des Versorgers |
|
telefon |
string |
Telefonnummer des Versorgers |
|
fax |
string |
Faxnummer des Versorgers |
|
handelsregisterNummer |
string |
Handelsregisternummer |
|
amtsgericht |
string |
Amtsgericht |
|
steuerNummer |
string |
Steuernummer |
|
ustIdNummer |
string |
Umsatzsteueridentifikationsnummer |
VersorgerDetailInfoUrl
|
Parameter |
Typ |
Beschreibung |
|
urlTyp |
int |
ID der Url, siehe ID-Spezifikation der Parameter |
|
url |
string |
Name des Versorgers |
EdifactDaten
|
Parameter |
Typ |
Beschreibung |
|
verschluesslung |
int |
ID der Verschlüsselung, siehe ID-Spezifikation der Parameter |
|
verschluesslungIn |
int |
ID der Verschlüsselung, siehe ID-Spezifikation der Parameter |
|
verschluesslungOut |
int |
ID der Verschlüsselung, siehe ID-Spezifikation der Parameter |
|
verschluesslungEmail |
string |
Mailadresse für Informationen zur Verschlüsselung |
|
signaturIn |
int |
ID der Signatur, siehe ID-Spezifikation der Parameter |
|
signaturOut |
int |
ID der Signatur, siehe ID-Spezifikation der Parameter |
|
signaturVerfahren |
int |
ID der Signatur, siehe ID-Spezifikation der Parameter |
|
signaturEmail |
string |
Mailadresse für Informationen zur Signatur |
|
komprimierungIn |
int |
ID der Komprimierung, siehe ID-Spezifikation der Parameter |
|
komprimierungOut |
int |
ID der Komprimierung, siehe ID-Spezifikation der Parameter |
|
maxGroesseIn |
double |
Info maximale Dateigröße für eingehende E-Mails |
|
maxGroesseOut |
double |
Info maximale Dateigröße für ausgehende E-Mails |
|
zertifikatUrl |
string |
URL für Download der Zertifikate |
|
gueltigVon |
date |
Startdatum der Edifactdaten |
|
gueltigBis |
date |
Enddatum der Edifactdaten |
|
versorgerID |
int |
Interne ID des Versorgers |
|
Parameter |
Typ |
Beschreibung |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode ID-Spezifikation der Parameter |
|
|
string |
Mailadresse für elektronischen Datenaustausch (Edifact) |
|
gueltigVon |
date |
Gültigkeit der Mailadresse für elektronischen Datenaustausch (Startdatum) |
|
gueltigBis |
date |
Gültigkeit der Mailadresse für elektronischen Datenaustausch (Enddatum) |
EdifactDetail Formate
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
ID des Edifactformates, siehe ID-Spezifikation der Parameter |
|
version |
string |
Version des Edifactformates |
|
gueltigVon |
date |
Gültigkeit des Edifactformates (Startdatum) |
|
gueltigBis |
date |
Gültigkeit des Edifactformates (Enddatum) |
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode getParameter |
|
funktion |
int |
ID des Ansprechpartnertyps, siehe ID-Spezifikation der Parameter |
|
anrede |
string |
Anrede des Ansprechpartners |
|
titel |
string |
Titel des Ansprechpartners |
|
vorname |
string |
Vorname des Ansprechpartners |
|
nachname |
string |
Nachname des Ansprechpartners |
|
telefon |
string |
Telefonnummer des Ansprechpartners |
|
fax |
string |
Faxnummer des Ansprechpartners |
|
|
string |
Mailadresse des Ansprechpartners |
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode ID-Spezifikation der Parameter |
|
telefon |
string |
Servicetelefonnummer |
|
serviceArt |
string |
Bezeichnung des Servicedienstes |
|
fax |
string |
Servicefaxnummer |
|
serviceTage |
string |
Servicetage |
|
serviceZeitVon |
string |
Beginn der Servicezeit |
|
serviceZeitBis |
string |
Ende der Servicezeit |
|
gueltigVon |
date |
Gültigkeit der Servicedaten (Startdatum) |
|
gueltigBis |
date |
Gültigkeit der Servicedaten (Startdatum) |
Parameter
|
Parameter |
Typ |
Beschreibung |
|
id |
int |
ID des Parameters |
|
beschreibung |
string |
Bezeichnung des Parameters, siehe ID-Spezifikation der Parameter |
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode ID-Spezifikation der Parameter |
|
linkOriginal |
string |
Link zur Wiederverkäuferbescheinigung auf der Versorgerseite |
|
linkGeneriert |
string |
Link zur Wiederverkäuferbescheinigung zum Downloadordner der Get AG |
|
istWiederverkaeufer |
boolean |
Kennzeichnung, ob Unternehmen Wiederverkäufer ist |
|
gueltigVon |
string |
Startdatum der Wiederverkäuferbescheinigung |
|
gueltigBis |
string |
Enddatum der Wiederverkäuferbescheinigung |
Bankdaten
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
marktrolleID |
int |
ID der Marktrolle, siehe Methode ID-Spezifikation der Parameter |
|
bankSchluessel |
string |
Bankleitzahl des Versorgers |
|
bankverbindungstyp |
int |
ID des Bankverbindungstyps, siehe Methode getParameter |
|
kontoSchluessel |
string |
IBAN/Kontonummer des Versorgers |
|
bank |
string |
Name der Bank |
|
bemerkung |
string |
nähere Informationen |
|
gueltigVon |
date |
Startdatum der Abfrage |
|
gueltigBis (optional) |
date |
Enddatum der Abfrage |
|
glaeubigerID |
string |
Gläubiger-ID |
Schaltzeiten
|
Parameter |
Typ |
Beschreibung |
|
medium |
int |
0 = Strom 1 = Erdgas |
|
gueltigVon |
date |
Startdatum der Abfrage |
|
gueltigBis (optional) |
date |
Enddatum der Abfrage |
|
versorgerID |
int |
Interne ID des Versorgers |
|
verbandsnummer (0:n) |
string |
13-stellige BDEW/VDEW/DVGW-Nummer oder ILN |
|
schwachlast |
int |
0 = Sperrzeit 1 = Schwachlast |
|
RLM |
int |
1 = Abfrage für RLM |
|
SLP |
int |
1 = Abfrage für SLP |
|
normal |
int |
1 = Abfrage für Normaltarif |
|
waermepumpe |
int |
1 = Abfrage für Wärmepumpe |
|
speicherheizung |
int |
1 = Abfrage für Speicherheizung |
|
sonstige |
int |
1 = Abfrage für Elektromob., steuerb. VE |
SchaltzeitenResponse
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
schaltzeitID |
int |
Interne Schaltzeiten-ID |
|
schaltzeitName |
string |
Interner Schaltzeitenname |
|
gueltigVon |
date |
Startdatum der Schaltzeit |
|
gueltigBis |
date |
Enddatum der Schaltzeit |
|
SLP |
int |
1 = gültig für SLP |
|
RLM |
int |
1 = gültig für RLM |
|
normal |
int |
1 = gültig für Normaltarif |
|
schwachlast |
int |
0 = Sperrzeit 1 = Schwachlast |
|
waermepumpe |
int |
1 = gültig für Wärmepumpe |
|
speicherheizung |
int |
1 = gültig für Speicherheizung |
|
sonstige |
int |
1 = gültig für Elektromob., steuerb. VE |
|
umstellungMESZ |
int |
1 = Unterscheidung nach Sommerzeit und Winterzeit |
|
datumVon |
date |
Anfang des Geltungsbereichs des Zeitfensters über das Jahr |
|
datumBis |
date |
Ende des Geltungsbereichs des Zeitfensters über das Jahr |
|
tagTyp |
Int |
Typ des Tages, siehe Methode getParameter |
|
tagName |
string |
tagTyp-Bezeichnung |
|
uhrzeitVon |
string |
Uhrzeitbeginn der Schaltzeit |
|
uhrzeitBis |
string |
Uhrzeitende der Schaltzeit |
|
zeitzonenTyp |
int |
ID des Zeitzonentyps, siehe Methode getParameter |
|
zeitzonenName |
string |
Bezeichnung des Zeitzonentyps |
|
status |
int |
0 = Schaltzeit nicht veröffentlicht 1 = Schaltzeit veröffentlicht |
Bilanzierungsgebiet EIC
|
Parameter |
Typ |
Beschreibung |
|
versorgerID |
int |
Interne ID des Versorgers |
|
versorgerName |
string |
Name des Versorgers |
|
verbandsnummer |
string |
13-stellige BDEW/VDEW/DVGW-Nummer oder ILN |
|
bezeichnung |
string |
*vorerst nicht gefüllt* |
|
bilanzierungsgebietEIC |
string |
EIC des Bilanzierungsgebiets |
|
regelzoneEIC |
string |
EIC der Regelzone |
|
gueltigVon |
date |
Startdatum des EIC |
|
gueltigBis |
date |
Enddatum des EIC |
Das Objekt „dynamischeAngaben“ ist in der aktuellen Version des Unternehmen Webservice ohne Funktion und muss von Ihnen somit nicht übergeben werden.
Zweck dieses Objektes ist es, dass die GET AG auf mögliche zukünftige Anforderungen hinsichtlich der Übergabe im Request und der Steuerung bzw. Filterung der Ausgabe im Response reagieren kann, ohne eine Strukturanpassung am Webservice durchführen zu müssen.
Zum Objekt dynamischeAngaben gehören folgende Unterobjekte.
|
Parameter |
Typ |
Beschreibung |
|
intIdObj |
object |
Siehe Objekt IntIdObj |
|
doubleIdObj |
object |
Siehe Objekt DoubleIdObj |
|
stringIdObj |
object |
Siehe Objekt StringIdObj |
|
dateIdObj |
object |
Siehe Objekt DateIdObj |
|
Parameter |
Typ |
Beschreibung |
|
BasisIdObj |
object |
Siehe Objekt BasisIdObj |
|
listenWert |
int |
Übergabe eines int-Listenwertes |
|
wert |
int |
Übergabe eines int-Wertes |
|
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 |
Optionale Parameter/Objekte
Optionale Parameter sind mit der Bemerkung „(optional)“ und optionale Objekte mit „(0:n Beziehung)“ gekennzeichnet.
Dabei richtet sich die Kennzeichnung bei den Request-Parametern nach der fachlichen Anforderung. Die Kennzeichnung der Response-Parameter und -objekte als optional richtet sich allein nach der technischen Spezifikation.
ID-Spezifikation der Parameter
Die aktuellen IDs für die jeweiligen Parameter können in der Methode getParameter eingesehen werden.
getVersorgerInfo
Bei der Methode getVersorgerInfo muss beachtet werden, dass die beiden Parameter verbandsnummer und marktrolleID nicht gleichzeitig, also in Kombination, übergeben werden können.
Erlaubt ist nur die Übergabe von einem der beiden Parameter.
Bei der Ausgabe der Bankverbindungen in der Methode getBankdaten müssen Sie folgendes beachten.
Die Bankverbindungen werden durch unser Team in der Datenbank mit einem der folgenden Typen erfasst:
– INVOIC
– Kontaktdatenblatt
– Sonstige
Die Bankverbindungstyp-ID wird durch den Webservice ausgegeben und die Definition können Sie in der Methode getParameter einsehen.
Übergabe einer versorgerID:
Wenn Sie die Bankdaten zu einem konkreten Versorger (Übergabe versorgerID und ggf. marktrolle) anfragen, gibt der Webservice alle Bankverbindungen aus, die in der Datenbank erfasst wurden. Dies ist ein wesentlicher Unterschied zur Webservice-Vorgängerversion und die Ausgabe folgt damit auch keiner Rankinglogik mehr.
Übergabe keiner versorgerID:
Wenn die Bankdaten zu allen Versorgern (keine Übergabe einer versorgerID) angefragt werden, gibt der Webservice alle für den Zeitraum erfassten Bankverbindungen aus.
getSchaltzeiten
Die Methode getSchaltzeiten dient der Rohdatenausgabe der Schaltzeiten eines Versorgers. Die Abfrage kann auf den Lasttyp, Entgelttyp und die Schwachlast- bzw. Sperrzeit eingeschtränkt werden.
getBilanzierungsgebietEIC
Die Methode getBilanzierungsgebietEIC ermöglicht die Rohdatenausgabe des EIC zu einem bestimmten Bilanzierungsgebiet eines Netzbetreibers.
Zusätzlich wird über das Objekt regelzoneEIC der EIC des entsprechenden ÜNBs geliefert. Bitte beachten Sie, dass die Zuordnung von bilanzierungsgebietEIC zu regelzoneEIC der Angabe des BDEW entspricht.
Fehlermeldungen / Fehlersuche
Sollte bei Ihrer Anfrage ein Fehler auftreten, dann wird ebenfalls das Ergebnisobjekt zurückgegeben. Dieses beinhaltet in der ersten Ebene einen Antwortstatus.
Die einzelnen Codes werden mit der entsprechenden Fehlerbegründung. nachstehend aufgelistet.
Mit Ergebnis
1 antwortStatus – Ok, Abfrage erfolgt.
Ohne Ergebnis
2 antwortStatus – (Bitte wenden Sie sich unter Angabe der vollständigen Input-Parameter an den Support der GET AG.)
400 antwortStatus – Diese Funktion wird zur Zeit nicht unterstützt.
500 bis 600 antwortStatus – Der Nutzer konnte nicht authentifiziert werden. (Bitte überprüfen Sie die eingegebenen Authentifizierungsdaten und wenden sich ggf. unter Angabe Ihres Benutzernamens an den Support der GET AG.)
700 ff. antwortStatus – Bitte wenden Sie sich unter Angabe der vollständigen Input-Parameter an den Support der GET AG (Prüfen Sie bitte zuerst Ihre Eingabe. Der zurückgegebene Fehlertext gibt einen Hinweis darauf, an welcher Stelle der Fehler aufgetreten ist.
701 antwortStatus – Interner Datenfehler.
800 antwortStatus – Es konnten keine Daten zu den übergebenen Parameter gefunden werden.
801 antwortStatus – Die Kombination der übergebenen Parameter ist ungültig.
802 antwortStatus – Es wurde ein ungültiger Wert in dem Parameter MarktrolleID übergeben.
803 antwortStatus – Es wurde kein Medium übergeben.
804 antwortStatus – Es wurde kein gueltigVon übergeben.
805 antwortStatus – Das Datumsformat des Parameters gueltigVon ist ungültig. Format YYYY-MM-DD.
806 antwortStatus – Das Datumsformat des Parameters gueltigBis ist ungültig. Format YYYY-MM-DD.
Bitte senden Sie zu jeder Anfrage an den Support der GET AG auch folgende Angaben mit:
-
Webservice-Bezeichnung und –Versionsnummer
-
antwortStatus
-
iTag
Kontaktformular
Haben Sie Fragen zur API oder möchten eine Dokumentation erhalten oder einen Testzugang beantragen, dann nutzen sie bitte unser Kontaktformular: