Transmission of information

START_UEBERMITTLUNG_ENFG (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Übermittlung von Informationen — LF

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationenText": "allgemeineInformationenText",
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "gueltigkeitsZeitspanne": "gueltigkeitsZeitspanne",
            "lokationsId": "lokationsId",
            "positionsnummer": 0,
            "privilegierteEnergiemenge": {
              "menge": {
                "einheit": "W",
                "wert": 0
              },
              "verwendungAb": "2024-08-25T15:00:00Z",
              "verwendungBis": "2024-08-25T15:00:00Z"
            },
            "sendungsposition": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}'

START_UEBERMITTLUNG_ENFG (LF) › Request Body

The body of this call — one column per admissible Prüfidentifikator. A value in the column means the field belongs to that Prüfidentifikator: Must where the schema requires it, otherwise May.

Structure (BO4E)	Description	Format	21045
stammdaten*	—	object	Muss
ENERGIELIEFERVERTRAG[ ]	—	object[]	Kann
vertragspartner2[ ]	—	object[]	Kann
`anrede`00010	The form of address for the GePa, e.g. Mr.	string	Kann
`geschaeftspartnerrolle`[ ]00020	Geschaeftspartnerrolle	string[]	Kann
`KUNDE`			Kann
`LIEFERANT`			Kann
`DIENSTLEISTER`			Kann
`INTERESSENT`			Kann
`MARKTPARTNER`			Kann
`EIGENTUEMER`			Kann
`HAUSVERWALTER`			Kann
`KORRESPONDENZEMPFAENGER`			Kann
`ABLESEKARTENEMPFAENGER`			Kann
`gewerbekennzeichnung`00030	Indicates whether this is a commercial business/company (gewerbeKennzeichnung = true) or a private individual. (gewerbeKennzeichnung = false)	boolean	Kann
`name1`00040	First part of the name. Here the company name or, for private individuals, for example the surname can be entered. Examples: Yellow Strom GmbH or Hagen	string	Kann
`name2`00050	Second part of the name. This can hold an extension to the company name or, for private individuals, the first name, for example. Examples: South region or Nina	string	Kann
`name3`00060	Third part of the name. Here further additions to the company name or, for private individuals, additions to the name can be shown. Examples: and Africa or singer	string	Kann
`name4`00070	name4	string	Kann
STATUSMITTEILUNG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`allgemeineInformationenText`00080	Allgemeine Informationen	string	Kann
`auftragsStatusListe`[ ]*00090	Order status	string[]	Muss
`GESCHEITERT`			Muss
`ERFOLGREICH`			Muss
`LIEFERUNG_GEPLANT`			Muss
`GEPLANT`			Muss
`ZUGESTIMMT`			Muss
`WIDERSPROCHEN`			Muss
`STOERUNGSFREI`			Muss
`GESTOERT`			Muss
`FESTGESTELLTE_STOERUNG`			Muss
`VERMUTETE_STOERUNG`			Muss
`ABGELEHNT`			Muss
`BEENDET`			Muss
`ANTWORT_DRITTER`			Muss
`BESTAETIGT`			Muss
`UMGESETZT`			Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss
`ENFG_SCHIENENBAHNEN`			Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss
`ENFG_LANDSTROMANLAGEN`			Muss
`AENDERUNG_DER_DATEN`			Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss
`ZEITREIHE_AKZEPTIERT`			Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss
`gueltigkeitsZeitspanne`*00100	gueltigkeitsZeitspanne	string	Muss
`lokationsId`*00110	Which market or metering location this request applies to.	string	Muss
`positionsnummer`*00120	Line item number	integer	Muss
`sendungsposition`00130	sendungsposition	integer	Kann
privilegierteEnergiemenge*	—	object	Muss
`verwendungAb`*00140	verwendungAb	string (date-time)	Muss
`verwendungBis`*00150	verwendungBis	string (date-time)	Muss
menge*	—	object	Muss
`einheit`*00160	Unit: measurands that can be determined by measurement or by specification	string	Muss
`W`			Muss
`WH`			Muss
`KW`			Muss
`KWH`			Muss
`KVARH`			Muss
`MW`			Muss
`MWH`			Muss
`STUECK`			Muss
`KUBIKMETER`			Muss
`STUNDE`			Muss
`TAG`			Muss
`MONAT`			Muss
`JAHR`			Muss
`PROZENT`			Muss
`ANZAHL`			Muss
`VAR`			Muss
`KVAR`			Muss
`VARH`			Muss
`KWHK`			Muss
`Z16`			Muss
`KWT`			Muss
`wert`*00170	Value	number (float)	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00180	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 21045.	—	Kann
`sparte`*00200	Contains information about the division	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00210	Specifies the code value of the market role.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00220	Specifies the code value of the market role.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00230	—	string	Muss
`prozessId`*00240	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationenText": "allgemeineInformationenText",
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "gueltigkeitsZeitspanne": "gueltigkeitsZeitspanne",
            "lokationsId": "lokationsId",
            "positionsnummer": 0,
            "privilegierteEnergiemenge": {
              "menge": {
                "einheit": "W",
                "wert": 0
              },
              "verwendungAb": "2024-08-25T15:00:00Z",
              "verwendungBis": "2024-08-25T15:00:00Z"
            },
            "sendungsposition": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}

json

START_UEBERMITTLUNG_ENFG (LF) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_UEBERMITTLUNG_ENFG der Marktrolle LF.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Der 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.

Cancellation of the interruption and…Transmission of a definition of LF…

START_UEBERMITTLUNG_ENFG (LF)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (1):

Übermittlung von Informationen — LF

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationenText": "allgemeineInformationenText",
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "gueltigkeitsZeitspanne": "gueltigkeitsZeitspanne",
            "lokationsId": "lokationsId",
            "positionsnummer": 0,
            "privilegierteEnergiemenge": {
              "menge": {
                "einheit": "W",
                "wert": 0
              },
              "verwendungAb": "2024-08-25T15:00:00Z",
              "verwendungBis": "2024-08-25T15:00:00Z"
            },
            "sendungsposition": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}'

START_UEBERMITTLUNG_ENFG (LF) › Request Body

Structure (BO4E)	Description	Format	21045
stammdaten*	—	object	Muss
ENERGIELIEFERVERTRAG[ ]	—	object[]	Kann
vertragspartner2[ ]	—	object[]	Kann
`anrede`00010	The form of address for the GePa, e.g. Mr.	string	Kann
`geschaeftspartnerrolle`[ ]00020	Geschaeftspartnerrolle	string[]	Kann
`KUNDE`			Kann
`LIEFERANT`			Kann
`DIENSTLEISTER`			Kann
`INTERESSENT`			Kann
`MARKTPARTNER`			Kann
`EIGENTUEMER`			Kann
`HAUSVERWALTER`			Kann
`KORRESPONDENZEMPFAENGER`			Kann
`ABLESEKARTENEMPFAENGER`			Kann
`gewerbekennzeichnung`00030	Indicates whether this is a commercial business/company (gewerbeKennzeichnung = true) or a private individual. (gewerbeKennzeichnung = false)	boolean	Kann
`name1`00040	First part of the name. Here the company name or, for private individuals, for example the surname can be entered. Examples: Yellow Strom GmbH or Hagen	string	Kann
`name2`00050	Second part of the name. This can hold an extension to the company name or, for private individuals, the first name, for example. Examples: South region or Nina	string	Kann
`name3`00060	Third part of the name. Here further additions to the company name or, for private individuals, additions to the name can be shown. Examples: and Africa or singer	string	Kann
`name4`00070	name4	string	Kann
STATUSMITTEILUNG[ ]*	—	object[]	Muss
positionsdaten[ ]*	—	object[]	Muss
`allgemeineInformationenText`00080	Allgemeine Informationen	string	Kann
`auftragsStatusListe`[ ]*00090	Order status	string[]	Muss
`GESCHEITERT`			Muss
`ERFOLGREICH`			Muss
`LIEFERUNG_GEPLANT`			Muss
`GEPLANT`			Muss
`ZUGESTIMMT`			Muss
`WIDERSPROCHEN`			Muss
`STOERUNGSFREI`			Muss
`GESTOERT`			Muss
`FESTGESTELLTE_STOERUNG`			Muss
`VERMUTETE_STOERUNG`			Muss
`ABGELEHNT`			Muss
`BEENDET`			Muss
`ANTWORT_DRITTER`			Muss
`BESTAETIGT`			Muss
`UMGESETZT`			Muss
`ENFG_STROMSPEICHER_UND_VERLUSTENERGIE`			Muss
`ENFG_ELEKTRISCH_ANGETRIEBENE_WAERMEPUMPEN`			Muss
`ENFG_UMLAGEERHEBUNG_BEI_ANLAGEN_ZUR_VERSTROMUNG_VON_KUPPELGASEN`			Muss
`ENFG_HERSTELLUNG_VON_GRUENEN_WASSERSTOFF`			Muss
`ENFG_STROMKOSTENINTENSIVE_UNTERNEHMEN`			Muss
`ENFG_HERSTELLUNG_VON_WASSERSTOFF_IN_STROMKOSTENINTENSIVEN_UNTERNEHMEN`			Muss
`ENFG_SCHIENENBAHNEN`			Muss
`ENFG_ELEKTRISCHE_BETRIEBENE_BUSSEN_IM_LINIENVERKEHR`			Muss
`ENFG_LANDSTROMANLAGEN`			Muss
`AENDERUNG_DER_DATEN`			Muss
`KEINE_AENDERUNG_DER_DATEN`			Muss
`ZEITREIHE_AKZEPTIERT`			Muss
`ZEITREIHE_NICHT_AKZEPTIERT`			Muss
`gueltigkeitsZeitspanne`*00100	gueltigkeitsZeitspanne	string	Muss
`lokationsId`*00110	Which market or metering location this request applies to.	string	Muss
`positionsnummer`*00120	Line item number	integer	Muss
`sendungsposition`00130	sendungsposition	integer	Kann
privilegierteEnergiemenge*	—	object	Muss
`verwendungAb`*00140	verwendungAb	string (date-time)	Muss
`verwendungBis`*00150	verwendungBis	string (date-time)	Muss
menge*	—	object	Muss
`einheit`*00160	Unit: measurands that can be determined by measurement or by specification	string	Muss
`W`			Muss
`WH`			Muss
`KW`			Muss
`KWH`			Muss
`KVARH`			Muss
`MW`			Muss
`MWH`			Muss
`STUECK`			Muss
`KUBIKMETER`			Muss
`STUNDE`			Muss
`TAG`			Muss
`MONAT`			Muss
`JAHR`			Muss
`PROZENT`			Muss
`ANZAHL`			Muss
`VAR`			Muss
`KVAR`			Muss
`VARH`			Muss
`KWHK`			Muss
`Z16`			Muss
`KWT`			Muss
`wert`*00170	Value	number (float)	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00180	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 21045.	—	Kann
`sparte`*00200	Contains information about the division	string	Muss
`STROM`			Muss
`GAS`			Muss
`FERNWAERME`			Muss
`NAHWAERME`			Muss
`WASSER`			Muss
`ABWASSER`			Muss
absender*	—	object	Muss
`rollencodenummer`00210	Specifies the code value of the market role.	string	Kann
empfaenger*	—	object	Muss
`rollencodenummer`00220	Specifies the code value of the market role.	string	Kann
zusatzdaten*	—	object	Muss
`eventname`*00230	—	string	Muss
`prozessId`*00240	—	string	Muss

Example Request Body

{
  "stammdaten": {
    "ENERGIELIEFERVERTRAG": [
      {
        "vertragspartner2": [
          {
            "anrede": "anrede",
            "geschaeftspartnerrolle": [
              "KUNDE"
            ],
            "gewerbekennzeichnung": true,
            "name1": "name1",
            "name2": "name2",
            "name3": "name3",
            "name4": "name4"
          }
        ]
      }
    ],
    "STATUSMITTEILUNG": [
      {
        "positionsdaten": [
          {
            "allgemeineInformationenText": "allgemeineInformationenText",
            "auftragsStatusListe": [
              "GESCHEITERT"
            ],
            "gueltigkeitsZeitspanne": "gueltigkeitsZeitspanne",
            "lokationsId": "lokationsId",
            "positionsnummer": 0,
            "privilegierteEnergiemenge": {
              "menge": {
                "einheit": "W",
                "wert": 0
              },
              "verwendungAb": "2024-08-25T15:00:00Z",
              "verwendungBis": "2024-08-25T15:00:00Z"
            },
            "sendungsposition": 0
          }
        ]
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "pruefidentifikator": "21045",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_UEBERMITTLUNG_ENFG",
    "prozessId": "prozessId"
  }
}

json

START_UEBERMITTLUNG_ENFG (LF) › Responses

Success | Success

Structure (BO4E)	Description	Format
`businessKey`*	Unique identifier of the business process \| Unique identifier of the business process	string (uuid)
`message`*	Message with details about the triggered event \| Message with details about the triggered event	string

Trigger-Event START_UEBERMITTLUNG_ENFG der Marktrolle LF.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Feedback on the documentation

Feedback on the documentation

Transmission of information

START_UEBERMITTLUNG_ENFG (LF)

START_UEBERMITTLUNG_ENFG (LF) › Request Body

START_UEBERMITTLUNG_ENFG (LF) › Responses

Transmission of information

START_UEBERMITTLUNG_ENFG (LF)

START_UEBERMITTLUNG_ENFG (LF) › Request Body

START_UEBERMITTLUNG_ENFG (LF) › Responses