{
"openapi": "3.1.0",
"info": {
"title": "START_LIEFERENDE (LF)",
"version": "202604",
"description": "The event `START_LIEFERENDE` 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_LIEFERENDE"
}
],
"paths": {
"/inbound": {
"post": {
"deprecated": false,
"description": "Trigger-Event **START_LIEFERENDE** der Marktrolle LF.\n\n**Startet diese Rollensichten** (2):\n\n- [Lieferende von LF an NB — LF (GPKE Teil 2)](/prozessdoku/202604/LF/GPKE-Teil2-lieferende-von-lf-an-nb)\n- [Lieferende von LF an NB — LF (GeLi Gas 2.0)](/prozessdoku/202604/LF/geli-gas-2-0-lieferende-von-lf-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 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.\n\n",
"operationId": "trigger_LF_START_LIEFERENDE",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"START_LIEFERENDE_LF_Z16": {
"$ref": "#/components/examples/START_LIEFERENDE_LF_Z16"
},
"START_LIEFERENDE_LF_Z22": {
"$ref": "#/components/examples/START_LIEFERENDE_LF_Z22"
},
"START_LIEFERENDE_NB": {
"$ref": "#/components/examples/START_LIEFERENDE_NB"
}
},
"schema": {
"$ref": "#/components/schemas/LF_START_LIEFERENDE"
}
}
}
},
"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_LIEFERENDE (LF)",
"tags": [
"START_LIEFERENDE"
],
"x-actual-endpoint": "POST /inbound",
"x-event-source": "event/202604/[LF]_START_LIEFERENDE.yaml",
"x-handbuchsatz": true
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"type": "http"
}
},
"schemas": {
"LF_START_LIEFERENDE": {
"properties": {
"stammdaten": {
"anyOf": [
{
"$ref": "#/components/schemas/PI_44004__stammdaten"
},
{
"$ref": "#/components/schemas/PI_55004__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"
},
"freitext": {
"$ref": "#/components/schemas/freitext"
},
"kategorie": {
"$ref": "#/components/schemas/kategorie"
},
"pruefidentifikator": {
"description": "Determined dynamically in the event process (basis for the decision: sparte). A value supplied by the sender is ignored. Check identifiers possible in the topic — 44004, 55004.",
"examples": [
"44004",
"55004"
]
},
"sparte": {
"$ref": "#/components/schemas/sparte"
},
"transaktionsgrund": {
"$ref": "#/components/schemas/transaktionsgrund"
},
"transaktionsgrundergaenzung": {
"$ref": "#/components/schemas/transaktionsgrundergaenzung"
}
},
"required": [
"absender",
"empfaenger",
"freitext",
"kategorie",
"sparte",
"transaktionsgrund",
"transaktionsgrundergaenzung"
],
"type": "object"
},
"zusatzdaten": {
"properties": {
"eventname": {
"const": "START_LIEFERENDE",
"default": "START_LIEFERENDE",
"type": "string"
},
"prozessId": {
"type": "string"
}
},
"required": [
"prozessId",
"eventname"
],
"type": "object"
}
},
"required": [
"stammdaten",
"transaktionsdaten",
"zusatzdaten"
],
"type": "object"
},
"MarktlokationsTyp": {
"description": "Levy type",
"enum": [
"STANDARD_MARKTLOKATION",
"RUHENDE_MARKTLOKATION",
"KUNDENANLAGE"
],
"title": "Levy type",
"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_44004__stammdaten": {
"properties": {
"MARKTLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_44004__stammdaten__MARKTLOKATION"
},
"type": "array"
},
"NETZNUTZUNGSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_44004__stammdaten__NETZNUTZUNGSVERTRAG"
},
"type": "array"
}
},
"required": [
"MARKTLOKATION"
],
"type": "object",
"title": "44004"
},
"PI_44004__stammdaten__MARKTLOKATION": {
"properties": {
"marktlokationsId": {
"$ref": "#/components/schemas/marktlokationsId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+172"
]
}
},
"required": [
"marktlokationsId"
],
"type": "object"
},
"PI_44004__stammdaten__NETZNUTZUNGSVERTRAG": {
"properties": {
"vertragsbeginn": {
"$ref": "#/components/schemas/vertragsbeginn",
"x-edifact-segment": [
"SG4.IDE+24.DTM+92"
]
},
"vertragsende": {
"$ref": "#/components/schemas/vertragsende",
"x-edifact-segment": [
"SG4.IDE+24.DTM+93"
]
}
},
"type": "object"
},
"PI_55004__stammdaten": {
"properties": {
"MARKTLOKATION": {
"items": {
"$ref": "#/components/schemas/PI_55004__stammdaten__MARKTLOKATION"
},
"type": "array"
},
"NETZNUTZUNGSVERTRAG": {
"items": {
"$ref": "#/components/schemas/PI_55004__stammdaten__NETZNUTZUNGSVERTRAG"
},
"type": "array"
},
"TRANCHE": {
"items": {
"$ref": "#/components/schemas/PI_55004__stammdaten__TRANCHE"
},
"type": "array"
}
},
"type": "object",
"title": "55004"
},
"PI_55004__stammdaten__MARKTLOKATION": {
"properties": {
"marktlokationsId": {
"$ref": "#/components/schemas/marktlokationsId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+Z16",
"SG4.IDE+24.SG5.LOC+Z22"
]
},
"marktlokationsTyp": {
"items": {
"$ref": "#/components/schemas/PI_55004__stammdaten__MARKTLOKATION__marktlokationsTyp"
},
"type": "array"
}
},
"type": "object"
},
"PI_55004__stammdaten__MARKTLOKATION__marktlokationsTyp": {
"properties": {
"typ": {
"$ref": "#/components/schemas/typ",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+Z16",
"SG4.IDE+24.SG5.LOC+Z22"
]
}
},
"type": "object"
},
"PI_55004__stammdaten__NETZNUTZUNGSVERTRAG": {
"properties": {
"vertragsbeginn": {
"$ref": "#/components/schemas/vertragsbeginn",
"x-edifact-segment": [
"SG4.IDE+24.DTM+92"
]
},
"vertragsende": {
"$ref": "#/components/schemas/vertragsende",
"x-edifact-segment": [
"SG4.IDE+24.DTM+93"
]
}
},
"type": "object"
},
"PI_55004__stammdaten__TRANCHE": {
"properties": {
"tranchenId": {
"$ref": "#/components/schemas/tranchenId",
"x-edifact-segment": [
"SG4.IDE+24.SG5.LOC+Z21"
]
}
},
"type": "object"
},
"Sparte": {
"description": "Division",
"enum": [
"STROM",
"GAS",
"FERNWAERME",
"NAHWAERME",
"WASSER",
"ABWASSER"
],
"title": "Division",
"type": "string"
},
"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"
},
"freitext": {
"description": "Free text / FTX+ACB",
"type": "string"
},
"kategorie": {
"description": "Qualifier from the beginning of the EDIFACT message / BGM",
"type": "string"
},
"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."
},
"rollencodenummer": {
"description": "Specifies the code value of the market role.",
"type": "string"
},
"sparte": {
"$ref": "#/components/schemas/Sparte",
"description": "Contains information about the division"
},
"tranchenId": {
"description": "tranchenId",
"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"
},
"typ": {
"$ref": "#/components/schemas/MarktlokationsTyp",
"description": "Typing of the market location as standard market location, dormant market location or customer installation"
},
"vertragsbeginn": {
"description": "Specifies when the contract begins.",
"format": "date-time",
"type": "string"
},
"vertragsende": {
"description": "Contract end date / DTM+93",
"format": "date-time",
"type": "string"
}
},
"examples": {
"START_LIEFERENDE_LF_Z16": {
"summary": "START_LIEFERENDE - End of supply cons. MaLo Electricity LF to NB",
"value": {
"stammdaten": {
"MARKTLOKATION": [
{
"boTyp": "MARKTLOKATION",
"energierichtung": "AUSSP",
"marktlokationsId": "57685676748",
"marktlokationsTyp": [
{
"typ": "STANDARD_MARKTLOKATION"
}
],
"sparte": "STROM",
"versionStruktur": "1"
}
]
},
"transaktionsdaten": {
"absender": {
"rollencodenummer": "9904000000005",
"rollencodetyp": "BDEW"
},
"empfaenger": {
"rollencodenummer": "9900936000002",
"rollencodetyp": "BDEW"
},
"kategorie": "E02",
"sparte": "STROM",
"transaktionsgrund": "E01",
"transaktionsgrundergaenzung": "ZW4",
"vertragsende": "2025-10-31T23:00:00Z"
},
"zusatzdaten": {
"eventname": "START_LIEFERENDE",
"prozessId": "00505688-E4A2-1EDF-A0C2-C81842E2515E"
}
}
},
"START_LIEFERENDE_LF_Z22": {
"summary": "START_LIEFERENDE - end of supply generation MaLo electricity LF to NB",
"value": {
"stammdaten": {
"TRANCHE": [
{
"boTyp": "TRANCHE",
"energierichtung": "EINSP",
"sparte": "STROM",
"tranchenId": "57685676742",
"versionStruktur": "1"
}
]
},
"transaktionsdaten": {
"absender": {
"rollencodenummer": "9904000000005",
"rollencodetyp": "BDEW"
},
"empfaenger": {
"rollencodenummer": "9900936000002",
"rollencodetyp": "BDEW"
},
"kategorie": "E02",
"sparte": "STROM",
"transaktionsgrund": "E01",
"transaktionsgrundergaenzung": "ZW3",
"vertragsende": "2025-10-31T23:00:00Z"
},
"zusatzdaten": {
"eventname": "START_LIEFERENDE",
"prozessId": "00505688-E4A2-1EDF-A0C2-C81842E2515E"
}
}
},
"START_LIEFERENDE_NB": {
"summary": "START_LIEFERENDE - End of supply cons. MaLo Electricity NB to LF",
"value": {
"stammdaten": {
"MARKTLOKATION": [
{
"boTyp": "MARKTLOKATION",
"energierichtung": "AUSSP",
"marktlokationsId": "57685676748",
"marktlokationsTyp": [
{
"typ": "STANDARD_MARKTLOKATION"
}
],
"sparte": "STROM",
"versionStruktur": "1"
}
]
},
"transaktionsdaten": {
"absender": {
"rollencodenummer": "9904000000005",
"rollencodetyp": "BDEW"
},
"empfaenger": {
"rollencodenummer": "9900936000002",
"rollencodetyp": "BDEW"
},
"kategorie": "E02",
"sparte": "STROM",
"transaktionsgrund": "Z33",
"transaktionsgrundergaenzung": "ZW4",
"vertragsende": "2025-10-31T23:00:00Z"
},
"zusatzdaten": {
"eventname": "START_LIEFERENDE",
"prozessId": "00505688-E4A2-1EDF-A0C2-C81842E2515E"
}
}
}
}
}
}