Supplementary data on the location bundle…

START_BERECHNUNGSFORMEL (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}'

START_BERECHNUNGSFORMEL (NB) › 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	25001
stammdaten*	—	object	Muss
BERECHNUNGSFORMEL[ ]	—	object[]	Kann
`notwendigkeit`00010	DefinitionsNecessity	string	Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET`			Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`rechenschrittId`00020	ID of the calculation step [1 - 99999]	integer	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00030	zeitraumId	integer	Kann
rechenschritte[ ]	—	object[]	Kann
`aufteilungsfaktorEnergiemenge`00040	aufteilungsfaktorEnergiemenge	number (float)	Kann
`energieflussrichtung`00050	Specifies the energy direction of a market location and/or metering location	string	Kann
`AUSSP`			Kann
`EINSP`			Kann
`messlokationsId`00060	The metering location identification. This is the former metering point identifier, e.g. DE 47108151234567	string	Kann
`operation`00070	This enumeration defines arithmetic operations	string	Kann
`ADDITION`			Kann
`SUBTRAKTION`			Kann
`DIVISION`			Kann
`DIVIDEND`			Kann
`MULTIPLIKATION`			Kann
`POSITIVWERT`			Kann
`rechenschrittBestandteilId`00080	rechenschrittBestandteilId	integer	Kann
`referenzRechenschrittId`00090	referenzRechenschrittId	integer	Kann
`verlustfaktorLeitung`00100	verlustfaktorLeitung	number (float)	Kann
`verlustfaktorTrafo`00110	verlustfaktorTrafo	number (float)	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00120	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`verwendungAb`*00130	verwendungAb	string (date-time)	Muss
`verwendungBis`00140	verwendungBis	string (date-time)	Kann
`zeitraumId`*00150	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss
`lokationsId`*00170	Which market or metering location this request applies to.	string	Muss
`lokationsTyp`*00180	Type of the location	string	Muss
`MALO`			Muss
`MELO`			Muss
`NELO`			Muss
`TECHNISCHE_RESSOURCE`			Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 25001.	—	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": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}

json

START_BERECHNUNGSFORMEL (NB) › 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_BERECHNUNGSFORMEL der Marktrolle NB.

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 105 Rumpfvarianten heraus, damit sie einzeln lesbar und ausprobierbar sind.

Interruption of grid connection use…Order placement for master data change to LF…

Process triggers NB

Supplementary data on the location bundle…

Download schema

START_BERECHNUNGSFORMEL (NB)

POST

https://api.macoapp.de

/inbound

Startet diese Rollensichten (2):

POST/inbound

curl https://api.macoapp.de/inbound \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "stammdaten": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}'

START_BERECHNUNGSFORMEL (NB) › Request Body

Structure (BO4E)	Description	Format	25001
stammdaten*	—	object	Muss
BERECHNUNGSFORMEL[ ]	—	object[]	Kann
`notwendigkeit`00010	DefinitionsNecessity	string	Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET`			Kann
`ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_VERWENDET`			Kann
`DEFINITIONEN_WERDEN_NICHT_VERWENDET`			Kann
`rechenschrittId`00020	ID of the calculation step [1 - 99999]	integer	Kann
gueltigkeitszeitraum	—	object	Kann
`zeitraumId`00030	zeitraumId	integer	Kann
rechenschritte[ ]	—	object[]	Kann
`aufteilungsfaktorEnergiemenge`00040	aufteilungsfaktorEnergiemenge	number (float)	Kann
`energieflussrichtung`00050	Specifies the energy direction of a market location and/or metering location	string	Kann
`AUSSP`			Kann
`EINSP`			Kann
`messlokationsId`00060	The metering location identification. This is the former metering point identifier, e.g. DE 47108151234567	string	Kann
`operation`00070	This enumeration defines arithmetic operations	string	Kann
`ADDITION`			Kann
`SUBTRAKTION`			Kann
`DIVISION`			Kann
`DIVIDEND`			Kann
`MULTIPLIKATION`			Kann
`POSITIVWERT`			Kann
`rechenschrittBestandteilId`00080	rechenschrittBestandteilId	integer	Kann
`referenzRechenschrittId`00090	referenzRechenschrittId	integer	Kann
`verlustfaktorLeitung`00100	verlustfaktorLeitung	number (float)	Kann
`verlustfaktorTrafo`00110	verlustfaktorTrafo	number (float)	Kann
VERWENDUNGSZEITRAUM[ ]*	—	object[]	Muss
`datenqualitaet`*00120	Data quality	string	Muss
`ERWARTETE_DATEN`			Muss
`IM_SYSTEM_VORHANDENE_DATEN`			Muss
`INFORMATIVE_DATEN`			Muss
`GUELTIGE_DATEN`			Muss
`KEINE_DATEN`			Muss
`IM_SYSTEM_KEINE_DATEN_VORHANDEN`			Muss
`KEINE_DATEN_ERWARTET`			Muss
`DIFFERENZ_DATEN`			Muss
`DIFFERENZ_ERWARTETE_DATEN`			Muss
`DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN`			Muss
`verwendungAb`*00130	verwendungAb	string (date-time)	Muss
`verwendungBis`00140	verwendungBis	string (date-time)	Kann
`zeitraumId`*00150	zeitraumId	integer	Muss
transaktionsdaten*	—	object	Muss
`kategorie`*00160	Qualifier from the beginning of the EDIFACT message / BGM	string	Muss
`lokationsId`*00170	Which market or metering location this request applies to.	string	Muss
`lokationsTyp`*00180	Type of the location	string	Muss
`MALO`			Muss
`MELO`			Muss
`NELO`			Muss
`TECHNISCHE_RESSOURCE`			Muss
`pruefidentifikator`00190	Determined dynamically in the event process. A value supplied by the sender is ignored. Check identifiers possible in the topic — 25001.	—	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": {
    "BERECHNUNGSFORMEL": [
      {
        "gueltigkeitszeitraum": {
          "zeitraumId": 0
        },
        "notwendigkeit": "ZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET",
        "rechenschrittId": 0,
        "rechenschritte": [
          {
            "aufteilungsfaktorEnergiemenge": 0,
            "energieflussrichtung": "AUSSP",
            "messlokationsId": "messlokationsId",
            "operation": "ADDITION",
            "rechenschrittBestandteilId": 0,
            "referenzRechenschrittId": 0,
            "verlustfaktorLeitung": 0,
            "verlustfaktorTrafo": 0
          }
        ]
      }
    ],
    "VERWENDUNGSZEITRAUM": [
      {
        "datenqualitaet": "ERWARTETE_DATEN",
        "verwendungAb": "2024-08-25T15:00:00Z",
        "verwendungBis": "2024-08-25T15:00:00Z",
        "zeitraumId": 0
      }
    ]
  },
  "transaktionsdaten": {
    "absender": {
      "rollencodenummer": "rollencodenummer"
    },
    "empfaenger": {
      "rollencodenummer": "rollencodenummer"
    },
    "kategorie": "kategorie",
    "lokationsId": "lokationsId",
    "lokationsTyp": "MALO",
    "pruefidentifikator": "25001",
    "sparte": "STROM"
  },
  "zusatzdaten": {
    "eventname": "START_BERECHNUNGSFORMEL",
    "prozessId": "prozessId"
  }
}

json

START_BERECHNUNGSFORMEL (NB) › 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_BERECHNUNGSFORMEL der Marktrolle NB.

Schema nur dieses Ereignisses herunterladen (OpenAPI, JSON).

Notes on this page

Interruption of grid connection use…Order placement for master data change to LF…

Feedback on the documentation

Feedback on the documentation

Supplementary data on the location bundle…

START_BERECHNUNGSFORMEL (NB)

START_BERECHNUNGSFORMEL (NB) › Request Body

START_BERECHNUNGSFORMEL (NB) › Responses

Supplementary data on the location bundle…

START_BERECHNUNGSFORMEL (NB)

START_BERECHNUNGSFORMEL (NB) › Request Body

START_BERECHNUNGSFORMEL (NB) › Responses