Energieliefervertrag lesen - MACO APP

Lesen des Energieliefervertrages einer Lokation (Parameter1) vom Typ (Parameter2 - default MALO) zum Stichtag (Parameter3)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

parameter1

string

required

LokationsId

Default:

74018657187

Example:

74018657187

parameter2

enum<string>

required

LokationsTyp

Allowed values:

MALOMELONELOTECHNISCHE_RESSOURCESTEUERBARE_RESOURCETRANCHE

Default:

MALO

Example:

MALO

parameter3

string <date-time>

required

Datum (Gültig ab) oder Stichtag, wenn parameter4 nicht gesetzt

Example:

2024-06-28T12:18:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

parameter4

string <date-time>

required

Datum (Gültig bis)

Example:

2024-06-28T12:18:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

command

string

optional

Entspricht der operationId dieser Schnittstelle. Diese Operation Id entspricht dem Command im Camunda Konnektor Prozess. Wenn das Backend einen generischen Endpunkt bereitstellt, kann dieses Command gentutzt werden um zu definieren welche Operation ausgeführt werden soll.

Example:

SAP_LESEN_ENERGIELIEFERVERTRAG_BASIS

Responses

🟢200OK

application/json

Erfolgreiches Lesen des Energieliefervertrages

Body

boTyp

enum<string>

required

Typ des BO

Allowed values:

ANSPRECHPARTNERAVISENERGIEMENGEGESCHAEFTSOBJEKTGESCHAEFTSPARTNERMARKTLOKATIONMARKTTEILNEHMERMESSLOKATIONZAEHLERKOSTENTARIFPREISBLATTPREISBLATTNETZNUTZUNGPREISBLATTMESSUNGPREISBLATTUMLAGENPREISBLATTDIENSTLEISTUNGPREISBLATTKONZESSIONSABGABEZEITREIHELASTGANGHANDELSUNSTIMMIGKEITANFRAGEAUFTRAGSTATUSMITTEILUNGBERECHNUNGSFORMELRECHNUNGBILANZIERUNGNETZNUTZUNGSVERTRAGMESSSTELLENBETRIEBSVERTRAGENERGIELIEFERVERTRAGSPERRAUFTRAGANGEBOTTRANCHEKOMMUNIKATIONSDATENZAEHLZEITDEFINITIONSCHALTZEITDEFINITIONLEISTUNGSKURVENDEFINITIONNETZLOKATIONSTEUERBARE_RESSOURCETECHNISCHE_RESSOURCEAD_HOC_STEUERKANALLOKATIONSBUENDELWERTE_NACH_TYP2REKLAMATIONSTATUSBERICHTVERTRAGBILANZKREISVERWENDUNGSZEITRAUMTARIFINFO

versionStruktur

string

required

obligatory version of the BO4E definition. Currently hard coded to 1

Default:

sparte

enum<string>

optional

Unterscheidungsmöglichkeiten für die Sparte. Siehe ENUM Sparte

Allowed values:

STROMGASFERNWAERMENAHWAERMEWASSERABWASSER

Example:

STROM

vertragsart

string

optional

Hier ist festgelegt, um welche Art von Vertrag es sich handelt. Z.B. Netznutzungvertrag. Details siehe ENUM
Vertragsart

vertragsnummer

string

optional

Eine im Verwendungskontext eindeutige Nummer für den Vertrag

beschreibung

string

optional

Freitext zur Beschreibung der Konditionen, z.B. "Standardkonditionen Gas"

lokationsId

string

optional

lokationsId

lokationsTyp

enum<string>

optional

Gibt an, ob es sich um eine Markt- oder Messlokation handelt

Allowed values:

MALOMELONELOTECHNISCHE_RESSOURCE

vertragsstatus

enum<string>

optional

Vertragstatus

Allowed values:

IN_ARBEITUEBERMITTELTANGENOMMENAKTIVABGELEHNTWIDERRUFENSTORNIERTGEKUENDIGTBEENDET

vertragsbeginn

string <date-time>

optional

Gibt an, wann der Vertrag beginnt.

vertragsende

string <date-time>

optional

Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde.

gemeinderabatt

integer

optional

gemeinderabatt für EDIFACT mapping.

vertragskonditionen

object (Vertragskonditionen)

optional

Festlegungen zu Laufzeiten und Kündigungsfristen. Details siehe COM Vertragskonditionen

netznutzungszahler

enum<string>

optional

Netznutzungszahler

Allowed values:

KUNDELIEFERANT

netznutzungsvertrag

enum<string>

optional

Netznutzungsvertrag

Allowed values:

KUNDEN_NBLIEFERANTEN_NB

netznutzungsabrechnung

object (Zeitraum)

optional

beinhaltetSingulaerGenutzteBetriebsmittel

boolean

optional

Singulär genutzte Betriebsmittel in der Netznutzungsabrechnung
Hier wird angegeben, ob in der Netznutzungsabrechnung der verbrauchenden Marktlokation singulär
genutzte Betriebsmittel abgerechnet werden.

netznutzungsabrechnungsgrundlage

enum<string>

optional

Netznutzungsabrechnungsgrundlage

Allowed values:

LIEFERSCHEINABWEICHENDE_GRUNDLAGE

netznutzungsabrechnungsvariante

enum<string>

optional

Netznutzungsabrechnungsvariante

Allowed values:

ARBEITSPREIS_GRUNDPREISARBEITSPREIS_LEISTUNGSPREIS

haushaltskunde

boolean

optional

haushaltskunde

abrechnungUeberNna

boolean

optional

abrechnungUeberNna

gemeinderabatt

object (Gemeinderabatt)

optional

startAbrechnungsjahr

string <date-time>

optional

startAbrechnungsjahr

naechstenetznutzungsabrechnung

string

optional

naechstenetznutzungsabrechnung

abrechnungsintervall

integer

optional

abrechnungsintervall

netznutzungsabrechnungIntervall

integer

optional

netznutzungsabrechnungIntervall

geplanteTurnusablesung

object (Zeitraum)

optional

beauftragungMsb

enum<string>

optional

BeauftragungMsb

Allowed values:

VERTRAG_AN_MSBVERTRAGSBEENDIGUNG_MSB

kuendigungsfrist

object (Zeitraum)

optional

Innerhalb dieser Frist kann der Vertrag gekündigt werden. Details Zeitraum

vertragslaufzeit

object (Zeitraum)

optional

Über diesen Zeitraum läuft der Vertrag. Details Zeitraum

kuendigungstermin

string

optional

kuendigungstermin

abschlagszyklus

object (Zeitraum)

optional

In diesen Zyklen werden Abschläge gestellt. Details Zeitraum. Alternativ kann auch die Anzahl
in den Konditionen angeben werden."

anzahl_abschlaege

number <float>

optional

Anzahl der vereinbarten Abschläge pro Jahr, z.B. 12

beschreibung

string

optional

Freitext zur Beschreibung der Konditionen, z.B. "Standardkonditionen Gas"

vertragsverlaengerung

object (Zeitraum)

optional

Falls der Vertrag nicht gekündigt wird, verlängert er sich automatisch um die hier angegebene Zeit. Details
Zeitraum

korrespondenzpartner

object (Geschaeftspartner)

optional

korrespondenzpartner für EDIFACT mapping

Example:

{"$ref":"https://raw.githubusercontent.com/conuti-gmbh/bo4e-schema/master/docs/examples/bo/Geschaeftspartner.json"}

boTyp

enum<string>

required

Typ des BO

Allowed values:

versionStruktur

string

required

versionStruktur

Default:

anrede

string

optional

Die Anrede für den GePa, Z.B. Herr.

name1

string

optional

Erster Teil des Namens. Hier kann der Firmenname oder bei Privatpersonen
beispielsweise der Nachname dargestellt werden. Beispiele: Yellow Strom GmbH
oder Hagen

name2

string

optional

Zweiter Teil des Namens. Hier kann der eine Erweiterung zum Firmennamen oder
bei Privatpersonen beispielsweise der Vorname dargestellt werden. Beispiele:
Bereich Süd oder Nina

name3

string

optional

Dritter Teil des Namens. Hier können weitere Ergänzungen zum Firmennamen oder
bei Privatpersonen Zusätze zum Namen dargestellt werden. Beispiele: und Afrika
oder Sängerin

name4

string

optional

name4

umsatzsteuerId

string

optional

Die Umsatzsteuer-ID des Geschäftspartners. Beispiel: DE 813281825

glaeubigerId

string

optional

Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird- Z.B. DE 47116789

emailAdresse

string

optional

emailAdresse

website

string

optional

Internetseite des Marktpartners. Beispiel: www.mp-energie.de

gewerbekennzeichnung

boolean

optional

Kennzeichnung ob es sich um einen Gewerbe/Unternehmen (gewerbeKennzeichnung = true)
oder eine Privatperson handelt. (gewerbeKennzeichnung = false)

hrnummer

string

optional

Handelsregisternummer des Geschäftspartners

amtsgericht

string

optional

Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat

partneradresse

object (Adresse)

optional

Adresse des Geschäftspartners, an der sich der Hauptsitz befindet. Details

externeKundenummerLieferant

string

optional

externeKundenummerLieferant

externeReferenzen

array[object (ExterneReferenz) {2}]

optional

Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer) (Details siehe
ExterneReferenz)

geschaeftspartnerrolle

array[string]

optional

Rolle, die der Geschäftspartner hat (z.B. Interessent, Kunde).

Allowed values:

KUNDELIEFERANTDIENSTLEISTERINTERESSENTMARKTPARTNEREIGENTUEMERHAUSVERWALTERKORRESPONDENZEMPFAENGERABLESEKARTENEMPFAENGER

kontaktweg

array[string]

optional

Bevorzugter Kontaktweg des Geschäftspartners.

Allowed values:

ANSCHREIBENTELEFONATFAXE_MAILSMS

abrechnungUeberNna

boolean

optional

abrechnungUeberNna

datenqualitaet

enum<string>

optional

Datenqualitaet

Allowed values:

ERWARTETE_DATENIM_SYSTEM_VORHANDENE_DATENINFORMATIVE_DATENGUELTIGE_DATENKEINE_DATENIM_SYSTEM_KEINE_DATEN_VORHANDENKEINE_DATEN_ERWARTETDIFFERENZ_DATENDIFFERENZ_ERWARTETE_DATENDIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN

gueltigkeitszeitraum

object (Zeitraum)

optional

vertragspartner1

array[object (Geschaeftspartner) {19}]

optional

Der "erstgenannte" Vertragspartner. In der Regel der Aussteller des Vertrags. Beispiel: "Vertrag zwischen
Vertagspartner 1 ..." Siehe BO Geschaeftspartner

boTyp

enum<string>

required

Typ des BO

Allowed values:

versionStruktur

string

required

versionStruktur

Default:

anrede

string

optional

Die Anrede für den GePa, Z.B. Herr.

name1

string

optional

Erster Teil des Namens. Hier kann der Firmenname oder bei Privatpersonen
beispielsweise der Nachname dargestellt werden. Beispiele: Yellow Strom GmbH
oder Hagen

name2

string

optional

Zweiter Teil des Namens. Hier kann der eine Erweiterung zum Firmennamen oder
bei Privatpersonen beispielsweise der Vorname dargestellt werden. Beispiele:
Bereich Süd oder Nina

name3

string

optional

Dritter Teil des Namens. Hier können weitere Ergänzungen zum Firmennamen oder
bei Privatpersonen Zusätze zum Namen dargestellt werden. Beispiele: und Afrika
oder Sängerin

name4

string

optional

name4

umsatzsteuerId

string

optional

Die Umsatzsteuer-ID des Geschäftspartners. Beispiel: DE 813281825

glaeubigerId

string

optional

Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird- Z.B. DE 47116789

emailAdresse

string

optional

emailAdresse

website

string

optional

Internetseite des Marktpartners. Beispiel: www.mp-energie.de

gewerbekennzeichnung

boolean

optional

Kennzeichnung ob es sich um einen Gewerbe/Unternehmen (gewerbeKennzeichnung = true)
oder eine Privatperson handelt. (gewerbeKennzeichnung = false)

hrnummer

string

optional

Handelsregisternummer des Geschäftspartners

amtsgericht

string

optional

Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat

partneradresse

object (Adresse)

optional

Adresse des Geschäftspartners, an der sich der Hauptsitz befindet. Details

externeKundenummerLieferant

string

optional

externeKundenummerLieferant

externeReferenzen

array[object (ExterneReferenz) {2}]

optional

Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer) (Details siehe
ExterneReferenz)

geschaeftspartnerrolle

array[string]

optional

Rolle, die der Geschäftspartner hat (z.B. Interessent, Kunde).

Allowed values:

KUNDELIEFERANTDIENSTLEISTERINTERESSENTMARKTPARTNEREIGENTUEMERHAUSVERWALTERKORRESPONDENZEMPFAENGERABLESEKARTENEMPFAENGER

kontaktweg

array[string]

optional

Bevorzugter Kontaktweg des Geschäftspartners.

Allowed values:

ANSCHREIBENTELEFONATFAXE_MAILSMS

vertragspartner2

array[object (Geschaeftspartner) {19}]

optional

Der "zweitgenannte" Vertragspartner. In der Regel der Empfänger des Vertrags. Beispiel "Vertrag zwischen
Vertagspartner 1 und Vertragspartner 2". Siehe BO Geschaeftspartner

boTyp

enum<string>

required

Typ des BO

Allowed values:

versionStruktur

string

required

versionStruktur

Default:

anrede

string

optional

Die Anrede für den GePa, Z.B. Herr.

name1

string

optional

Erster Teil des Namens. Hier kann der Firmenname oder bei Privatpersonen
beispielsweise der Nachname dargestellt werden. Beispiele: Yellow Strom GmbH
oder Hagen

name2

string

optional

Zweiter Teil des Namens. Hier kann der eine Erweiterung zum Firmennamen oder
bei Privatpersonen beispielsweise der Vorname dargestellt werden. Beispiele:
Bereich Süd oder Nina

name3

string

optional

Dritter Teil des Namens. Hier können weitere Ergänzungen zum Firmennamen oder
bei Privatpersonen Zusätze zum Namen dargestellt werden. Beispiele: und Afrika
oder Sängerin

name4

string

optional

name4

umsatzsteuerId

string

optional

Die Umsatzsteuer-ID des Geschäftspartners. Beispiel: DE 813281825

glaeubigerId

string

optional

Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird- Z.B. DE 47116789

emailAdresse

string

optional

emailAdresse

website

string

optional

Internetseite des Marktpartners. Beispiel: www.mp-energie.de

gewerbekennzeichnung

boolean

optional

Kennzeichnung ob es sich um einen Gewerbe/Unternehmen (gewerbeKennzeichnung = true)
oder eine Privatperson handelt. (gewerbeKennzeichnung = false)

hrnummer

string

optional

Handelsregisternummer des Geschäftspartners

amtsgericht

string

optional

Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat

partneradresse

object (Adresse)

optional

Adresse des Geschäftspartners, an der sich der Hauptsitz befindet. Details

externeKundenummerLieferant

string

optional

externeKundenummerLieferant

externeReferenzen

array[object (ExterneReferenz) {2}]

optional

Hier können IDs anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer) (Details siehe
ExterneReferenz)

geschaeftspartnerrolle

array[string]

optional

Rolle, die der Geschäftspartner hat (z.B. Interessent, Kunde).

Allowed values:

KUNDELIEFERANTDIENSTLEISTERINTERESSENTMARKTPARTNEREIGENTUEMERHAUSVERWALTERKORRESPONDENZEMPFAENGERABLESEKARTENEMPFAENGER

kontaktweg

array[string]

optional

Bevorzugter Kontaktweg des Geschäftspartners.

Allowed values:

ANSCHREIBENTELEFONATFAXE_MAILSMS

enFG

array[object (EnFG) {2}]

optional

enFG

grundlageVerringerungUmlagen

enum<string>

optional

GrundlageVerringerungUmlagen

Allowed values:

ERFUELLT_VORAUSSETZUNG_NACH_ENFGERFUELLT_NICHT_VORAUSSETZUNG_NACH_ENFGKEINE_ANGABE

grund

array[string]

optional

Grund der Umlagenverringerung

Allowed values:

ENFG_STROMSPEICHER_UND_VERLUSTENERGIEENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPENENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASENENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFFENFG_STROMKOSTENINTENSIVE_UNTERNEHMENENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMENENFG_SCHIENENBAHNENENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHRENFG_LANDSTROMANLAGEN

Example

{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "boTyp": "VERTRAG",
        "versionStruktur": "1",
        "gueltigkeitszeitraum": {
          "zeitraumId": null,
          "startdatum": null,
          "enddatum": null
        },
        "datenqualitaet": null,
        "vertragsnummer": "12345",
        "beschreibung": "XYZ",
        "vertragsart": "ENERGIELIEFERVERTRAG",
        "vertragstatus": "GEKUENDIGT",
        "sparte": "STROM",
        "vertragsbeginn": "0001-01-01T00:00:00Z",
        "vertragsende": "9999-12-31T23:59:59Z",
        "vertragspartner2": [
          {
            "boTyp": "GESCHAEFTSPARTNER",
            "versionStruktur": "1",
            "gewerbekennzeichnung": false,
            "anrede": "Herr",
            "name1": "Haiko",
            "name2": "Fisch",
            "name3": null,
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "partneradresse": {
              "postleitzahl": "65189",
              "ort": "Wiesbaden",
              "strasse": "Korallenweg",
              "hausnummer": "10",
              "postfach": null,
              "adresszusatz": null,
              "coErgaenzung": null,
              "landescode": "DE",
              "ortsteil": "Riff"
            },
            "externeReferenzen": [
              {
                "exRefName": "Kundennummer beim Altlieferanten",
                "exRefWert": "NummerLFA123456_Z01"
              }
            ]
          }
        ],
        "vertragskonditionen": {
          "kuendigungsfrist": {
            "zeitraumText": null
          },
          "kuendigungstermin": "2025-07-31T23:00:00Z",
          "abrechnungsintervall": null
        },
        "korrespondenzpartner": {
          "boTyp": "GESCHAEFTSPARTNER",
          "versionStruktur": "1",
          "anrede": "Herr",
          "name1": "Hai",
          "name2": "Fisch",
          "name3": null,
          "gewerbekennzeichnung": false,
          "partneradresse": {
            "postleitzahl": "65189",
            "ort": "Wiesbaden",
            "strasse": "Körallenweg",
            "hausnummer": "10",
            "postfach": null,
            "adresszusatz": null,
            "coErgaenzung": null,
            "landescode": "DE",
            "ortsteil": "Riff"
          }
        },
        "lokationsId": "50754496000",
        "lokationsTyp": "MALO",
        "enFG": [
          {
            "grundlageVerringerungUmlagen": "KEINE_ANGABE",
            "grund": [
              null
            ]
          }
        ]
      }
    ]
  }
}

🟠400Bad Request