{ "openapi": "3.1.0", "info": { "title": "START_VERSAND_SDAE (LF)", "version": "202604", "description": "The event `START_VERSAND_SDAE` of the market role LF as a standalone specification, derived from the trigger API of format version 202604. Exactly one path: `POST /inbound`; the event is derived from `zusatzdaten.eventname` in the body." }, "servers": [ { "description": "Fake Env", "url": "https://api.macoapp.de" } ], "tags": [ { "name": "START_VERSAND_SDAE" } ], "paths": { "/inbound": { "post": { "deprecated": false, "description": "Trigger-Event **START_VERSAND_SDAE** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Stammdatenänderung vom LF (verantwortlich) ausgehend — LF (GPKE Teil 4)](/prozessdoku/202604/LF/GPKE-Teil4-stammdatenaenderung-vom-lf-verantwortlich-ausgehend)\n- [Stammdatenänderung vom LF (verantwortlich) ausgehend — LF (GeLi Gas 2.0)](/prozessdoku/202604/LF/geli-gas-2-0-stammdatenanderung-vom-lf-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_LF_START_VERSAND_SDAE", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LF_START_VERSAND_SDAE" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_responses_success" } } }, "description": "Success | Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response_fail" } } }, "description": "Error | Fail" } }, "security": [ { "bearer": [] } ], "summary": "START_VERSAND_SDAE (LF)", "tags": [ "START_VERSAND_SDAE" ], "x-actual-endpoint": "POST /inbound", "x-event-source": "event/202604/[LF]_START_VERSAND_SDAE.yaml", "x-handbuchsatz": true } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "type": "http" } }, "schemas": { "Datenqualitaet": { "description": "Data quality", "enum": [ "ERWARTETE_DATEN", "IM_SYSTEM_VORHANDENE_DATEN", "INFORMATIVE_DATEN", "GUELTIGE_DATEN", "KEINE_DATEN", "IM_SYSTEM_KEINE_DATEN_VORHANDEN", "KEINE_DATEN_ERWARTET", "DIFFERENZ_DATEN", "DIFFERENZ_ERWARTETE_DATEN", "DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN" ], "title": "Data quality", "type": "string" }, "Geschaeftspartnerrolle": { "description": "Geschaeftspartnerrolle", "enum": [ "KUNDE", "LIEFERANT", "DIENSTLEISTER", "INTERESSENT", "MARKTPARTNER", "EIGENTUEMER", "HAUSVERWALTER", "KORRESPONDENZEMPFAENGER", "ABLESEKARTENEMPFAENGER" ], "title": "Geschaeftspartnerrolle", "type": "string" }, "GrundlageVerringerungUmlagen": { "description": "GrundlageVerringerungUmlagen", "enum": [ "ERFUELLT_VORAUSSETZUNG_NACH_ENFG", "ERFUELLT_NICHT_VORAUSSETZUNG_NACH_ENFG", "KEINE_ANGABE" ], "title": "GrundlageVerringerungUmlagen", "type": "string" }, "GrundlageVerringerungUmlagenGrund": { "description": "GrundlageVerringerungUmlagenGrund", "enum": [ "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" ], "title": "GrundlageVerringerungUmlagenGrund", "type": "string" }, "LF_START_VERSAND_SDAE": { "properties": { "stammdaten": { "anyOf": [ { "$ref": "#/components/schemas/PI_44109__stammdaten" }, { "$ref": "#/components/schemas/PI_44120__stammdaten" }, { "$ref": "#/components/schemas/PI_55109__stammdaten" }, { "$ref": "#/components/schemas/PI_55110__stammdaten" }, { "$ref": "#/components/schemas/PI_55230__stammdaten" } ] }, "transaktionsdaten": { "properties": { "absender": { "properties": { "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "empfaenger": { "properties": { "marktrolle": { "$ref": "#/components/schemas/marktrolle" }, "rollencodenummer": { "$ref": "#/components/schemas/rollencodenummer" } }, "type": "object" }, "gueltigAb": { "$ref": "#/components/schemas/gueltigAb" }, "kategorie": { "$ref": "#/components/schemas/kategorie" }, "pruefidentifikator": { "description": "Determined dynamically in the event process (basis for the decision: marktrolle, sparte, transaktionsgrund). A value supplied by the sender is ignored. Check identifiers possible in the topic — 44109, 44120, 55109, 55110, 55230, 55693.", "examples": [ "44109", "44120", "55109", "55110", "55230", "55693" ] }, "sparte": { "$ref": "#/components/schemas/sparte" }, "transaktionsgrund": { "$ref": "#/components/schemas/transaktionsgrund" }, "transaktionsgrundergaenzung": { "$ref": "#/components/schemas/transaktionsgrundergaenzung" }, "vertragsbeginn": { "$ref": "#/components/schemas/vertragsbeginn" } }, "required": [ "absender", "empfaenger", "gueltigAb", "kategorie", "sparte", "transaktionsgrund", "transaktionsgrundergaenzung", "vertragsbeginn" ], "type": "object" }, "zusatzdaten": { "properties": { "eventname": { "const": "START_VERSAND_SDAE", "default": "START_VERSAND_SDAE", "type": "string" }, "prozessId": { "type": "string" } }, "required": [ "prozessId", "eventname" ], "type": "object" } }, "required": [ "stammdaten", "transaktionsdaten", "zusatzdaten" ], "type": "object", "x-pending-pruefis": [ "55693" ] }, "Landescode": { "description": "The ISO country code as an enumeration", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ], "title": "Country code", "type": "string" }, "Marktrolle": { "description": "A market participant can take on these roles", "enum": [ "NB", "LF", "MSB", "MSBA", "GMSB", "MDL", "DL", "BKV", "BKO", "UENB", "KUNDE-SELBST-NN", "MGV", "EIV", "RB", "KUNDE", "INTERESSENT", "KN", "UBA", "BIKO", "ESA" ], "title": "Market role", "type": "string" }, "PI_44109__stammdaten": { "properties": { "ENERGIELIEFERVERTRAG": { "items": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG" }, "type": "array" }, "MARKTLOKATION": { "items": { "$ref": "#/components/schemas/PI_44109__stammdaten__MARKTLOKATION" }, "type": "array" }, "NETZNUTZUNGSVERTRAG": { "items": { "$ref": "#/components/schemas/PI_44109__stammdaten__NETZNUTZUNGSVERTRAG" }, "type": "array" } }, "required": [ "MARKTLOKATION" ], "type": "object", "title": "44109" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG": { "properties": { "korrespondenzpartner": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner" }, "vertragskonditionen": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragskonditionen" }, "vertragspartner2": { "items": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2" }, "type": "array" } }, "type": "object" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "gewerbekennzeichnung": { "$ref": "#/components/schemas/gewerbekennzeichnung", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "partneradresse": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse" } }, "type": "object" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse": { "properties": { "hausnummer": { "$ref": "#/components/schemas/hausnummer", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "landescode": { "$ref": "#/components/schemas/landescode", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ort": { "$ref": "#/components/schemas/ort", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ortsteil": { "$ref": "#/components/schemas/ortsteil", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postfach": { "$ref": "#/components/schemas/postfach", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postleitzahl": { "$ref": "#/components/schemas/postleitzahl", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "strasse": { "$ref": "#/components/schemas/strasse", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] } }, "type": "object" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragskonditionen": { "properties": { "abrechnungsintervall": { "$ref": "#/components/schemas/abrechnungsintervall", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+Z18.DTM+Z20" ] } }, "type": "object" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "externeReferenzen": { "items": { "$ref": "#/components/schemas/PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2__externeReferenzen" }, "type": "array" }, "gewerbekennzeichnung": { "$ref": "#/components/schemas/gewerbekennzeichnung", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] } }, "type": "object" }, "PI_44109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2__externeReferenzen": { "properties": { "exRefName": { "$ref": "#/components/schemas/exRefName", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09.RFF+AVC" ] }, "exRefWert": { "$ref": "#/components/schemas/exRefWert", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09.RFF+AVC" ] } }, "type": "object" }, "PI_44109__stammdaten__MARKTLOKATION": { "properties": { "marktlokationsId": { "$ref": "#/components/schemas/marktlokationsId", "x-edifact-segment": [ "SG4.IDE+24.SG5.LOC+172", "SG4.IDE+24.SG6.RFF+Z18" ] } }, "required": [ "marktlokationsId" ], "type": "object" }, "PI_44109__stammdaten__NETZNUTZUNGSVERTRAG": { "properties": { "vertragsbeginn": { "$ref": "#/components/schemas/vertragsbeginn", "x-edifact-segment": [ "SG4.IDE+24.DTM+92" ] }, "vertragskonditionen": { "$ref": "#/components/schemas/PI_44109__stammdaten__NETZNUTZUNGSVERTRAG__vertragskonditionen" } }, "type": "object" }, "PI_44109__stammdaten__NETZNUTZUNGSVERTRAG__vertragskonditionen": { "properties": { "haushaltskunde": { "$ref": "#/components/schemas/haushaltskunde", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01.SG10.CCI+[Z15|Z18]" ] } }, "type": "object" }, "PI_44120__stammdaten": { "properties": { "BILANZIERUNG": { "items": { "$ref": "#/components/schemas/PI_44120__stammdaten__BILANZIERUNG" }, "type": "array" }, "MARKTLOKATION": { "items": { "$ref": "#/components/schemas/PI_44120__stammdaten__MARKTLOKATION" }, "type": "array" }, "NETZNUTZUNGSVERTRAG": { "items": { "$ref": "#/components/schemas/PI_44120__stammdaten__NETZNUTZUNGSVERTRAG" }, "type": "array" } }, "required": [ "BILANZIERUNG", "MARKTLOKATION" ], "type": "object", "title": "44120" }, "PI_44120__stammdaten__BILANZIERUNG": { "properties": { "bilanzkreise": { "items": { "$ref": "#/components/schemas/PI_44120__stammdaten__BILANZIERUNG__bilanzkreise" }, "type": "array" } }, "required": [ "bilanzkreise" ], "type": "object" }, "PI_44120__stammdaten__BILANZIERUNG__bilanzkreise": { "properties": { "bezeichnung": { "$ref": "#/components/schemas/bezeichnung", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01.SG10.CCI+Z19" ] } }, "required": [ "bezeichnung" ], "type": "object" }, "PI_44120__stammdaten__MARKTLOKATION": { "properties": { "marktlokationsId": { "$ref": "#/components/schemas/marktlokationsId", "x-edifact-segment": [ "SG4.IDE+24.SG5.LOC+172" ] } }, "required": [ "marktlokationsId" ], "type": "object" }, "PI_44120__stammdaten__NETZNUTZUNGSVERTRAG": { "properties": { "vertragsbeginn": { "$ref": "#/components/schemas/vertragsbeginn", "x-edifact-segment": [ "SG4.IDE+24.DTM+92" ] } }, "type": "object" }, "PI_55109__stammdaten": { "properties": { "ENERGIELIEFERVERTRAG": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG" }, "type": "array" }, "MARKTLOKATION": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__MARKTLOKATION" }, "type": "array" }, "NETZNUTZUNGSVERTRAG": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__NETZNUTZUNGSVERTRAG" }, "type": "array" }, "VERWENDUNGSZEITRAUM": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__VERWENDUNGSZEITRAUM" }, "type": "array" } }, "required": [ "VERWENDUNGSZEITRAUM" ], "type": "object", "title": "55109" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04", "SG4.IDE+24.SG12.NAD+Z09", "SG4.IDE+24.SG8.SEQ+Z75" ] }, "enFG": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__enFG" }, "type": "array" }, "gueltigkeitszeitraum": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__gueltigkeitszeitraum" }, "korrespondenzpartner": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner" }, "vertragspartner2": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2" }, "type": "array" } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__enFG": { "properties": { "grund": { "$ref": "#/components/schemas/grund", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z75.SG10.CCI+Z61.CAV" ] }, "grundlageVerringerungUmlagen": { "$ref": "#/components/schemas/grundlageVerringerungUmlagen", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z75.SG10.CCI+Z61" ] } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__gueltigkeitszeitraum": { "properties": { "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04.RFF+Z46", "SG4.IDE+24.SG12.NAD+Z09.RFF+Z46", "SG4.IDE+24.SG8.SEQ+Z75" ] } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "partneradresse": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse" } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse": { "properties": { "hausnummer": { "$ref": "#/components/schemas/hausnummer", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "landescode": { "$ref": "#/components/schemas/landescode", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ort": { "$ref": "#/components/schemas/ort", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ortsteil": { "$ref": "#/components/schemas/ortsteil", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postfach": { "$ref": "#/components/schemas/postfach", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postleitzahl": { "$ref": "#/components/schemas/postleitzahl", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "strasse": { "$ref": "#/components/schemas/strasse", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "externeReferenzen": { "items": { "$ref": "#/components/schemas/PI_55109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2__externeReferenzen" }, "type": "array" }, "geschaeftspartnerrolle": { "$ref": "#/components/schemas/geschaeftspartnerrolle", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] } }, "type": "object" }, "PI_55109__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2__externeReferenzen": { "properties": { "exRefName": { "$ref": "#/components/schemas/exRefName", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09.RFF+AVC" ] }, "exRefWert": { "$ref": "#/components/schemas/exRefWert", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09.RFF+AVC" ] } }, "type": "object" }, "PI_55109__stammdaten__MARKTLOKATION": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01" ] }, "foerderungsLand": { "$ref": "#/components/schemas/foerderungsLand", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01.SG10.CCI+Z23" ] }, "gueltigkeitszeitraum": { "$ref": "#/components/schemas/PI_55109__stammdaten__MARKTLOKATION__gueltigkeitszeitraum" }, "marktlokationsId": { "$ref": "#/components/schemas/marktlokationsId", "x-edifact-segment": [ "SG4.IDE+24.SG5.LOC+Z16" ] } }, "type": "object" }, "PI_55109__stammdaten__MARKTLOKATION__gueltigkeitszeitraum": { "properties": { "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01" ] } }, "type": "object" }, "PI_55109__stammdaten__NETZNUTZUNGSVERTRAG": { "properties": { "vertragskonditionen": { "$ref": "#/components/schemas/PI_55109__stammdaten__NETZNUTZUNGSVERTRAG__vertragskonditionen" } }, "type": "object" }, "PI_55109__stammdaten__NETZNUTZUNGSVERTRAG__vertragskonditionen": { "properties": { "haushaltskunde": { "$ref": "#/components/schemas/haushaltskunde", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z01.SG10.CCI" ] } }, "type": "object" }, "PI_55109__stammdaten__VERWENDUNGSZEITRAUM": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] }, "verwendungAb": { "$ref": "#/components/schemas/verwendungAb", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z25" ] }, "verwendungBis": { "$ref": "#/components/schemas/verwendungBis", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z26" ] }, "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] } }, "required": [ "datenqualitaet", "verwendungAb", "zeitraumId" ], "type": "object" }, "PI_55110__stammdaten": { "properties": { "ENERGIELIEFERVERTRAG": { "items": { "$ref": "#/components/schemas/PI_55110__stammdaten__ENERGIELIEFERVERTRAG" }, "type": "array" }, "MARKTLOKATION": { "items": { "$ref": "#/components/schemas/PI_55110__stammdaten__MARKTLOKATION" }, "type": "array" }, "VERWENDUNGSZEITRAUM": { "items": { "$ref": "#/components/schemas/PI_55110__stammdaten__VERWENDUNGSZEITRAUM" }, "type": "array" } }, "required": [ "VERWENDUNGSZEITRAUM" ], "type": "object", "title": "55110" }, "PI_55110__stammdaten__ENERGIELIEFERVERTRAG": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04", "SG4.IDE+24.SG12.NAD+Z09" ] }, "gueltigkeitszeitraum": { "$ref": "#/components/schemas/PI_55110__stammdaten__ENERGIELIEFERVERTRAG__gueltigkeitszeitraum" }, "korrespondenzpartner": { "$ref": "#/components/schemas/PI_55110__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner" }, "vertragspartner2": { "items": { "$ref": "#/components/schemas/PI_55110__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2" }, "type": "array" } }, "type": "object" }, "PI_55110__stammdaten__ENERGIELIEFERVERTRAG__gueltigkeitszeitraum": { "properties": { "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04.RFF+Z46", "SG4.IDE+24.SG12.NAD+Z09.RFF+Z46" ] } }, "type": "object" }, "PI_55110__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "partneradresse": { "$ref": "#/components/schemas/PI_55110__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse" } }, "type": "object" }, "PI_55110__stammdaten__ENERGIELIEFERVERTRAG__korrespondenzpartner__partneradresse": { "properties": { "hausnummer": { "$ref": "#/components/schemas/hausnummer", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "landescode": { "$ref": "#/components/schemas/landescode", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ort": { "$ref": "#/components/schemas/ort", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "ortsteil": { "$ref": "#/components/schemas/ortsteil", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postfach": { "$ref": "#/components/schemas/postfach", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "postleitzahl": { "$ref": "#/components/schemas/postleitzahl", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] }, "strasse": { "$ref": "#/components/schemas/strasse", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z04" ] } }, "type": "object" }, "PI_55110__stammdaten__ENERGIELIEFERVERTRAG__vertragspartner2": { "properties": { "anrede": { "$ref": "#/components/schemas/anrede", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "geschaeftspartnerrolle": { "$ref": "#/components/schemas/geschaeftspartnerrolle", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name1": { "$ref": "#/components/schemas/name1", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name2": { "$ref": "#/components/schemas/name2", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name3": { "$ref": "#/components/schemas/name3", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] }, "name4": { "$ref": "#/components/schemas/name4", "x-edifact-segment": [ "SG4.IDE+24.SG12.NAD+Z09" ] } }, "type": "object" }, "PI_55110__stammdaten__MARKTLOKATION": { "properties": { "marktlokationsId": { "$ref": "#/components/schemas/marktlokationsId", "x-edifact-segment": [ "SG4.IDE+24.SG5.LOC+Z16" ] } }, "type": "object" }, "PI_55110__stammdaten__VERWENDUNGSZEITRAUM": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] }, "verwendungAb": { "$ref": "#/components/schemas/verwendungAb", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z25" ] }, "verwendungBis": { "$ref": "#/components/schemas/verwendungBis", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z26" ] }, "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] } }, "required": [ "datenqualitaet", "verwendungAb", "zeitraumId" ], "type": "object" }, "PI_55230__stammdaten": { "properties": { "NETZLOKATION": { "items": { "$ref": "#/components/schemas/PI_55230__stammdaten__NETZLOKATION" }, "type": "array" }, "VERWENDUNGSZEITRAUM": { "items": { "$ref": "#/components/schemas/PI_55230__stammdaten__VERWENDUNGSZEITRAUM" }, "type": "array" } }, "required": [ "NETZLOKATION", "VERWENDUNGSZEITRAUM" ], "type": "object", "title": "55230" }, "PI_55230__stammdaten__NETZLOKATION": { "properties": { "abrechnungsdaten": { "items": { "$ref": "#/components/schemas/PI_55230__stammdaten__NETZLOKATION__abrechnungsdaten" }, "type": "array" }, "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z71" ] }, "gueltigkeitszeitraum": { "$ref": "#/components/schemas/PI_55230__stammdaten__NETZLOKATION__gueltigkeitszeitraum" }, "netzlokationsId": { "$ref": "#/components/schemas/netzlokationsId", "x-edifact-segment": [ "SG4.IDE+24.SG5.LOC+Z18" ] } }, "required": [ "netzlokationsId" ], "type": "object" }, "PI_55230__stammdaten__NETZLOKATION__abrechnungsdaten": { "properties": { "zahlerBlindarbeitLf": { "$ref": "#/components/schemas/zahlerBlindarbeitLf", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z71.SG10.CCI+Z46" ] } }, "type": "object" }, "PI_55230__stammdaten__NETZLOKATION__gueltigkeitszeitraum": { "properties": { "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG8.SEQ+Z71" ] } }, "type": "object" }, "PI_55230__stammdaten__VERWENDUNGSZEITRAUM": { "properties": { "datenqualitaet": { "$ref": "#/components/schemas/datenqualitaet", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] }, "verwendungAb": { "$ref": "#/components/schemas/verwendungAb", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z25" ] }, "verwendungBis": { "$ref": "#/components/schemas/verwendungBis", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53].DTM+Z26" ] }, "zeitraumId": { "$ref": "#/components/schemas/zeitraumId", "x-edifact-segment": [ "SG4.IDE+24.SG6.RFF+[Z49|Z53]" ] } }, "required": [ "datenqualitaet", "verwendungAb", "zeitraumId" ], "type": "object" }, "Sparte": { "description": "Division", "enum": [ "STROM", "GAS", "FERNWAERME", "NAHWAERME", "WASSER", "ABWASSER" ], "title": "Division", "type": "string" }, "abrechnungsintervall": { "description": "abrechnungsintervall", "type": "integer" }, "anrede": { "description": "The form of address for the GePa, e.g. Mr.", "type": "string" }, "bezeichnung": { "description": "Additional designation, e.g. Zählwerk_Wirkarbeit.", "type": "string" }, "datenqualitaet": { "$ref": "#/components/schemas/Datenqualitaet" }, "event_response_fail": { "description": "Error message on process data API call | Error message on process data API call", "properties": { "errorCode": { "description": "Error identifier", "example": "400", "type": "string" }, "message": { "description": "Technical message | Technical message", "example": "Validation Failed", "type": "string" } }, "type": "object" }, "event_responses_success": { "description": "Success message on process data API call | Success message on process data API call", "properties": { "businessKey": { "description": "Unique identifier of the business process | Unique identifier of the business process", "format": "uuid", "type": "string" }, "message": { "description": "Message with details about the triggered 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" }, "exRefName": { "description": "Name of the external reference (e.g. \"hochfrequenz integration services\")", "enum": [ "Kundennummer beim Lieferanten", "Kundennummer beim Altlieferanten" ], "type": "string" }, "exRefWert": { "description": "Value of the external reference (e.g. \"123456\"; \"4711\")", "type": "string" }, "foerderungsLand": { "description": "foerderungsLand", "type": "string" }, "geschaeftspartnerrolle": { "description": "Role held by the business partner (e.g. prospect, customer).", "items": { "$ref": "#/components/schemas/Geschaeftspartnerrolle" }, "nullable": true, "type": "array" }, "gewerbekennzeichnung": { "description": "Indicates whether this is a commercial business/company (gewerbeKennzeichnung = true)\nor a private individual. (gewerbeKennzeichnung = false)", "type": "boolean" }, "grund": { "description": "Reason for the levy reduction", "items": { "$ref": "#/components/schemas/GrundlageVerringerungUmlagenGrund" }, "nullable": true, "type": "array" }, "grundlageVerringerungUmlagen": { "$ref": "#/components/schemas/GrundlageVerringerungUmlagen" }, "gueltigAb": { "description": "gueltigAb", "format": "date-time", "type": "string" }, "haushaltskunde": { "description": "haushaltskunde", "type": "boolean" }, "hausnummer": { "description": "House number and supplement", "type": "string" }, "kategorie": { "description": "Qualifier from the beginning of the EDIFACT message / BGM", "type": "string" }, "landescode": { "$ref": "#/components/schemas/Landescode", "description": "Country code" }, "marktlokationsId": { "description": "Identification number of a market location at which energy is either\nconsumed or generated", "type": "string" }, "marktrolle": { "$ref": "#/components/schemas/Marktrolle", "description": "Indicates the designation of the market role in free text." }, "name1": { "description": "First part of the name. Here the company name or, for private individuals,\nfor example the surname can be entered. Examples: Yellow Strom GmbH\nor Hagen", "type": "string" }, "name2": { "description": "Second part of the name. This can hold an extension to the company name or,\nfor private individuals, the first name, for example. Examples:\nSouth region or Nina", "type": "string" }, "name3": { "description": "Third part of the name. Here further additions to the company name or,\nfor private individuals, additions to the name can be shown. Examples: and Africa\nor singer", "type": "string" }, "name4": { "description": "name4", "type": "string" }, "netzlokationsId": { "description": "Identification number of a grid location at which energy is either\nconsumed or generated (Like MarktlokationsId Marktlokation)", "type": "string" }, "ort": { "description": "City", "type": "string" }, "ortsteil": { "description": "District", "type": "string" }, "postfach": { "description": "PO box", "type": "string" }, "postleitzahl": { "description": "Postal code", "type": "string" }, "rollencodenummer": { "description": "Specifies the code value of the market role.", "type": "string" }, "sparte": { "$ref": "#/components/schemas/Sparte", "description": "Contains information about the division" }, "strasse": { "description": "Street", "type": "string" }, "transaktionsgrund": { "description": "The transaction reason describes the business transaction for the category in more detail / UTILMD STS+7++###+ZW4+E03", "type": "string" }, "transaktionsgrundergaenzung": { "description": "Supplement to the transaction reason / UTILMD STS+7++E01+###+E03", "type": "string" }, "vertragsbeginn": { "description": "Specifies when the contract begins.", "format": "date-time", "type": "string" }, "verwendungAb": { "description": "verwendungAb", "format": "date-time", "type": "string" }, "verwendungBis": { "description": "verwendungBis", "format": "date-time", "type": "string" }, "zahlerBlindarbeitLf": { "description": "Payment of reactive energy by the supplier", "type": "boolean" }, "zeitraumId": { "description": "zeitraumId", "type": "integer" } } } }