{
"openapi": "3.1.0",
"info": {
"title": "START_VERSAND_BEARB_MELDUNG (NB)",
"version": "202604",
"description": "Das Ereignis `START_VERSAND_BEARB_MELDUNG` der Marktrolle NB als eigenständige Spezifikation, abgeleitet aus der Auslöser-API der Formatversion 202604. Genau ein Pfad: `POST /inbound`; das Ereignis ergibt sich aus `zusatzdaten.eventname` im Rumpf."
},
"servers": [
{
"description": "Fake Env",
"url": "https://api.macoapp.de"
}
],
"tags": [
{
"name": "START_VERSAND_BEARB_MELDUNG"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_VERSAND_BEARB_MELDUNG** der Marktrolle NB.\n\n**Startet diese Rollensichten** (7):\n\n- [Abrechnungsdaten Bilanzkreisabrechnung — NB](/prozessdoku/202604/NB/GPKE-Teil2-abrechnungsdaten-bilanzkreisabrechnung)\n- [Abrechnungsdaten Netznutzungsabrechnung — NB](/prozessdoku/202604/NB/GPKE-Teil2-abrechnungsdaten-netznutzungsabrechnung)\n- [Bestellung einer Änderung von Abrechnungsdaten von LF an NB — NB](/prozessdoku/202604/NB/GPKE-Teil2-bestellung-einer-aenderung-von-abrechnungsdaten-von-lf-an-nb)\n- [Bestellung einer Änderung von Abrechnungsdaten zur Bilanzkreisabrechnung von ÜNB an NB — NB](/prozessdoku/202604/NB/GPKE-Teil2-bestellung-einer-aenderung-von-abrechnungsdaten-zur-bilanzkreisabrechnung-von-uenb-an-nb)\n- [Bestellung zur Stammdatenänderung an NB (verantwortlich) — NB](/prozessdoku/202604/NB/GPKE-Teil4-bestellung-zur-stammdatenaenderung-an-nb-verantwortlich)\n- [Stammdaten zur Bilanzkreistreue — NB](/prozessdoku/202604/NB/GPKE-Teil4-stammdaten-zur-bilanzkreistreue)\n- [Stammdatenänderung vom NB (verantwortlich) ausgehend — NB](/prozessdoku/202604/NB/GPKE-Teil4-stammdatenaenderung-vom-nb-verantwortlich-ausgehend)\n\nSchema nur dieses Ereignisses herunterladen (OpenAPI, JSON).\n\n\n\nDer Aufruf geht tatsächlich an `POST /inbound`; das Event ergibt sich aus `zusatzdaten.eventname` im Rumpf. Diese Seite trennt eine von 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_NB_START_VERSAND_BEARB_MELDUNG",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"START_VERSAND_BEARB_MELDUNG": {
"$ref": "#/components/examples/START_VERSAND_BEARB_MELDUNG"
}
},
"schema": {
"$ref": "#/components/schemas/NB_START_VERSAND_BEARB_MELDUNG"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_responses_success"
}
}
},
"description": "Erfolg | Success"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/event_response_fail"
}
}
},
"description": "Fehler | Fail"
}
},
"security": [
{
"bearer": []
}
],
"summary": "START_VERSAND_BEARB_MELDUNG (NB)",
"tags": [
"START_VERSAND_BEARB_MELDUNG"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[NB]_START_VERSAND_BEARB_MELDUNG.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"Auftragsstatus": {
"description": "Auftragsstatus",
"enum": [
"GESCHEITERT",
"ERFOLGREICH",
"LIEFERUNG_GEPLANT",
"GEPLANT",
"ZUGESTIMMT",
"WIDERSPROCHEN",
"STOERUNGSFREI",
"GESTOERT",
"FESTGESTELLTE_STOERUNG",
"VERMUTETE_STOERUNG",
"ABGELEHNT",
"BEENDET",
"ANTWORT_DRITTER",
"BESTAETIGT",
"UMGESETZT",
"ENFG_STROMSPEICHER_UND_VERLUSTENERGIE",
"ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN",
"ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN",
"ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF",
"ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN",
"ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN",
"ENFG_SCHIENENBAHNEN",
"ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR",
"ENFG_LANDSTROMANLAGEN",
"AENDERUNG_DER_DATEN",
"KEINE_AENDERUNG_DER_DATEN",
"ZEITREIHE_AKZEPTIERT",
"ZEITREIHE_NICHT_AKZEPTIERT"
],
"title": "Auftragsstatus",
"type": "string"
},
"NB_START_VERSAND_BEARB_MELDUNG": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_21047__stammdaten"
}
]
},
"transaktionsdaten": {
"properties": {
"absender": {
"properties": {
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"empfaenger": {
"properties": {
"rollencodenummer": {
"$ref": "#/components/schemas/rollencodenummer"
}
},
"type": "object"
},
"pruefidentifikator": {
"description": "Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 21047.",
"examples": [
"21047"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
}
},
"required": [
"absender",
"empfaenger",
"sparte"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_VERSAND_BEARB_MELDUNG",
"default": "START_VERSAND_BEARB_MELDUNG",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"PI_21047__stammdaten": {
"properties": {
"STATUSMITTEILUNG": {
"items": {
"$ref": "#/components/schemas/PI_21047__stammdaten__STATUSMITTEILUNG"
},
"type": "array"
}
},
"required": [
"STATUSMITTEILUNG"
],
"type": "object",
"title": "21047"
},
"PI_21047__stammdaten__STATUSMITTEILUNG": {
"properties": {
"auftragsstatus": {
"$ref": "#/components/schemas/auftragsstatus",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43"
]
},
"positionsdaten": {
"items": {
"$ref": "#/components/schemas/PI_21047__stammdaten__STATUSMITTEILUNG__positionsdaten"
},
"type": "array"
},
"statusObjekt": {
"$ref": "#/components/schemas/statusObjekt",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43"
]
}
},
"required": [
"auftragsstatus",
"positionsdaten",
"statusObjekt"
],
"type": "object"
},
"PI_21047__stammdaten__STATUSMITTEILUNG__positionsdaten": {
"properties": {
"allgemeineInformationen": {
"$ref": "#/components/schemas/PI_21047__stammdaten__STATUSMITTEILUNG__positionsdaten__allgemeineInformationen"
},
"positionsnummer": {
"$ref": "#/components/schemas/positionsnummer",
"x-edifact-segment": [
"SG14.CNI"
]
}
},
"required": [
"positionsnummer"
],
"type": "object"
},
"PI_21047__stammdaten__STATUSMITTEILUNG__positionsdaten__allgemeineInformationen": {
"properties": {
"info1": {
"$ref": "#/components/schemas/info1",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43.SG25.GID.FTX+ACB"
]
},
"info2": {
"$ref": "#/components/schemas/info2",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43.SG25.GID.FTX+ACB"
]
},
"info3": {
"$ref": "#/components/schemas/info3",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43.SG25.GID.FTX+ACB"
]
},
"info4": {
"$ref": "#/components/schemas/info4",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43.SG25.GID.FTX+ACB"
]
},
"info5": {
"$ref": "#/components/schemas/info5",
"x-edifact-segment": [
"SG14.CNI.SG15.STS+Z43.SG25.GID.FTX+ACB"
]
}
},
"type": "object"
},
"Sparte": {
"description": "Sparte",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Sparte",
"type": "string"
},
"Statusobjekt": {
"description": "Statusobjekt",
"enum": [
"MSBWECHSEL",
"UMBAUMELO",
"ERSTEINBAUIMS",
"ERSTEINBAUMME",
"GERAET",
"ANGEBOTANFRAGE",
"STATUSBESTELLUNG",
"LIEFERSCHEIN",
"SPERREN",
"ENTSPERREN",
"PRIVILEGIERUNG_NACH_ENFG",
"VERAENDERUNGSSTATUS_DER_DATEN",
"TURNUSAUSLESUNG",
"PRUEFSTATUS_ANTWORT_SUMMENZEITREIHEN",
"ABWEISUNG_SUMMENZEITREIHE",
"PRUEFSTATUS_SUMMENZEITREIHE",
"DATENSTATUS_SUMMENZEITREIHE",
"ABWEISUNG_STATUSMELDUNG_AENDERUNG",
"AUSFALLARBEIT",
"FAHRPLANANTEIL",
"GEGENVORSCHLAG_AUSFALLARBEIT",
"GEGENVORSCHLAG_FAHRPLANANTEIL"
],
"title": "Statusobjekt",
"type": "string"
},
"auftragsstatus": {
"$ref": "#/components/schemas/Auftragsstatus"
},
"event_response_fail": {
"description": "Fehlermeldung auf Prozessdaten API Aufruf | Error message on process data API call",
"properties": {
"errorCode": {
"description": "Error identifier",
"example": "400",
"type": "string"
},
"message": {
"description": "Technische Meldung | Technische Meldung",
"example": "Validation Failed",
"type": "string"
}
},
"type": "object"
},
"event_responses_success": {
"description": "Erfolgsmeldung auf Prozessdaten API Aufruf | Success message on process data API call",
"properties": {
"businessKey": {
"description": "Einzigartige Kennung des Geschäftsprozesses | Unique identifier of the business process",
"format": "uuid",
"type": "string"
},
"message": {
"description": "Nachricht mit Details zum ausgelösten Event | Message with details about the triggered event",
"example": "received event XXXXXXXXXXXX with id at 2024-08-08T12:58:22Z and started process with businessKey 4c7170ed-3518-41ee-8582-39ab65b00107",
"type": "string"
}
},
"required": [
"businessKey",
"message"
],
"type": "object"
},
"info1": {
"description": "Allgemeine Info 1",
"type": "string"
},
"info2": {
"description": "Allgemeine Info 2",
"type": "string"
},
"info3": {
"description": "Allgemeine Info 3",
"type": "string"
},
"info4": {
"description": "Allgemeine Info 4",
"type": "string"
},
"info5": {
"description": "Allgemeine Info 5",
"type": "string"
},
"positionsnummer": {
"description": "Positionsnummer",
"type": "integer"
},
"rollencodenummer": {
"description": "Gibt die Codenummer der Marktrolle an.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Enthält Informationen über die Sparte"
},
"statusObjekt": {
"$ref": "#/components/schemas/Statusobjekt"
}
},
"examples": {
"START_VERSAND_BEARB_MELDUNG": {
"summary": "START_VERSAND_BEARB_MELDUNG - Bearbeitungsstand zur Rückmeldung (NB)",
"value": {
"stammdaten": {
"ENERGIELIEFERVERTRAG": [
{
"boTyp": "VERTRAG",
"enFG": [
{
"grund": [
"ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN"
],
"grundlageVerringerungUmlagen": "ERFUELLT_VORAUSSETZUNG_NACH_ENFG"
}
],
"korrespondenzpartner": {
"boTyp": "GESCHAEFTSPARTNER",
"gewerbekennzeichnung": false,
"name1": "Glöppel",
"partneradresse": {
"hausnummer": "49",
"landescode": "DE",
"ort": "Grevenbroich",
"postleitzahl": "41515",
"strasse": "Bahnstraße"
},
"versionStruktur": "1"
},
"sparte": "STROM",
"versionStruktur": "1",
"vertragsart": "ENERGIELIEFERVERTRAG",
"vertragspartner2": [
{
"anrede": "Herr",
"boTyp": "GESCHAEFTSPARTNER",
"geschaeftspartnerrolle": [
"KUNDE"
],
"gewerbekennzeichnung": false,
"name1": "Glöppel",
"name2": "Walter",
"versionStruktur": "1"
}
]
}
],
"MARKTLOKATION": [
{
"boTyp": "MARKTLOKATION",
"erforderlichesProduktpaket": [
{
"produkt": [
{
"produktCode": "9991000002082",
"wertedetails": "11Y0-0000-0077-K"
},
{
"codeProdukteigenschaft": "9991000002115",
"produktCode": "9991000002008"
}
],
"produktpaketId": 1,
"umsetzungsgradvorgabe": "ZUORDNUNG_NUR_WENN_PRODUKTPAKET_UMSETZBAR"
}
],
"marktlokationsId": "50754496000",
"sparte": "STROM",
"versionStruktur": "1"
}
],
"NETZNUTZUNGSVERTRAG": [
{
"boTyp": "VERTRAG",
"sparte": "STROM",
"versionStruktur": "1",
"vertragsart": "NETZNUTZUNGSVERTRAG",
"vertragsbeginn": "2025-10-31T23:00:00Z",
"vertragskonditionen": {
"haushaltskunde": true
}
}
]
},
"transaktionsdaten": {
"absender": {
"boTyp": "MARKTTEILNEHMER",
"rollencodenummer": "9903526000002",
"rollencodetyp": "BDEW",
"versionStruktur": "1"
},
"empfaenger": {
"boTyp": "MARKTTEILNEHMER",
"rollencodenummer": "9900683000008",
"rollencodetyp": "BDEW",
"versionStruktur": "1"
},
"kategorie": "E01",
"sparte": "STROM",
"transaktionsgrund": "E01",
"transaktionsgrundergaenzung": "ZW4"
},
"zusatzdaten": {
"eventname": "START_ABR_NN",
"prozessId": "00505688-E4A2-1EDF-A0C2-C81842E2515E"
}
}
}
}
}
}