bo4e.com package
Submodules
bo4e.com.adresse module
Contains Adresse class
- class bo4e.com.adresse.Adresse(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ADRESSE] = ComTyp.ADRESSE, postleitzahl: str | None = None, ort: str | None = None, ortsteil: str | None = None, strasse: str | None = None, hausnummer: str | None = None, postfach: str | None = None, adresszusatz: str | None = None, coErgaenzung: str | None = None, landescode: Landescode | None = Landescode.DE, **extra_data: Any)[source]
Bases:
COM
Contains an address that can be used for most purposes.
Hint
- co_ergaenzung: str | None
Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. “c/o Veronica Hauptmieterin”
- landescode: Landescode | None
Offizieller ISO-Landescode
bo4e.com.angebotsposition module
Contains Angebotsposition class
- class bo4e.com.angebotsposition.Angebotsposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ANGEBOTSPOSITION] = ComTyp.ANGEBOTSPOSITION, positionsbezeichnung: str | None = None, positionspreis: Preis | None = None, positionsmenge: Menge | None = None, positionskosten: Betrag | None = None, **extra_data: Any)[source]
Bases:
COM
Unterhalb von Angebotsteilen sind die Angebotspositionen eingebunden. Hier werden die angebotenen Bestandteile einzeln aufgeführt. Beispiel: Positionsmenge: 4000 kWh Positionspreis: 24,56 ct/kWh Positionskosten: 982,40 EUR
bo4e.com.angebotsteil module
Contains Angebotsteil class
- class bo4e.com.angebotsteil.Angebotsteil(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ANGEBOTSTEIL] = ComTyp.ANGEBOTSTEIL, positionen: list[Angebotsposition] | None = None, anfrageSubreferenz: str | None = None, lieferstellenangebotsteil: list[Marktlokation] | None = None, gesamtmengeangebotsteil: Menge | None = None, gesamtkostenangebotsteil: Betrag | None = None, lieferzeitraum: Zeitraum | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente wird ein Teil einer Angebotsvariante abgebildet. Hier werden alle Angebotspositionen aggregiert. Angebotsteile werden im einfachsten Fall für eine Marktlokation oder Lieferstellenadresse erzeugt. Hier werden die Mengen und Gesamtkosten aller Angebotspositionen zusammengefasst. Eine Variante besteht mindestens aus einem Angebotsteil.
- anfrage_subreferenz: str | None
Identifizierung eines Subkapitels einer Anfrage, beispielsweise das Los einer Ausschreibung
- gesamtkostenangebotsteil: Betrag | None
Summe der Jahresenergiekosten aller in diesem Angebotsteil enthaltenen Lieferstellen
- gesamtmengeangebotsteil: Menge | None
Summe der Verbräuche aller in diesem Angebotsteil eingeschlossenen Lieferstellen
- lieferstellenangebotsteil: list[Marktlokation] | None
Marktlokationen, für die dieses Angebotsteil gilt, falls vorhanden. Durch die Marktlokation ist auch die Lieferadresse festgelegt
- lieferzeitraum: Zeitraum | None
Hier kann der Belieferungszeitraum angegeben werden, für den dieser Angebotsteil gilt
- positionen: list[Angebotsposition] | None
Einzelne Positionen, die zu diesem Angebotsteil gehören
bo4e.com.angebotsvariante module
Contains Angebotsvariante
- class bo4e.com.angebotsvariante.Angebotsvariante(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ANGEBOTSVARIANTE] = ComTyp.ANGEBOTSVARIANTE, angebotsstatus: Angebotsstatus | None = None, erstellungsdatum: AwareDatetime | None = None, bindefrist: AwareDatetime | None = None, teile: list[Angebotsteil] | None = None, gesamtmenge: Menge | None = None, gesamtkosten: Betrag | None = None, **extra_data: Any)[source]
Bases:
COM
Führt die verschiedenen Ausprägungen der Angebotsberechnung auf
- angebotsstatus: Angebotsstatus | None
Gibt den Status eines Angebotes an.
- teile: list[Angebotsteil] | None
Angebotsteile werden im einfachsten Fall für eine Marktlokation oder Lieferstellenadresse erzeugt. Hier werden die Mengen und Gesamtkosten aller Angebotspositionen zusammengefasst. Eine Variante besteht mindestens aus einem Angebotsteil.
bo4e.com.aufabschlag module
Contains AufAbschlag class
- class bo4e.com.aufabschlag.AufAbschlag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUFABSCHLAG] = ComTyp.AUFABSCHLAG, bezeichnung: str | None = None, staffeln: list[Preisstaffel] | None = None, beschreibung: str | None = None, aufAbschlagstyp: AufAbschlagstyp | None = None, aufAbschlagsziel: AufAbschlagsziel | None = None, einheit: Waehrungseinheit | None = None, website: str | None = None, gueltigkeitszeitraum: Zeitraum | None = None, **extra_data: Any)[source]
Bases:
COM
Modell für die preiserhöhenden (Aufschlag) bzw. preisvermindernden (Abschlag) Zusatzvereinbarungen, die individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen wurden.
- auf_abschlagstyp: AufAbschlagstyp | None
Typ des Aufabschlages (z.B. absolut oder prozentual).
- auf_abschlagsziel: AufAbschlagsziel | None
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc..
- einheit: Waehrungseinheit | None
Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.. (Nur im Falle absoluter Aufschlagstypen).
- gueltigkeitszeitraum: Zeitraum | None
Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.
- staffeln: list[Preisstaffel] | None
Werte für die gestaffelten Auf/Abschläge.
bo4e.com.aufabschlagproort module
Contains AufAbschlagProOrt class
- class bo4e.com.aufabschlagproort.AufAbschlagProOrt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUFABSCHLAGPROORT] = ComTyp.AUFABSCHLAGPROORT, postleitzahl: str | None = None, ort: str | None = None, netznr: str | None = None, staffeln: list[AufAbschlagstaffelProOrt] | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit örtlichen Gültigkeiten abgebildet werden.
- staffeln: list[AufAbschlagstaffelProOrt] | None
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung.
bo4e.com.aufabschlagregional module
Contains AufAbschlagRegional
- class bo4e.com.aufabschlagregional.AufAbschlagRegional(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUFABSCHLAGREGIONAL] = ComTyp.AUFABSCHLAGREGIONAL, bezeichnung: str | None = None, betraege: list[AufAbschlagProOrt] | None = None, beschreibung: str | None = None, aufAbschlagstyp: AufAbschlagstyp | None = None, aufAbschlagsziel: AufAbschlagsziel | None = None, einheit: Waehrungseinheit | None = None, website: str | None = None, zusatzprodukte: list[str] | None = None, voraussetzungen: list[str] | None = None, tarifnamensaenderungen: str | None = None, gueltigkeitszeitraum: Zeitraum | None = None, energiemixaenderung: Energiemix | None = None, vertagskonditionsaenderung: Vertragskonditionen | None = None, garantieaenderung: Preisgarantie | None = None, einschraenkungsaenderung: Tarifeinschraenkung | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet werden. Hier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert, die sich durch die Auswahl eines Auf- oder Abschlags ergeben.
- auf_abschlagstyp: AufAbschlagstyp | None
Typ des Aufabschlages (z.B. absolut oder prozentual)
- auf_abschlagsziel: AufAbschlagsziel | None
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.
- betraege: list[AufAbschlagProOrt] | None
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung
- einheit: Waehrungseinheit | None
Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.
- einschraenkungsaenderung: Tarifeinschraenkung | None
Änderungen in den Einschränkungen zum Tarif. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- energiemixaenderung: Energiemix | None
Der Energiemix kann sich durch einen AufAbschlag ändern (z.B. zwei Cent Aufschlag für Ökostrom: Sollte dies der Fall sein, wird hier die neue Zusammensetzung des Energiemix angegeben.
- garantieaenderung: Preisgarantie | None
Änderungen in den Garantievereinbarungen. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- tarifnamensaenderungen: str | None
Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten.
- typ: Annotated[Literal[ComTyp.AUFABSCHLAGREGIONAL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- vertagskonditionsaenderung: Vertragskonditionen | None
Änderungen in den Vertragskonditionen. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
bo4e.com.aufabschlagstaffelproort module
Contains AufAbschlagstaffelProOrt class
- class bo4e.com.aufabschlagstaffelproort.AufAbschlagstaffelProOrt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUFABSCHLAGSTAFFELPROORT] = ComTyp.AUFABSCHLAGSTAFFELPROORT, wert: Decimal | None = None, staffelgrenzeVon: Decimal | None = None, staffelgrenzeBis: Decimal | None = None, **extra_data: Any)[source]
Bases:
COM
Gibt den Wert eines Auf- oder Abschlags und dessen Staffelgrenzen an
bo4e.com.ausschreibungsdetail module
Contains class Ausschreibungsdetail
- class bo4e.com.ausschreibungsdetail.Ausschreibungsdetail(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUSSCHREIBUNGSDETAIL] = ComTyp.AUSSCHREIBUNGSDETAIL, marktlokationsId: str | None = None, netzebeneLieferung: str | None = None, netzebeneMessung: str | None = None, marktlokationsadresse: Adresse | None = None, lieferzeitraum: Zeitraum | None = None, netzbetreiber: str | None = None, kunde: str | None = None, zaehlernummer: str | None = None, marktlokationsbezeichnung: str | None = None, zaehlertechnik: Zaehlertyp | None = None, istLastgangVorhanden: bool | None = None, prognoseJahresarbeit: Menge | None = None, prognoseArbeitLieferzeitraum: Menge | None = None, prognoseLeistung: Menge | None = None, rechnungsadresse: Adresse | None = None, **extra_data: Any)[source]
Bases:
COM
Die Komponente Ausschreibungsdetail wird verwendet um die Informationen zu einer Abnahmestelle innerhalb eines Ausschreibungsloses abzubilden.
- ist_lastgang_vorhanden: bool | None
Zeigt an, ob es zu der Marktlokation einen Lastgang gibt. Falls ja, kann dieser abgerufen werden und daraus die Verbrauchswerte ermittelt werden
- marktlokationsbezeichnung: str | None
Bezeichnung für die Lokation, z.B. ‘Zentraler Einkauf, Hamburg’
- netzbetreiber: str | None
Bezeichnung des zuständigen Netzbetreibers, z.B. ‘Stromnetz Hamburg GmbH’
- netzebene_lieferung: str | None
In der angegebenen Netzebene wird die Marktlokation versorgt, z.B. MSP für Mittelspannung
- netzebene_messung: str | None
In der angegebenen Netzebene wird die Lokation gemessen, z.B. NSP für Niederspannung
- prognose_arbeit_lieferzeitraum: Menge | None
Ein Prognosewert für die Arbeit innerhalb des angefragten Lieferzeitraums der ausgeschriebenen Lokation
- prognose_jahresarbeit: Menge | None
Prognosewert für die Jahresarbeit der ausgeschriebenen Lokation
- prognose_leistung: Menge | None
Prognosewert für die abgenommene maximale Leistung der ausgeschriebenen Lokation
- typ: Annotated[Literal[ComTyp.AUSSCHREIBUNGSDETAIL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zaehlertechnik: Zaehlertyp | None
Spezifikation, um welche Zählertechnik es sich im vorliegenden Fall handelt, z.B. Leistungsmessung
bo4e.com.ausschreibungslos module
Contains Ausschreibungslos class
- class bo4e.com.ausschreibungslos.Ausschreibungslos(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.AUSSCHREIBUNGSLOS] = ComTyp.AUSSCHREIBUNGSLOS, losnummer: str | None = None, bezeichnung: str | None = None, preismodell: Preismodell | None = None, energieart: Sparte | None = None, wunschRechnungslegung: Rechnungslegung | None = None, wunschVertragsform: Vertragsform | None = None, betreutDurch: str | None = None, anzahlLieferstellen: int | None = None, lieferstellen: list[Ausschreibungsdetail] | None = None, lieferzeitraum: Zeitraum | None = None, bemerkung: str | None = None, gesamtMenge: Menge | None = None, wunschMindestmenge: Menge | None = None, wunschMaximalmenge: Menge | None = None, wiederholungsintervall: Zeitraum | None = None, wunschKuendingungsfrist: Zeitraum | None = None, wunschZahlungsziel: Zeitraum | None = None, **extra_data: Any)[source]
Bases:
COM
Eine Komponente zur Abbildung einzelner Lose einer Ausschreibung
- gesamt_menge: Menge | None
Gibt den Gesamtjahresverbrauch (z.B. in kWh) aller in diesem Los enthaltenen Lieferstellen an
- lieferstellen: list[Ausschreibungsdetail] | None
Die ausgeschriebenen Lieferstellen
- lieferzeitraum: Zeitraum | None
Zeitraum, für den die in diesem Los enthaltenen Lieferstellen beliefert werden sollen
- preismodell: Preismodell | None
Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung
- typ: Annotated[Literal[ComTyp.AUSSCHREIBUNGSLOS], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- wiederholungsintervall: Zeitraum | None
In welchem Intervall die Angebotsabgabe wiederholt werden darf. Angabe nur gesetzt für die 2. Phase bei öffentlich-rechtlichen Ausschreibungen
- wunsch_rechnungslegung: Rechnungslegung | None
Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen
- wunsch_vertragsform: Vertragsform | None
Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen
bo4e.com.betrag module
Contains Betrag class
- class bo4e.com.betrag.Betrag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.BETRAG] = ComTyp.BETRAG, wert: Decimal | None = None, waehrung: Waehrungscode | None = None, **extra_data: Any)[source]
Bases:
COM
Die Komponente wird dazu verwendet, Summenbeträge (beispielsweise in Angeboten und Rechnungen) als Geldbeträge abzubilden. Die Einheit ist dabei immer die Hauptwährung also Euro, Dollar etc…
Hint
- typ: Annotated[Literal[ComTyp.BETRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- waehrung: Waehrungscode | None
Die entsprechende Waehrung
bo4e.com.com module
Contains base class for all components
- class bo4e.com.com.COM(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, **extra_data: Any)[source]
Bases:
BaseModel
base class for all components
Hint
- id: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='_id', alias_priority=2)]
Eine generische ID, die für eigene Zwecke genutzt werden kann. Z.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.
- version: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='_version', alias_priority=2)]
Version der COM-Struktur aka “fachliche Versionierung”
- zusatz_attribute: list[ZusatzAttribut] | None
bo4e.com.dienstleistung module
Contains Dienstleistung class
- class bo4e.com.dienstleistung.Dienstleistung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.DIENSTLEISTUNG] = ComTyp.DIENSTLEISTUNG, dienstleistungstyp: Dienstleistungstyp | None = None, bezeichnung: str | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung einer abrechenbaren Dienstleistung.
- dienstleistungstyp: Dienstleistungstyp | None
Kennzeichnung der Dienstleistung
bo4e.com.energieherkunft module
Contains Energieherkunft class
- class bo4e.com.energieherkunft.Energieherkunft(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ENERGIEHERKUNFT] = ComTyp.ENERGIEHERKUNFT, erzeugungsart: Erzeugungsart | None = None, anteilProzent: Decimal | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung einer Energieherkunft
- erzeugungsart: Erzeugungsart | None
Art der Erzeugung der Energie.
bo4e.com.energiemix module
Contains Energiemix class
- class bo4e.com.energiemix.Energiemix(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ENERGIEMIX] = ComTyp.ENERGIEMIX, energiemixnummer: int | None = None, energieart: Sparte | None = None, bezeichnung: str | None = None, gueltigkeitsjahr: int | None = None, anteil: list[Energieherkunft] | None = None, bemerkung: str | None = None, co2Emission: Decimal | None = None, atommuell: Decimal | None = None, oekozertifikate: list[Oekozertifikat] | None = None, oekolabel: list[Oekolabel] | None = None, istInOekoTopTen: bool | None = None, website: str | None = None, **extra_data: Any)[source]
Bases:
COM
Zusammensetzung der gelieferten Energie aus den verschiedenen Primärenergieformen.
- anteil: list[Energieherkunft] | None
Anteile der jeweiligen Erzeugungsart
- oekozertifikate: list[Oekozertifikat] | None
Zertifikate für den Energiemix
bo4e.com.fremdkostenblock module
Contains Fremdkostenblock class
- class bo4e.com.fremdkostenblock.Fremdkostenblock(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.FREMDKOSTENBLOCK] = ComTyp.FREMDKOSTENBLOCK, kostenblockbezeichnung: str | None = None, kostenpositionen: list[Fremdkostenposition] | None = None, summeKostenblock: Betrag | None = None, **extra_data: Any)[source]
Bases:
COM
Komponente zur Abbildung eines Kostenblocks in den Fremdkosten
- kostenblockbezeichnung: str | None
Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.
- kostenpositionen: list[Fremdkostenposition] | None
Hier sind die Details zu einer Kostenposition aufgeführt. Z.B.: Alliander Netz Heinsberg GmbH, 2018-02-01, 2019-01-01, Arbeitspreis HT, 3.660 kWh, 5,8200 ct/kWh, 213,01 €
bo4e.com.fremdkostenposition module
Contains Fremdkostenposition
- class bo4e.com.fremdkostenposition.Fremdkostenposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.FREMDKOSTENPOSITION] = ComTyp.FREMDKOSTENPOSITION, positionstitel: str | None = None, betragKostenposition: Betrag | None = None, artikelbezeichnung: str | None = None, einzelpreis: Preis | None = None, von: AwareDatetime | None = None, bis: AwareDatetime | None = None, menge: Menge | None = None, zeitmenge: Menge | None = None, artikeldetail: str | None = None, marktpartnername: str | None = None, marktpartnercode: str | None = None, gebietcodeEic: str | None = None, linkPreisblatt: str | None = None, **extra_data: Any)[source]
Bases:
Kostenposition
Eine Kostenposition im Bereich der Fremdkosten
- gebietcode_eic: str | None
EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. ‘10YDE-EON——1’ für die Regelzone TenneT
- marktpartnercode: str | None
Die Codenummer (z.B. BDEW-Codenummer) des Marktpartners, der die Preise festlegt / die Kosten in Rechnung stellt
bo4e.com.geokoordinaten module
Contains Geokoordinaten class
- class bo4e.com.geokoordinaten.Geokoordinaten(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.GEOKOORDINATEN] = ComTyp.GEOKOORDINATEN, breitengrad: Decimal | None = None, laengengrad: Decimal | None = None, **extra_data: Any)[source]
Bases:
COM
This component provides the geo-coordinates for a location.
bo4e.com.katasteradresse module
Contains Katasteradresse class
- class bo4e.com.katasteradresse.Katasteradresse(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KATASTERADRESSE] = ComTyp.KATASTERADRESSE, gemarkungFlur: str | None = None, flurstueck: str | None = None, **extra_data: Any)[source]
Bases:
COM
Dient der Adressierung über die Liegenschafts-Information.
bo4e.com.konfigurationsprodukt module
Contains Konfigurationsprodukt class
- class bo4e.com.konfigurationsprodukt.Konfigurationsprodukt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KONFIGURATIONSPRODUKT] = ComTyp.KONFIGURATIONSPRODUKT, produktcode: str | None = None, leistungskurvendefinition: str | None = None, schaltzeitdefinition: str | None = None, marktpartner: Marktteilnehmer | None = None, **extra_data: Any)[source]
Bases:
COM
Object containing information about a Konfigurationsprodukt
- marktpartner: Marktteilnehmer | None
bo4e.com.kontaktweg module
Contains Kontaktweg class
- class bo4e.com.kontaktweg.Kontaktweg(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KONTAKTWEG] = ComTyp.KONTAKTWEG, kontaktart: Kontaktart | None = None, beschreibung: str | None = None, kontaktwert: str | None = None, istBevorzugterKontaktweg: bool | None = None, **extra_data: Any)[source]
Bases:
COM
Die Komponente wird dazu verwendet, die Kontaktwege innerhalb des BOs Person darzustellen
Hint
- kontaktart: Kontaktart | None
Gibt die Kontaktart des Kontaktes an.
bo4e.com.konzessionsabgabe module
Contains Konzessionsabgabe
- class bo4e.com.konzessionsabgabe.Konzessionsabgabe(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KONZESSIONSABGABE] = ComTyp.KONZESSIONSABGABE, satz: AbgabeArt | None = None, kosten: Decimal | None = None, kategorie: str | None = None, **extra_data: Any)[source]
Bases:
COM
Diese Komponente wird zur Übertagung der Details zu einer Konzessionsabgabe verwendet.
bo4e.com.kostenblock module
Contains Kostenblock
- class bo4e.com.kostenblock.Kostenblock(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KOSTENBLOCK] = ComTyp.KOSTENBLOCK, kostenblockbezeichnung: str | None = None, summeKostenblock: Betrag | None = None, kostenpositionen: list[Kostenposition] | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente werden mehrere Kostenpositionen zusammengefasst.
- kostenblockbezeichnung: str | None
Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.
- kostenpositionen: list[Kostenposition] | None
Hier sind die Details zu einer Kostenposition aufgeführt. Z.B.: Alliander Netz Heinsberg GmbH, 01.02.2018, 31.12.2018, Arbeitspreis HT, 3.660 kWh, 5,8200 ct/kWh, 213,01 €
bo4e.com.kostenposition module
Contains Kostenposition
- class bo4e.com.kostenposition.Kostenposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KOSTENPOSITION] = ComTyp.KOSTENPOSITION, positionstitel: str | None = None, betragKostenposition: Betrag | None = None, artikelbezeichnung: str | None = None, einzelpreis: Preis | None = None, von: AwareDatetime | None = None, bis: AwareDatetime | None = None, menge: Menge | None = None, zeitmenge: Menge | None = None, artikeldetail: str | None = None, **extra_data: Any)[source]
Bases:
COM
Diese Komponente wird zur Übertagung der Details zu einer Kostenposition verwendet.
- artikelbezeichnung: str | None
Arbeitspreis HT
- Type:
Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel
- betrag_kostenposition: Betrag | None
Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung <Menge * Einzelpreis> oder <Einzelpreis / (Anzahl Tage Jahr) * zeitmenge>
- einzelpreis: Preis | None
5,8200 ct/kWh oder 55 €/Jahr.
- Type:
Der Preis für eine Einheit. Beispiele
- menge: Menge | None
3.660 kWh
- Type:
Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel
- positionstitel: str | None
Ein Titel für die Zeile. Hier kann z.B. der Netzbetreiber eingetragen werden, wenn es sich um Netzkosten handelt.
bo4e.com.kriteriumwert module
Contains KriteriumWert class
- class bo4e.com.kriteriumwert.KriteriumWert(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.KRITERIUMWERT] = ComTyp.KRITERIUMWERT, kriterium: Tarifregionskriterium | None = None, wert: str | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Kriterien und deren Werte definiert werden
- kriterium: Tarifregionskriterium | None
Hier steht, für welches Kriterium der Wert gilt. Z.B. Postleitzahlen
bo4e.com.lastprofil module
Contains class Lastprofil
- class bo4e.com.lastprofil.Lastprofil(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.LASTPROFIL] = ComTyp.LASTPROFIL, bezeichnung: str | None = None, profilschar: str | None = None, verfahren: Profilverfahren | None = None, istEinspeisung: bool | None = None, tagesparameter: Tagesparameter | None = None, profilart: Profilart | None = None, herausgeber: str | None = None, **extra_data: Any)[source]
Bases:
COM
Informationen zum Lastprofil.
- bezeichnung: str | None
Bezeichnung des Profils, durch DVGW bzw. den Netzbetreiber vergeben (z.B. H0)
- tagesparameter: Tagesparameter | None
Klimazone / Temperaturmessstelle
- typ: Annotated[Literal[ComTyp.LASTPROFIL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- verfahren: Profilverfahren | None
Verfahren des Profils (analytisch oder synthetisch)
bo4e.com.marktgebietinfo module
Contains Marktgebietinfo class
- class bo4e.com.marktgebietinfo.MarktgebietInfo(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.MARKTGEBIETINFO] = ComTyp.MARKTGEBIETINFO, marktgebiet: str | None = None, marktgebietcode: str | None = None, **extra_data: Any)[source]
Bases:
COM
Informationen zum Marktgebiet im Gas.
bo4e.com.menge module
Contains Menge class
- class bo4e.com.menge.Menge(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.MENGE] = ComTyp.MENGE, wert: Decimal | None = None, einheit: Mengeneinheit | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung einer Menge mit Wert und Einheit.
Hint
- einheit: Mengeneinheit | None
Gibt die Einheit zum jeweiligen Wert an
bo4e.com.positionsaufabschlag module
Contains PositionsAufAbschlag
- class bo4e.com.positionsaufabschlag.PositionsAufAbschlag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.POSITIONSAUFABSCHLAG] = ComTyp.POSITIONSAUFABSCHLAG, bezeichnung: str | None = None, beschreibung: str | None = None, aufAbschlagstyp: AufAbschlagstyp | None = None, aufAbschlagswert: Decimal | None = None, aufAbschlagswaehrung: Waehrungseinheit | None = None, **extra_data: Any)[source]
Bases:
COM
Differenzierung der zu betrachtenden Produkte anhand der preiserhöhenden (Aufschlag) bzw. preisvermindernden (Abschlag) Zusatzvereinbarungen, die individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen werden können. Es können mehrere Auf-/Abschläge gleichzeitig ausgewählt werden.
- auf_abschlagstyp: AufAbschlagstyp | None
Typ des AufAbschlages
- auf_abschlagswaehrung: Waehrungseinheit | None
Einheit, in der der Auf-/Abschlag angegeben ist (z.B. ct/kWh).
bo4e.com.preis module
Contains Preis class
- class bo4e.com.preis.Preis(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.PREIS] = ComTyp.PREIS, wert: Decimal | None = None, einheit: Waehrungseinheit | None = None, bezugswert: Mengeneinheit | None = None, status: Preisstatus | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung eines Preises mit Wert, Einheit, Bezugswert und Status.
Hint
- bezugswert: Mengeneinheit | None
Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.
- einheit: Waehrungseinheit | None
Währungseinheit für den Preis, z.B. Euro oder Ct.
- status: Preisstatus | None
Gibt den Status des veröffentlichten Preises an
bo4e.com.preisgarantie module
Contains Preisgarantie class
- class bo4e.com.preisgarantie.Preisgarantie(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.PREISGARANTIE] = ComTyp.PREISGARANTIE, preisgarantietyp: Preisgarantietyp | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, beschreibung: str | None = None, **extra_data: Any)[source]
Bases:
COM
Definition für eine Preisgarantie mit der Möglichkeit verschiedener Ausprägungen.
- preisgarantietyp: Preisgarantietyp | None
Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.
bo4e.com.preisposition module
Contains Preisposition class
- class bo4e.com.preisposition.Preisposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.PREISPOSITION] = ComTyp.PREISPOSITION, berechnungsmethode: Kalkulationsmethode | None = None, leistungstyp: Leistungstyp | None = None, leistungsbezeichnung: str | None = None, preiseinheit: Waehrungseinheit | None = None, bezugsgroesse: Mengeneinheit | None = None, preisstaffeln: list[Preisstaffel] | None = None, zeitbasis: Mengeneinheit | None = None, tarifzeit: Tarifzeit | None = None, bdewArtikelnummer: BDEWArtikelnummer | None = None, zonungsgroesse: Bemessungsgroesse | None = None, freimengeBlindarbeit: Decimal | None = None, freimengeLeistungsfaktor: Decimal | None = None, gruppenartikelId: str | None = None, **extra_data: Any)[source]
Bases:
COM
Preis für eine definierte Lieferung oder Leistung innerhalb eines Preisblattes
- bdew_artikelnummer: BDEWArtikelnummer | None
Eine vom BDEW standardisierte Bezeichnug für die abgerechnete Leistungserbringung; Diese Artikelnummer wird auch im Rechnungsteil der INVOIC verwendet.
- berechnungsmethode: Kalkulationsmethode | None
Das Modell, das der Preisbildung zugrunde liegt
- bezugsgroesse: Mengeneinheit | None
Hier wird festgelegt, auf welche Bezugsgrösse sich der Preis bezieht, z.B. kWh oder Stück
- freimenge_blindarbeit: Decimal | None
Der Anteil der Menge der Blindarbeit in Prozent von der Wirkarbeit, für die keine Abrechnung erfolgt
- freimenge_leistungsfaktor: Decimal | None
Der cos phi (Verhältnis Wirkleistung/Scheinleistung) aus dem die Freimenge für die Blindarbeit berechnet wird als tan phi (Verhältnis Blindleistung/Wirkleistung)
- gruppenartikel_id: str | None
Übergeordnete Gruppen-ID, die sich ggf. auf die Artikel-ID in der Preisstaffel bezieht
- leistungsbezeichnung: str | None
Bezeichnung für die in der Position abgebildete Leistungserbringung
- leistungstyp: Leistungstyp | None
Standardisierte Bezeichnung für die abgerechnete Leistungserbringung
- preiseinheit: Waehrungseinheit | None
Festlegung, mit welcher Preiseinheit abgerechnet wird, z.B. Ct. oder €
- preisstaffeln: list[Preisstaffel] | None
Preisstaffeln, die zu dieser Preisposition gehören
- typ: Annotated[Literal[ComTyp.PREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zeitbasis: Mengeneinheit | None
Die Zeit(dauer) auf die sich der Preis bezieht. Z.B. ein Jahr für einen Leistungspreis der in €/kW/Jahr ausgegeben wird
- zonungsgroesse: Bemessungsgroesse | None
Mit der Menge der hier angegebenen Größe wird die Staffelung/Zonung durchgeführt. Z.B. Vollbenutzungsstunden
bo4e.com.preisstaffel module
Contains Preisstaffel
- class bo4e.com.preisstaffel.Preisstaffel(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.PREISSTAFFEL] = ComTyp.PREISSTAFFEL, einheitspreis: Decimal | None = None, staffelgrenzeVon: Decimal | None = None, staffelgrenzeBis: Decimal | None = None, sigmoidparameter: Sigmoidparameter | None = None, artikelId: str | None = None, **extra_data: Any)[source]
Bases:
COM
Gibt die Staffelgrenzen der jeweiligen Preise an
- artikel_id: str | None
Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst
- sigmoidparameter: Sigmoidparameter | None
Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter
bo4e.com.rechnungsposition module
Contains Rechnungsposition class
- class bo4e.com.rechnungsposition.Rechnungsposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.RECHNUNGSPOSITION] = ComTyp.RECHNUNGSPOSITION, positionsnummer: int | None = None, lieferungVon: AwareDatetime | None = None, lieferungBis: AwareDatetime | None = None, positionstext: str | None = None, positionsMenge: Menge | None = None, einzelpreis: Preis | None = None, teilsummeNetto: Betrag | None = None, teilsummeSteuer: Steuerbetrag | None = None, zeiteinheit: Mengeneinheit | None = None, artikelnummer: BDEWArtikelnummer | None = None, lokationsId: str | None = None, zeitbezogeneMenge: Menge | None = None, teilrabattNetto: Betrag | None = None, artikelId: str | None = None, **extra_data: Any)[source]
Bases:
COM
Über Rechnungspositionen werden Rechnungen strukturiert. In einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet.
- artikel_id: str | None
Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst
- artikelnummer: BDEWArtikelnummer | None
Kennzeichnung der Rechnungsposition mit der Standard-Artikelnummer des BDEW
- teilsumme_netto: Betrag | None
Das Ergebnis der Multiplikation aus einzelpreis * positionsMenge * (Faktor aus zeitbezogeneMenge). Z.B. 12,60€ * 120 kW * 3/12 (für 3 Monate).
- teilsumme_steuer: Steuerbetrag | None
Auf die Position entfallende Steuer, bestehend aus Steuersatz und Betrag
- typ: Annotated[Literal[ComTyp.RECHNUNGSPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zeitbezogene_menge: Menge | None
Eine auf die Zeiteinheit bezogene Untermenge. Z.B. bei einem Jahrespreis, 3 Monate oder 146 Tage. Basierend darauf wird der Preis aufgeteilt.
- zeiteinheit: Mengeneinheit | None
Falls sich der Preis auf eine Zeit bezieht, steht hier die Einheit
bo4e.com.regionalegueltigkeit module
Contains RegionaleGueltigkeit class
- class bo4e.com.regionalegueltigkeit.RegionaleGueltigkeit(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONALEGUELTIGKEIT] = ComTyp.REGIONALEGUELTIGKEIT, gueltigkeitstyp: Gueltigkeitstyp | None = None, kriteriumsWerte: list[KriteriumWert] | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können regionale Gültigkeiten, z.B. für Tarife, Zu- und Abschläge und Preise definiert werden.
- gueltigkeitstyp: Gueltigkeitstyp | None
Unterscheidung ob Positivliste oder Negativliste übertragen wird
- kriteriums_werte: list[KriteriumWert] | None
Hier stehen die Kriterien, die die regionale Gültigkeit festlegen
bo4e.com.regionalepreisgarantie module
Contains RegionalePreisgarantie class
- class bo4e.com.regionalepreisgarantie.RegionalePreisgarantie(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONALEPREISGARANTIE] = ComTyp.REGIONALEPREISGARANTIE, preisgarantietyp: Preisgarantietyp | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, beschreibung: str | None = None, regionaleGueltigkeit: RegionaleGueltigkeit | None = None, **extra_data: Any)[source]
Bases:
Preisgarantie
Abbildung einer Preisgarantie mit regionaler Abgrenzung
- regionale_gueltigkeit: RegionaleGueltigkeit | None
Regionale Eingrenzung der Preisgarantie.
bo4e.com.regionalepreisstaffel module
Contains RegionalePreisstaffel class
- class bo4e.com.regionalepreisstaffel.RegionalePreisstaffel(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONALEPREISSTAFFEL] = ComTyp.REGIONALEPREISSTAFFEL, einheitspreis: Decimal | None = None, staffelgrenzeVon: Decimal | None = None, staffelgrenzeBis: Decimal | None = None, sigmoidparameter: Sigmoidparameter | None = None, artikelId: str | None = None, regionaleGueltigkeit: RegionaleGueltigkeit | None = None, **extra_data: Any)[source]
Bases:
Preisstaffel
Mit dieser Komponente können Staffelpreise abgebildet werden, die sich auf eine Region beziehen.
- regionale_gueltigkeit: RegionaleGueltigkeit | None
Regionale Eingrenzung der Preisstaffel
bo4e.com.regionaleraufabschlag module
Contains RegionalerAufAbschlag class
- class bo4e.com.regionaleraufabschlag.RegionalerAufAbschlag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONALERAUFABSCHLAG] = ComTyp.REGIONALERAUFABSCHLAG, bezeichnung: str | None = None, staffeln: list[RegionalePreisstaffel] | None = None, beschreibung: str | None = None, aufAbschlagstyp: AufAbschlagstyp | None = None, aufAbschlagsziel: AufAbschlagsziel | None = None, einheit: Waehrungseinheit | None = None, website: str | None = None, zusatzprodukte: list[str] | None = None, voraussetzungen: list[str] | None = None, tarifnamensaenderungen: str | None = None, gueltigkeitszeitraum: Zeitraum | None = None, energiemixaenderung: Energiemix | None = None, vertagskonditionsaenderung: Vertragskonditionen | None = None, garantieaenderung: Preisgarantie | None = None, einschraenkungsaenderung: Tarifeinschraenkung | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet werden. Hier sind auch die Auswirkungen auf verschiedene Tarifparameter modelliert, die sich durch die Auswahl eines Auf- oder Abschlags ergeben.
- auf_abschlagstyp: AufAbschlagstyp | None
Typ des Aufabschlages (z.B. absolut oder prozentual)
- auf_abschlagsziel: AufAbschlagsziel | None
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.
- einheit: Waehrungseinheit | None
Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird (nur im Falle absoluter Aufschlagstypen).
- einschraenkungsaenderung: Tarifeinschraenkung | None
Änderungen in den Einschränkungen zum Tarif; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- energiemixaenderung: Energiemix | None
Der Energiemix kann sich durch einen AufAbschlag ändern (z.B. zwei Cent Aufschlag für Ökostrom). Sollte dies der Fall sein, wird hier die neue Zusammensetzung des Energiemix angegeben.
- garantieaenderung: Preisgarantie | None
Änderungen in den Garantievereinbarungen; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- staffeln: list[RegionalePreisstaffel] | None
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung
- tarifnamensaenderungen: str | None
Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten
- typ: Annotated[Literal[ComTyp.REGIONALERAUFABSCHLAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- vertagskonditionsaenderung: Vertragskonditionen | None
Änderungen in den Vertragskonditionen; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
bo4e.com.regionaletarifpreisposition module
Contains RegionaleTarifpreisposition class
- class bo4e.com.regionaletarifpreisposition.RegionaleTarifpreisposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONALETARIFPREISPOSITION] = ComTyp.REGIONALETARIFPREISPOSITION, preistyp: Preistyp | None = None, einheit: Waehrungseinheit | None = None, bezugseinheit: Mengeneinheit | None = None, preisstaffeln: list[RegionalePreisstaffel] | None = None, mengeneinheitstaffel: Mengeneinheit | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Tarifpreise verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet werden.
- bezugseinheit: Mengeneinheit | None
Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr
- einheit: Waehrungseinheit | None
Einheit des Preises (z.B. EURO)
- mengeneinheitstaffel: Mengeneinheit | None
Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)
- preisstaffeln: list[RegionalePreisstaffel] | None
Hier sind die Staffeln mit ihren Preisangaben und regionalen Gültigkeiten definiert
bo4e.com.regionskriterium module
Contains Regionskriterium class
- class bo4e.com.regionskriterium.Regionskriterium(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONSKRITERIUM] = ComTyp.REGIONSKRITERIUM, gueltigkeitstyp: Gueltigkeitstyp | None = None, regionskriteriumtyp: Regionskriteriumtyp | None = None, wert: str | None = None, **extra_data: Any)[source]
Bases:
COM
Komponente zur Abbildung eines Regionskriteriums
- gueltigkeitstyp: Gueltigkeitstyp | None
Hier wird festgelegt, ob es sich um ein einschließendes oder ausschließendes Kriterium handelt.
- regionskriteriumtyp: Regionskriteriumtyp | None
Hier wird das Kriterium selbst angegeben, z.B. Bundesland.
bo4e.com.sigmoidparameter module
Contains Sigmoidparameter class
- class bo4e.com.sigmoidparameter.Sigmoidparameter(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.SIGMOIDPARAMETER] = ComTyp.SIGMOIDPARAMETER, A: Decimal | None = None, B: Decimal | None = None, C: Decimal | None = None, D: Decimal | None = None, **extra_data: Any)[source]
Bases:
COM
Die Sigmoid-Funktion, beispielsweise zur Berechnung eines Leistungspreises hat die Form: LP=A/(1+(P/B)^C)+D
bo4e.com.standorteigenschaftengas module
Contains StandorteigenschaftenGas class
- class bo4e.com.standorteigenschaftengas.StandorteigenschaftenGas(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.STANDORTEIGENSCHAFTENGAS] = ComTyp.STANDORTEIGENSCHAFTENGAS, netzkontonummern: list[str] | None = None, marktgebiete: list[MarktgebietInfo] | None = None, **extra_data: Any)[source]
Bases:
COM
Standorteigenschaften der Sparte Gas
- marktgebiete: list[MarktgebietInfo] | None
Die Informationen zu Marktgebieten in dem Netz.
bo4e.com.standorteigenschaftenstrom module
Contains StandorteigenschaftenStrom class
- class bo4e.com.standorteigenschaftenstrom.StandorteigenschaftenStrom(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.STANDORTEIGENSCHAFTENSTROM] = ComTyp.STANDORTEIGENSCHAFTENSTROM, bilanzierungsgebietEic: str | None = None, regelzone: str | None = None, regelzoneEic: str | None = None, **extra_data: Any)[source]
Bases:
COM
Standorteigenschaften der Sparte Strom
bo4e.com.steuerbetrag module
Contains Steuerbetrag class
- class bo4e.com.steuerbetrag.Steuerbetrag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.STEUERBETRAG] = ComTyp.STEUERBETRAG, steuerkennzeichen: Steuerkennzeichen | None = None, basiswert: Decimal | None = None, steuerwert: Decimal | None = None, waehrung: Waehrungscode | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung eines Steuerbetrages.
- steuerkennzeichen: Steuerkennzeichen | None
Kennzeichnung des Steuersatzes, bzw. Verfahrens.
- typ: Annotated[Literal[ComTyp.STEUERBETRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- waehrung: Waehrungscode | None
Währung. Z.B. Euro.
bo4e.com.tagesparameter module
Contains tagesparameter class
- class bo4e.com.tagesparameter.Tagesparameter(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TAGESPARAMETER] = ComTyp.TAGESPARAMETER, klimazone: str | None = None, temperaturmessstelle: str | None = None, dienstanbieter: str | None = None, herausgeber: str | None = None, **extra_data: Any)[source]
Bases:
COM
Speichert Informationen zu einer tagesparameter abhängigen Messstelle. z.B. den Namen einer Klimazone oder die ID der Wetterstation für die Temperaturmessstelle
bo4e.com.tarifberechnungsparameter module
Contains Tarifberechnungsparameter class
- class bo4e.com.tarifberechnungsparameter.Tarifberechnungsparameter(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFBERECHNUNGSPARAMETER] = ComTyp.TARIFBERECHNUNGSPARAMETER, berechnungsmethode: Tarifkalkulationsmethode | None = None, istMesspreisInGrundpreisEnthalten: bool | None = None, istMesspreisZuBeruecksichtigen: bool | None = None, messpreistyp: Messpreistyp | None = None, kwInklusive: Decimal | None = None, kwWeitereMengen: Decimal | None = None, hoechstpreisNT: Preis | None = None, hoechstpreisHT: Preis | None = None, mindestpreis: Preis | None = None, zusatzpreise: list[Tarifpreis] | None = None, **extra_data: Any)[source]
Bases:
COM
In dieser Komponente sind die Berechnungsparameter für die Ermittlung der Tarifkosten zusammengefasst.
- berechnungsmethode: Tarifkalkulationsmethode | None
Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind
- ist_messpreis_in_grundpreis_enthalten: bool | None
True, falls der Messpreis im Grundpreis (GP) enthalten ist
- ist_messpreis_zu_beruecksichtigen: bool | None
True, falls bei der Bildung des Durchschnittspreises für die Höchst- und Mindestpreisbetrachtung der Messpreis mit berücksichtigt wird
- kw_weitere_mengen: Decimal | None
Intervall, indem die über “kwInklusive” hinaus abgenommene Leistung kostenpflichtig wird (z.B. je 5 kW 20 EURO)
- messpreistyp: Messpreistyp | None
Typ des Messpreises
- typ: Annotated[Literal[ComTyp.TARIFBERECHNUNGSPARAMETER], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zusatzpreise: list[Tarifpreis] | None
Liste mit zusätzlichen Preisen, beispielsweise Messpreise und/oder Leistungspreise
bo4e.com.tarifeinschraenkung module
Contains Tarifeinschraenkung
- class bo4e.com.tarifeinschraenkung.Tarifeinschraenkung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFEINSCHRAENKUNG] = ComTyp.TARIFEINSCHRAENKUNG, zusatzprodukte: list[str] | None = None, voraussetzungen: list[Voraussetzungen] | None = None, einschraenkungzaehler: list[Geraet] | None = None, einschraenkungleistung: list[Menge] | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente werden Einschränkungen für die Anwendung von Tarifen modelliert.
- einschraenkungleistung: list[Menge] | None
Die vereinbarte Leistung, die (näherungsweise) abgenommen wird. Insbesondere Gastarife können daran gebunden sein, dass die Leistung einer vereinbarten Höhe entspricht.
- einschraenkungzaehler: list[Geraet] | None
Liste der Zähler/Geräte, die erforderlich sind, damit dieser Tarif zur Anwendung gelangen kann. (Falls keine Zähler angegeben sind, ist der Tarif nicht an das Vorhandensein bestimmter Zähler gebunden.)
- typ: Annotated[Literal[ComTyp.TARIFEINSCHRAENKUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- voraussetzungen: list[Voraussetzungen] | None
Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann
bo4e.com.tarifpreis module
Contains Tarifpreis class
- class bo4e.com.tarifpreis.Tarifpreis(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFPREIS] = ComTyp.TARIFPREIS, wert: Decimal | None = None, einheit: Waehrungseinheit | None = None, bezugswert: Mengeneinheit | None = None, status: Preisstatus | None = None, preistyp: Preistyp | None = None, beschreibung: str | None = None, **extra_data: Any)[source]
Bases:
Preis
Abbildung eines Tarifpreises mit Preistyp und Beschreibung abgeleitet von COM Preis.
bo4e.com.tarifpreisposition module
Contains Tarifpreisposition class
- class bo4e.com.tarifpreisposition.Tarifpreisposition(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFPREISPOSITION] = ComTyp.TARIFPREISPOSITION, preistyp: Preistyp | None = None, einheit: Waehrungseinheit | None = None, bezugseinheit: Mengeneinheit | None = None, preisstaffeln: list[Preisstaffel] | None = None, mengeneinheitstaffel: Mengeneinheit | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden.
- bezugseinheit: Mengeneinheit | None
Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr
- einheit: Waehrungseinheit | None
Einheit des Preises (z.B. EURO)
- mengeneinheitstaffel: Mengeneinheit | None
Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)
- preisstaffeln: list[Preisstaffel] | None
Hier sind die Staffeln mit ihren Preisenangaben definiert
bo4e.com.tarifpreispositionproort module
Contains TarifpreispositionProOrt class
- class bo4e.com.tarifpreispositionproort.TarifpreispositionProOrt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFPREISPOSITIONPROORT] = ComTyp.TARIFPREISPOSITIONPROORT, postleitzahl: str | None = None, ort: str | None = None, netznr: str | None = None, preisstaffeln: list[TarifpreisstaffelProOrt] | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden
- preisstaffeln: list[TarifpreisstaffelProOrt] | None
bo4e.com.tarifpreisstaffelproort module
Contains TarifpreisstaffelProOrt class
- class bo4e.com.tarifpreisstaffelproort.TarifpreisstaffelProOrt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFPREISSTAFFELPROORT] = ComTyp.TARIFPREISSTAFFELPROORT, arbeitspreis: Decimal | None = None, arbeitspreisNT: Decimal | None = None, grundpreis: Decimal | None = None, staffelgrenzeVon: Decimal | None = None, staffelgrenzeBis: Decimal | None = None, **extra_data: Any)[source]
Bases:
COM
Gibt die Staffelgrenzen der jeweiligen Preise an
bo4e.com.unterschrift module
Contains Unterschrift class
- class bo4e.com.unterschrift.Unterschrift(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.UNTERSCHRIFT] = ComTyp.UNTERSCHRIFT, name: str | None = None, ort: str | None = None, datum: AwareDatetime | None = None, **extra_data: Any)[source]
Bases:
COM
Modellierung einer Unterschrift, z.B. für Verträge, Angebote etc.
bo4e.com.verbrauch module
Contains Verbrauch
- class bo4e.com.verbrauch.Verbrauch(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.VERBRAUCH] = ComTyp.VERBRAUCH, obisKennzahl: str | None = None, wert: Decimal | None = None, einheit: Mengeneinheit | None = None, startdatum: AwareDatetime | None = None, enddatum: AwareDatetime | None = None, messwertstatus: Messwertstatus | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung eines zeitlich abgegrenzten Verbrauchs
- einheit: Mengeneinheit | None
Gibt die Einheit zum jeweiligen Wert an
- enddatum: AwareDatetime | None
Exklusives Ende des Zeitraumes, für den der Verbrauch angegeben wird
- messwertstatus: Messwertstatus | None
Messwertstatus includes the plausibility of the value
- obis_kennzahl: str | None
Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. ‘1-0:
- startdatum: AwareDatetime | None
Inklusiver Beginn des Zeitraumes, für den der Verbrauch angegeben wird
bo4e.com.vertragskonditionen module
Contains Vertragskonditionen class
- class bo4e.com.vertragskonditionen.Vertragskonditionen(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.VERTRAGSKONDITIONEN] = ComTyp.VERTRAGSKONDITIONEN, beschreibung: str | None = None, anzahlAbschlaege: Decimal | None = None, vertragslaufzeit: Zeitraum | None = None, kuendigungsfrist: Zeitraum | None = None, vertragsverlaengerung: Zeitraum | None = None, abschlagszyklus: Zeitraum | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung für Vertragskonditionen. Die Komponente wird sowohl im Vertrag als auch im Tarif verwendet.
- abschlagszyklus: Zeitraum | None
In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden.
bo4e.com.vertragsteil module
Contains Vertragsteil class
- class bo4e.com.vertragsteil.Vertragsteil(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.VERTRAGSTEIL] = ComTyp.VERTRAGSTEIL, vertragsteilbeginn: AwareDatetime | None = None, vertragsteilende: AwareDatetime | None = None, lokation: str | None = None, vertraglichFixierteMenge: Menge | None = None, minimaleAbnahmemenge: Menge | None = None, maximaleAbnahmemenge: Menge | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung für einen Vertragsteil. Der Vertragsteil wird dazu verwendet, eine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen.
- lokation: str | None
Der Identifier für diejenigen Markt- oder Messlokation, die zu diesem Vertragsteil gehören. Verträge für mehrere Lokationen werden mit mehreren Vertragsteilen abgebildet
bo4e.com.verwendungszweckpromarktrolle module
Contains Verwendungszweck class
- class bo4e.com.verwendungszweckpromarktrolle.VerwendungszweckProMarktrolle(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.VERWENDUNGSZWECKPROMARKTROLLE] = ComTyp.VERWENDUNGSZWECKPROMARKTROLLE, marktrolle: Marktrolle | None = None, zwecke: list[Verwendungszweck] | None = None, **extra_data: Any)[source]
Bases:
COM
Dient zur Identifizierung des Verwendungszwecks der Marktrolle an der Marktlokation, der die Werte zu übermitteln sind.
- Zwecke: list[Verwendungszweck] | None
Verwendungszwecke
- marktrolle: Marktrolle | None
Marktrolle, für die die Daten relevant sind
bo4e.com.zaehlwerk module
Contains Zaehlwerk class
- class bo4e.com.zaehlwerk.Zaehlwerk(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZAEHLWERK] = ComTyp.ZAEHLWERK, zaehlwerkId: str | None = None, bezeichnung: str | None = None, richtung: Energierichtung | None = None, obisKennzahl: str | None = None, wandlerfaktor: Decimal | None = None, einheit: Mengeneinheit | None = None, istSchwachlastfaehig: bool | None = None, verwendungszwecke: list[VerwendungszweckProMarktrolle] | None = None, verbrauchsart: Verbrauchsart | None = None, istUnterbrechbar: bool | None = None, waermenutzung: Waermenutzung | None = None, konzessionsabgabe: Konzessionsabgabe | None = None, istSteuerbefreit: bool | None = None, vorkommastelle: int | None = None, nachkommastelle: int | None = None, istAbrechnungsrelevant: bool | None = None, anzahlAblesungen: int | None = None, zaehlzeitregister: Zaehlzeitregister | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente werden Zählwerke modelliert.
- einheit: Mengeneinheit | None
Die Einheit der gemessenen Größe, z.B. kWh
- konzessionsabgabe: Konzessionsabgabe | None
Konzessionsabgabe
- obis_kennzahl: str | None
Die OBIS-Kennzahl für das Zählwerk, die festlegt, welche auf die gemessene Größe mit dem Stand gemeldet wird. Nur Zählwerkstände mit dieser OBIS-Kennzahl werden an diesem Zählwerk registriert.
- richtung: Energierichtung | None
Die Energierichtung, Einspeisung oder Ausspeisung.
- typ: Annotated[Literal[ComTyp.ZAEHLWERK], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- verbrauchsart: Verbrauchsart | None
Stromverbrauchsart/Verbrauchsart Marktlokation
- verwendungszwecke: list[VerwendungszweckProMarktrolle] | None
Verwendungungszweck der Werte Marktlokation
Wärmenutzung Marktlokation
- wandlerfaktor: Decimal | None
Mit diesem Faktor wird eine Zählerstandsdifferenz multipliziert, um zum eigentlichen Verbrauch im Zeitraum zu kommen.
- zaehlwerk_id: str | None
Identifikation des Zählwerks (Registers) innerhalb des Zählers. Oftmals eine laufende Nummer hinter der Zählernummer. Z.B. 47110815_1
- zaehlzeitregister: Zaehlzeitregister | None
Erweiterte Definition der Zählzeit in Bezug auf ein Register
bo4e.com.zaehlzeitregister module
Contains Zaehlzeitregister class
- class bo4e.com.zaehlzeitregister.Zaehlzeitregister(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZAEHLZEITREGISTER] = ComTyp.ZAEHLZEITREGISTER, zaehlzeitDefinition: str | None = None, zaehlzeitRegister: str | None = None, istSchwachlastfaehig: bool | None = None, **extra_data: Any)[source]
Bases:
COM
Mit dieser Komponente werden Zählzeitregister modelliert. Ein Zählzeitregister beschreibt eine erweiterte Definition der Zählzeit in Bezug auf ein Register. Dabei werden alle Codes dazu vom Netzbetreiber vergeben.
bo4e.com.zeitraum module
Contains Zeitraum class
- class bo4e.com.zeitraum.Zeitraum(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZEITRAUM] = ComTyp.ZEITRAUM, startdatum: date | None = None, enddatum: date | None = None, startuhrzeit: time | None = None, enduhrzeit: time | None = None, dauer: str | None = None, **extra_data: Any)[source]
Bases:
COM
Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet. Es muss daher eine der drei Möglichkeiten angegeben sein: - Einheit und Dauer oder - Zeitraum: Startdatum bis Enddatum oder - Zeitraum: Startzeitpunkt (Datum und Uhrzeit) bis Endzeitpunkt (Datum und Uhrzeit)
Hint
- enduhrzeit: time | None
Enduhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum exklusiv.
Example
‘19:00:00+01:00’
bo4e.com.zeitreihenwert module
Contains Zeitreihenwert class
- class bo4e.com.zeitreihenwert.Zeitreihenwert(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZEITREIHENWERT] = ComTyp.ZEITREIHENWERT, zeitraum: Zeitraum | None = None, wert: Decimal | None = None, status: Messwertstatus | None = None, statuszusatz: Messwertstatuszusatz | None = None, **extra_data: Any)[source]
Bases:
COM
Abbildung eines Zeitreihenwertes bestehend aus Zeitraum, Wert und Statusinformationen.
- status: Messwertstatus | None
Der Status gibt an, wie der Wert zu interpretieren ist, z.B. in Berechnungen.
- statuszusatz: Messwertstatuszusatz | None
Eine Zusatzinformation zum Status, beispielsweise ein Grund für einen fehlenden Wert.
bo4e.com.zustaendigkeit module
Contains Zustaendigkeit class
- class bo4e.com.zustaendigkeit.Zustaendigkeit(*, _version: str | None = '202401.7.1.dev1+gcbc02070', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZUSTAENDIGKEIT] = ComTyp.ZUSTAENDIGKEIT, themengebiet: Themengebiet | None = None, position: str | None = None, abteilung: str | None = None, **extra_data: Any)[source]
Bases:
COM
Enthält die zeitliche Zuordnung eines Ansprechpartners zu Abteilungen und Zuständigkeiten.
- themengebiet: Themengebiet | None
Hier kann eine thematische Zuordnung des Ansprechpartners bzw. der Person angegeben werden