{ "openapi": "3.1.0", "info": { "title": "START_VERSAND_PREISBLATT_IMS (MSB)", "version": "202610", "description": "Das Ereignis `START_VERSAND_PREISBLATT_IMS` der Marktrolle MSB als eigenständige Spezifikation, abgeleitet aus der Auslöser-API der Formatversion 202610. 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_PREISBLATT_IMS" } ], "paths": { "/inbound": { "post": { "deprecated": false, "description": "Trigger-Event **START_VERSAND_PREISBLATT_IMS** der Marktrolle MSB.\n\n**Startet diese Rollensichten** (4):\n\n- [Übermittlung Preisblatt A des MSB vom MSB an NB und LF — MSB](/prozessdoku/202610/MSB/GPKE-Teil3-uebermittlung-preisblatt-a-des-msb-vom-msb-an-nb-und-lf)\n- [Übermittlung Preisblatt B des MSB vom MSB an NB und LF — MSB](/prozessdoku/202610/MSB/awh-prozesse-zur-anderung-der-technik-an-lokationen-ubermittlung-preisblatt-b-des-msb-vom-msb-an-nb-und-lf)\n- [Übermittlung Preisblatt MSB an LF — MSB](/prozessdoku/202610/MSB/WiM-Teil1-uebermittlung-preisblatt-msb-an-lf)\n- [Übermittlung Preisblatt „Messstellenbetrieb mit iMS gegenüber dem NB“ vom MSB an NB — MSB](/prozessdoku/202610/MSB/WiM-Teil1-uebermittlung-preisblatt-messstellenbetrieb-mit-ims-gegenueber-dem-nb-vom-msb-an-nb)\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 104 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n", "operationId": "trigger_MSB_START_VERSAND_PREISBLATT_IMS", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MSB_START_VERSAND_PREISBLATT_IMS" } } } }, "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_PREISBLATT_IMS (MSB)", "tags": [ "START_VERSAND_PREISBLATT_IMS" ], "x-actual-endpoint": "POST /inbound", "x-event-source": "event/202610/[MSB]_START_VERSAND_PREISBLATT_IMS.yaml", "x-handbuchsatz": true } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "type": "http" } }, "schemas": { "BDEWArtikelnummer": { "description": "BDEW Artikelnummer", "enum": [ "LEISTUNG", "LEISTUNG_PAUSCHAL", "GRUNDPREIS", "REGELENERGIE_ARBEIT", "REGELENERGIE_LEISTUNG", "NOTSTROMLIEFERUNG_ARBEIT", "NOTSTROMLIEFERUNG_LEISTUNG", "RESERVENETZKAPAZITAET", "RESERVELEISTUNG", "ZUSAETZLICHE_ABLESUNG", "PRUEFGEBUEHREN_AUSSERPLANMAESSIG", "WIRKARBEIT", "SINGULAER_GENUTZTE_BETRIEBSMITTEL", "ABGABE_KWKG", "ABSCHLAG", "KONZESSIONSABGABE", "ENTGELT_FERNAUSLESUNG", "UNTERMESSUNG", "BLINDMEHRARBEIT", "ENTGELT_ABRECHNUNG", "SPERRKOSTEN", "ENTSPERRKOSTEN", "MAHNKOSTEN", "MEHR_MINDERMENGEN", "INKASSOKOSTEN", "BLINDMEHRLEISTUNG", "ENTGELT_MESSUNG_ABLESUNG", "ENTGELT_EINBAU_BETRIEB_WARTUNG_MESSTECHNIK", "AUSGLEICHSENERGIE", "AUSGLEICHSENERGIE_UNTERDECKUNG", "ZAEHLEINRICHTUNG", "WANDLER_MENGENUMWERTER", "KOMMUNIKATIONSEINRICHTUNG", "TECHNISCHE_STEUEREINRICHTUNG", "PARAGRAF_19_STROM_NEV_UMLAGE", "BEFESTIGUNGSEINRICHTUNG", "OFFSHORE_HAFTUNGSUMLAGE", "FIXE_ARBEITSENTGELTKOMPONENTE", "FIXE_LEISTUNGSENTGELTKOMPONENTE", "UMLAGE_ABSCHALTBARE_LASTEN", "MEHRMENGE", "MINDERMENGE", "ENERGIESTEUER", "SMARTMETER_GATEWAY", "STEUERBOX", "MSB_INKL_MESSUNG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_1_MSBG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_2_MSBG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_3_MSBG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_4_MSBG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_2_5_MSBG", "ZUSATZDIENSTLEISTUNG_PARAGRAPH_35_3_MSBG", "ENTGELT_KAPAZITAETEN" ], "title": "BDEWArtikelnummer", "type": "string" }, "Beschreibungsformat": { "description": "Beschreibungsformat der Produktbeschreibung", "enum": [ "CODE", "FREIER_TEXT", "TEILSTRUKTURIERT" ], "title": "Beschreibungsformat", "type": "string" }, "Leistungsbezeichnung": { "description": "Leistungsbezeichnung", "enum": [ "POG_VERBRAUCH_IMS_UEBER_100K", "POG_VERBRAUCH_IMS_50K_BIS_100K", "POG_VERBRAUCH_IMS_20K_BIS_50K", "POG_VERBRAUCH_IMS_10K_BIS_20K", "POG_VERBRAUCH_IMS_UNTERBRECHBAR", "POG_VERBRAUCH_IMS_6K_BIS_10K", "POG_ERZEUGUNG_IMS_7_BIS_15", "POG_ERZEUGUNG_IMS_15_BIS_30", "POG_ERZEUGUNG_IMS_30_BIS_100", "POG_ERZEUGUNG_IMS_UEBER_100", "POG_MME", "POG_VERBRAUCH_IMS_4K_BIS_6K", "POG_VERBRAUCH_IMS_3K_BIS_4K", "POG_VERBRAUCH_IMS_2K_BIS_3K", "POG_VERBRAUCH_IMS_0_BIS_2K", "POG_ERZEUGUNG_IMS_OPTIONAL", "ZUSATZLEISTUNG" ], "title": "Leistungsbezeichnung", "type": "string" }, "MSB_START_VERSAND_PREISBLATT_IMS": { "properties": { "stammdaten": { "anyOf": [ { "$ref": "#/components/schemas/PI_27002__stammdaten" } ] }, "transaktionsdaten": { "properties": { "absender": { "properties": { "marktrolle": { "$ref": "#/components/schemas/marktrolle" }, "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "empfaenger": { "properties": { "marktrolle": { "$ref": "#/components/schemas/marktrolle" }, "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "kategorie": { "$ref": "#/components/schemas/kategorie" }, "pruefidentifikator": { "description": "Wird dynamisch im Event-Prozess ermittelt. Ein vom Sender mitgegebener Wert wird ignoriert. Im Topic mögliche Prüfis — 27002.", "examples": [ "27002" ] }, "sparte": { "$ref": "#/components/schemas/sparte" } }, "required": [ "absender", "empfaenger", "kategorie", "pruefidentifikator", "sparte" ], "type": "object" }, "zusatzdaten": { "properties": { "eventname": { "const": "START_VERSAND_PREISBLATT_IMS", "default": "START_VERSAND_PREISBLATT_IMS", "type": "string" }, "prozessId": { "type": "string" } }, "required": [ "prozessId", "eventname" ], "type": "object" } }, "required": [ "stammdaten", "transaktionsdaten", "zusatzdaten" ], "type": "object" }, "Marktrolle": { "description": "Diese Rollen kann ein Marktteilnehmer einnehmen", "enum": [ "NB", "LF", "MSB", "MSBA", "GMSB", "MDL", "DL", "BKV", "BKO", "UENB", "KUNDE-SELBST-NN", "MGV", "EIV", "RB", "KUNDE", "INTERESSENT", "KN", "UBA", "BIKO", "ESA" ], "title": "Marktrolle", "type": "string" }, "Mengeneinheit": { "description": "Einheit: Messgrößen, die per Messung oder Vorgabe ermittelt werden können", "enum": [ "W", "WH", "KW", "KWH", "KVARH", "MW", "MWH", "STUECK", "KUBIKMETER", "STUNDE", "TAG", "MONAT", "JAHR", "PROZENT", "ANZAHL", "VAR", "KVAR", "VARH", "KWHK", "Z16", "KWT" ], "title": "Mengeneinheit", "type": "string" }, "Netzebene": { "description": "Netzebene", "enum": [ "NSP", "MSP", "HSP", "HSS", "MSP_NSP_UMSP", "HSP_MSP_UMSP", "HSS_HSP_UMSP", "HD", "MD", "ND" ], "title": "Netzebene", "type": "string" }, "PI_27002__stammdaten": { "properties": { "PREISBLATT": { "items": { "$ref": "#/components/schemas/PI_27002__stammdaten__PREISBLATT" }, "type": "array" } }, "required": [ "PREISBLATT" ], "type": "object", "title": "27002" }, "PI_27002__stammdaten__PREISBLATT": { "properties": { "gueltigkeit": { "$ref": "#/components/schemas/PI_27002__stammdaten__PREISBLATT__gueltigkeit" }, "preispositionen": { "items": { "$ref": "#/components/schemas/PI_27002__stammdaten__PREISBLATT__preispositionen" }, "type": "array" } }, "required": [ "gueltigkeit" ], "type": "object" }, "PI_27002__stammdaten__PREISBLATT__gueltigkeit": { "properties": { "startdatum": { "$ref": "#/components/schemas/startdatum", "x-edifact-segment": [ "DTM+157" ] } }, "required": [ "startdatum" ], "type": "object" }, "PI_27002__stammdaten__PREISBLATT__preispositionen": { "properties": { "artikelId": { "$ref": "#/components/schemas/artikelId", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN" ] }, "bdewArtikelnummer": { "$ref": "#/components/schemas/bdewArtikelnummer", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN", "SG17.PGI+9.SG36.LIN.IMD+[C|F|X]" ] }, "beschreibung": { "$ref": "#/components/schemas/beschreibung", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.IMD+[C|F|X]" ] }, "beschreibungsformat": { "$ref": "#/components/schemas/beschreibungsformat", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.IMD+[C|F|X]" ] }, "leistungsbezeichnung": { "$ref": "#/components/schemas/leistungsbezeichnung", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.IMD+[C|F|X]" ] }, "messebene": { "$ref": "#/components/schemas/messebene", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.IMD+[C|F|X]" ] }, "positionsnummer": { "$ref": "#/components/schemas/positionsnummer", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN" ] }, "preisschluesselstamm": { "$ref": "#/components/schemas/preisschluesselstamm", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.PIA+1" ] }, "preisstaffeln": { "items": { "$ref": "#/components/schemas/PI_27002__stammdaten__PREISBLATT__preispositionen__preisstaffeln" }, "type": "array" }, "zeitbasis": { "$ref": "#/components/schemas/zeitbasis", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.SG40.PRI+CAL" ] } }, "type": "object" }, "PI_27002__stammdaten__PREISBLATT__preispositionen__preisstaffeln": { "properties": { "einheit": { "$ref": "#/components/schemas/einheit", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.SG40.PRI+CAL.RNG+10+KWH" ] }, "einheitspreis": { "$ref": "#/components/schemas/einheitspreis", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.SG40.PRI+CAL" ] }, "staffelgrenzeBis": { "$ref": "#/components/schemas/staffelgrenzeBis", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.SG40.PRI+CAL.RNG+10+KWH" ] }, "staffelgrenzeVon": { "$ref": "#/components/schemas/staffelgrenzeVon", "x-edifact-segment": [ "SG17.PGI+9.SG36.LIN.SG40.PRI+CAL.RNG+10+KWH" ] } }, "type": "object" }, "Sparte": { "description": "Sparte", "enum": [ "STROM", "GAS", "FERNWAERME", "NAHWAERME", "WASSER", "ABWASSER" ], "title": "Sparte", "type": "string" }, "Zeiteinheit": { "description": "Zeiteinheit", "enum": [ "SEKUNDE", "MINUTE", "STUNDE", "VIERTEL_STUNDE", "TAG", "WOCHE", "MONAT", "QUARTAL", "HALBJAHR", "JAHR" ], "title": "Zeiteinheit", "type": "string" }, "artikelId": { "description": "artikelId", "type": "string" }, "bdewArtikelnummer": { "$ref": "#/components/schemas/BDEWArtikelnummer", "description": "Eine vom BDEW standardisierte Bezeichnung für die abgerechnete Leistungserbringung. Diese Artikelnummer wird\nauch im Rechnungsteil der INVOIC verwendet." }, "beschreibung": { "description": "Produkt-/Leistungsbeschreibung, wenn IMD+X vorhanden Vgl. PRICAT IMD 7008", "type": "string" }, "beschreibungsformat": { "$ref": "#/components/schemas/Beschreibungsformat", "description": "Vgl. PRICAT IMD 7077" }, "einheit": { "$ref": "#/components/schemas/Mengeneinheit" }, "einheitspreis": { "description": "einheitspreis", "format": "float", "type": "number" }, "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" }, "kategorie": { "description": "Qualifier aus dem Beginn der EDIFact Nachricht / BGM", "type": "string" }, "leistungsbezeichnung": { "$ref": "#/components/schemas/Leistungsbezeichnung", "description": "Bezeichnung für die in der Position abgebildete Leistungserbringung" }, "marktrolle": { "$ref": "#/components/schemas/Marktrolle", "description": "Gibt im Klartext die Bezeichnung der Marktrolle an." }, "messebene": { "$ref": "#/components/schemas/Netzebene", "description": "Vgl. PRICAT IMD 7009" }, "positionsnummer": { "description": "Positionsnummer", "type": "integer" }, "preisschluesselstamm": { "description": "Preisschlüsselstamm>", "type": "string" }, "rollencodenummer": { "description": "Gibt die Codenummer der Marktrolle an.", "type": "string" }, "sparte": { "$ref": "#/components/schemas/Sparte", "description": "Enthält Informationen über die Sparte" }, "staffelgrenzeBis": { "description": "staffelgrenzeBis", "format": "float", "type": "number" }, "staffelgrenzeVon": { "description": "staffelgrenzeVon", "format": "float", "type": "number" }, "startdatum": { "description": "startdatum", "format": "date-time", "type": "string" }, "zeitbasis": { "$ref": "#/components/schemas/Zeiteinheit", "description": "Die Zeit(dauer) auf die sich der Preis bezieht. Z.B. ein Jahr für einen Leistungspreis der in €/kW/Jahr\nausgegeben wird." } } } }