Reading backend interfaces
Read calculation formula
Read calculation formula
GET
https://mock.macoapp.de
/getCalculationFormulaBasic
Reading the calculation formula of a location (Parameter1) of type (Parameter2 - default MALO) as of the key date (Parameter3)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | Location ID · Example: 74018657187 · Default: 74018657187 | string |
parameter2* | Location type · Example: MALO · Default: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Date (valid from) or key date if parameter4 is not set · Example: 2024-06-28T12:18:00Z · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter4 | Date (Valid until) · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
command | Corresponds to the operationId of this interface. This operation ID corresponds to the command in the Camunda connector process. If the backend provides a generic endpoint, this command can be used to define which operation is to be executed. | string |
Read calculation formula › Responses
Successful reading of the calculation formula
Array of: Calculation formula — the response is a list of these objects, not a single object. Every entry has this structure:
| Structure (BO4E) | Description | Format |
|---|---|---|
boTyp* | Type of the 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 | The inclusive point in time from which the calculation formula is valid | string (date-time) |
notwendigkeit | Status of the calculation formula STS Z23 PI 25001 | stringBERECHNUNGSFORMEL_NOTWENDIG, BERECHNUNGSFORMEL_MUSS_ANGEFRAGT_WERDEN, BERECHNUNGSFORMEL_TRIVIAL BERECHNUNGSFORMEL_NICHT_NOTWENDIG |
lieferrichtung | Delivery direction of the market location | stringAUSSP, EINSP |
rechenschrittId | Reference to a calculation step - calculation step identifier in a calculation formula that yields the energy quantity result. RFF Z23 PI 25001 | integer |
| rechenschritt | Component of the calculation step SEQ Z37 PI 25001 | object |
rechenschrittBestandteilId | Calculation step identifier | integer |
referenzRechenschrittId | Reference calculation step ID | integer |
operation | Mathematical operator - operation CAV Z69 PI 25001 | stringADDITION, SUBTRAKTION, DIVISION DIVIDEND, MULTIPLIKATION, POSITIVWERT |
verlustfaktorTrafo | Loss factor transformer, is always to be applied multiplicatively CAV Z28 PI 25001 | number (float) |
verlustfaktorLeitung | Loss factor line, losses caused by lines/cables are taken into account with this factor CAV Z28 PI 25001 | number (float) |
aufteilungsfaktorEnergiemenge | Allocation factor for the energy quantity CAV ZH6 PI 25001 | number (float) |
messlokationsId | Reference to the ID of a metering location RFF Z19 PI 25001 | string |
marktlokationsId | marktlokationsId | string |
energieflussrichtung | Delivery direction of the market location | stringAUSSP, EINSP |
bezeichnungOperanden | Bezeichnung der Operanden | string |
| rechenschritte[ ] | Component of the calculation step SEQ Z37 PI 25001 | object[] |
rechenschrittBestandteilId | Calculation step identifier | integer |
referenzRechenschrittId | Reference calculation step ID | integer |
operation | Mathematical operator - operation CAV Z69 PI 25001 | stringADDITION, SUBTRAKTION, DIVISION DIVIDEND, MULTIPLIKATION, POSITIVWERT |
verlustfaktorTrafo | Loss factor transformer, is always to be applied multiplicatively CAV Z28 PI 25001 | number (float) |
verlustfaktorLeitung | Loss factor line, losses caused by lines/cables are taken into account with this factor CAV Z28 PI 25001 | number (float) |
aufteilungsfaktorEnergiemenge | Allocation factor for the energy quantity CAV ZH6 PI 25001 | number (float) |
messlokationsId | Reference to the ID of a metering location RFF Z19 PI 25001 | string |
marktlokationsId | marktlokationsId | string |
energieflussrichtung | Delivery direction of the market location | stringAUSSP, EINSP |
bezeichnungOperanden | Bezeichnung der Operanden | string |
| verwendungszweck[ ] | . | object[] |
marktrolle | Identification of the market role 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[ ] | Purpose of use value | string[]NETZNUTZUNGSABRECHNUNG, BILANZKREISABRECHNUNG, MEHRMINDERMENGENABRECHNUNG ENDKUNDENABRECHNUNG, UEBERMITTLUNG_AN_DAS_HKNR, BLINDARBEITSABRECHNUNG, ERMITTLUNG_AUSGEGLICHENHEIT_BILANZKREIS, BLINDARBEITABRECHNUNG_BETRIEBSFUEHRUNG, ES_LIEGT_KEIN_VERWENDUNGSZWECK_VOR |
| gueltigkeitszeitraum | Validity period of the values | object |
zeiteinheit | not in use | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Time span, value | integer |
startdatum | Date from DTM Z25 Use of the data from DTM 163 Processing, start date/time DTM 155 Invoicing period, start date DTM Z42 Provisional billing period start | string (date-time) |
enddatum | Date from DTM Z26 Use of the data until DTM164 Processing, end date/time DTM 156 Invoicing period, end date DTM Z43 Provisional billing period end | string (date-time) |
einheit | not in use | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Periodic meter reading of the NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Date on which the grid usage settlement of the NB takes place DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | Period text | string |
zeitraumId | Reference to period ID RFF Z46 PI 25001 | integer |
lokationsId | Unique number of the location to which the calculation formula belongs. Used for necessary internal assignments. | string |
lokationsTyp | Indicates which location type this is. Used for necessary internal assignments. | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
berechnungsformel | Berechnungsformel | string |
datenqualitaet | Data quality | 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) |