Lesende Backend-Schnittstellen
Berechnungsformel lesen
Berechnungsformel lesen
GET
https://mock.macoapp.de
/getCalculationFormulaBasic
Lesen der Berechnunungsformel einer Lokation (Parameter1) vom Typ (Parameter2 - default MALO) zum Stichtag (Parameter3)
query Parameters
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
parameter1* | LokationsId · Beispiel: 74018657187 · Vorgabe: 74018657187 | string |
parameter2* | LokationsTyp · Beispiel: MALO · Vorgabe: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Datum (Gültig ab) oder Stichtag, wenn parameter4 nicht gesetzt · Beispiel: 2024-06-28T12:18:00Z · Muster: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter4 | Datum (Gültig bis) · Muster: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
command | Entspricht der operationId dieser Schnittstelle. Diese Operation Id entspricht dem Command im Camunda Konnektor Prozess. Wenn das Backend einen generischen Endpunkt bereitstellt, kann dieses Command gentutzt werden um zu definieren welche Operation ausgeführt werden soll. | string |
Berechnungsformel lesen › Responses
Erfolgreiches Lesen der Berechnunungsformel
Array of: Berechnungsformel — die Antwort ist eine Liste dieser Objekte, nicht ein einzelnes Objekt. Jeder Eintrag hat diesen Aufbau:
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
boTyp* | Typ des BO | stringANSPRECHPARTNER, AVIS, ENERGIEMENGE GESCHAEFTSOBJEKT, GESCHAEFTSPARTNER, MARKTLOKATION, MARKTTEILNEHMER, MESSLOKATION, ZAEHLER, KOSTEN, TARIF, PREISBLATT, PREISBLATTNETZNUTZUNG, PREISBLATTMESSUNG, PREISBLATTUMLAGEN, PREISBLATTDIENSTLEISTUNG, PREISBLATTKONZESSIONSABGABE, ZEITREIHE, LASTGANG, HANDELSUNSTIMMIGKEIT, ANFRAGE, AUFTRAG, STATUSMITTEILUNG, BERECHNUNGSFORMEL, RECHNUNG, BILANZIERUNG, NETZNUTZUNGSVERTRAG, MESSSTELLENBETRIEBSVERTRAG, ENERGIELIEFERVERTRAG, SPERRAUFTRAG, ANGEBOT, TRANCHE, KOMMUNIKATIONSDATEN, ZAEHLZEITDEFINITION, SCHALTZEITDEFINITION, LEISTUNGSKURVENDEFINITION, NETZLOKATION, STEUERBARE_RESSOURCE, TECHNISCHE_RESSOURCE, AD_HOC_STEUERKANAL, LOKATIONSBUENDEL, WERTE_NACH_TYP2, REKLAMATION, STATUSBERICHT, VERTRAG, BILANZKREIS, VERWENDUNGSZEITRAUM, TARIFINFO, SUMMENZEITREIHE |
versionStruktur* | versionStruktur | string |
beginndatum | Der inklusive Zeitpunkt ab dem die Berechnungsformel gültig ist | string (date-time) |
notwendigkeit | Status der Berechnungsformel STS Z23 PI 25001 | stringBERECHNUNGSFORMEL_NOTWENDIG, BERECHNUNGSFORMEL_MUSS_ANGEFRAGT_WERDEN, BERECHNUNGSFORMEL_TRIVIAL BERECHNUNGSFORMEL_NICHT_NOTWENDIG |
lieferrichtung | Lieferrichtung der Marktlokation | stringAUSSP, EINSP |
rechenschrittId | Referenz auf einen Rechenschritt - Rechenschrittidentifikator in einer Berechnungsformel, der das Ergebnis der Energiemenge ergibt. RFF Z23 PI 25001 | integer |
| rechenschritt | Bestandteil des Rechenschritts SEQ Z37 PI 25001 | object |
rechenschrittBestandteilId | Rechenschrittidentifikator | integer |
referenzRechenschrittId | Referenz Rechenschritt Id | integer |
operation | Mathematischer Operator - Operation CAV Z69 PI 25001 | stringADDITION, SUBTRAKTION, DIVISION DIVIDEND, MULTIPLIKATION, POSITIVWERT |
verlustfaktorTrafo | Verlustfaktor Trafo, ist immer multiplikativ anzuwenden CAV Z28 PI 25001 | number (float) |
verlustfaktorLeitung | Verlustfaktor Leitung, Leitungen/Kabeln verursachten Verluste, werden mit diesem Faktor berücksichtigt CAV Z28 PI 25001 | number (float) |
aufteilungsfaktorEnergiemenge | Aufteilungsfaktor Energiemenge CAV ZH6 PI 25001 | number (float) |
messlokationsId | Referenz auf die ID einer Messlokation RFF Z19 PI 25001 | string |
marktlokationsId | marktlokationsId | string |
energieflussrichtung | Lieferrichtung der Marktlokation | stringAUSSP, EINSP |
bezeichnungOperanden | Bezeichnung der Operanden | string |
| rechenschritte[ ] | Bestandteil des Rechenschritts SEQ Z37 PI 25001 | object[] |
rechenschrittBestandteilId | Rechenschrittidentifikator | integer |
referenzRechenschrittId | Referenz Rechenschritt Id | integer |
operation | Mathematischer Operator - Operation CAV Z69 PI 25001 | stringADDITION, SUBTRAKTION, DIVISION DIVIDEND, MULTIPLIKATION, POSITIVWERT |
verlustfaktorTrafo | Verlustfaktor Trafo, ist immer multiplikativ anzuwenden CAV Z28 PI 25001 | number (float) |
verlustfaktorLeitung | Verlustfaktor Leitung, Leitungen/Kabeln verursachten Verluste, werden mit diesem Faktor berücksichtigt CAV Z28 PI 25001 | number (float) |
aufteilungsfaktorEnergiemenge | Aufteilungsfaktor Energiemenge CAV ZH6 PI 25001 | number (float) |
messlokationsId | Referenz auf die ID einer Messlokation RFF Z19 PI 25001 | string |
marktlokationsId | marktlokationsId | string |
energieflussrichtung | Lieferrichtung der Marktlokation | stringAUSSP, EINSP |
bezeichnungOperanden | Bezeichnung der Operanden | string |
| verwendungszweck[ ] | . | object[] |
marktrolle | Identifizierung der Marktrolle CCI ZA8 PI 55639 55644 55659 55664 55043 55168 55169 55649 55654 55684 55685 55686 55687 55660 55665 55662 55667 ORDERS PI 17121 17134 | stringNB, LF, MSB MSBA, GMSB, MDL, DL, BKV, UENB, KUNDE-SELBST-NN, MGV, EIV, RB, KUNDE, INTERESSENT, KN, UBA, BIKO, ESA |
zweck[ ] | VerwendungszweckValue | string[]NETZNUTZUNGSABRECHNUNG, BILANZKREISABRECHNUNG, MEHRMINDERMENGENABRECHNUNG ENDKUNDENABRECHNUNG, UEBERMITTLUNG_AN_DAS_HKNR, BLINDARBEITSABRECHNUNG, ERMITTLUNG_AUSGEGLICHENHEIT_BILANZKREIS, BLINDARBEITABRECHNUNG_BETRIEBSFUEHRUNG, ES_LIEGT_KEIN_VERWENDUNGSZWECK_VOR |
| gueltigkeitszeitraum | Gültigkeitszeitraum der Werte | object |
zeiteinheit | nicht in Benutzung | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Zeitspanne, Wert | integer |
startdatum | Datum aus DTM Z25 Verwendung der Daten ab DTM 163 Verarbeitung, Beginndatum/-zeit DTM 155 Rechnungsperiode, Beginndatum DTM Z42 vorläufiger Abrechnungszeitraum Beginn | string (date-time) |
enddatum | Datum aus DTM Z26 Verwendung der Daten bis DTM164 Verarbeitung, Endedatum/-zeit DTM 156 Rechnungsperiode, Endedatum DTM Z43 vorläufiger Abrechnungszeitraum Ende | string (date-time) |
einheit | nicht in Benutzung | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Turnusablesung des NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Termin, zu dem die Netznutzungsabrechnung des NB erfolgt DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | ZeitraumText | string |
zeitraumId | Referenz auf Zeitraum-ID RFF Z46 PI 25001 | integer |
lokationsId | Eindeutige Nummer der Lokation, zu der die Berechnungsformel gehört. Verwendung für notwendige interne Zuordnungen. | string |
lokationsTyp | Gibt an,um welchen Lokationstyp es sich handelt. Verwendung für notwendige interne Zuordnungen. | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
berechnungsformel | Berechnungsformel | string |
datenqualitaet | Datenqualitaet | stringERWARTETE_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 |
parameterIDs[ ] | Parameter IDs | string[] |
| aufteilungsfaktoren[ ] | Aufteilungsfaktor | object[] |
bezeichnungAufteilungsfaktor | Bezeichnung des Aufteilungsfaktors | string |
faktor | Faktor | number (float) |