bo4e.com package

Submodules

bo4e.com.adresse module

Contains Adresse class

Bases: COM

Contains an address that can be used for most purposes.

Hint

Adresse JSON Schema

adresszusatz: str | None: Zusatzhinweis zum Auffinden der Adresse, z.B. “3. Stock linke Wohnung”

co_ergaenzung: str | None: Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. “c/o Veronica Hauptmieterin”

hausnummer: str | None: Hausnummer inkl. Zusatz; z.B. “3”, “4a”

landescode: Landescode | None: Offizieller ISO-Landescode

ort: str | None: Bezeichnung der Stadt; z.B. “Hückelhoven”

ortsteil: str | None: Bezeichnung des Ortsteils; z.B. “Mitte”

postfach: str | None: Im Falle einer Postfachadresse das Postfach; Damit werden Straße und Hausnummer nicht berücksichtigt

postleitzahl: str | None

“41836”

Type:: Die Postleitzahl; z.B

strasse: str | None: Bezeichnung der Straße; z.B. “Weserstraße”

typ: Annotated[Literal[ComTyp.ADRESSE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.angebotsposition module

Contains Angebotsposition class

class bo4e.com.angebotsposition.Angebotsposition(*, _version: str | None = '202607.1.0', _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

Hint

Angebotsposition JSON Schema

positionsbezeichnung: str | None: Bezeichnung der jeweiligen Position des Angebotsteils

positionskosten: Betrag | None: Kosten (positionspreis * positionsmenge) für diese Angebotsposition

positionsmenge: Menge | None: Menge des angebotenen Artikels (z.B. Wirkarbeit in kWh), in dieser Angebotsposition

positionspreis: Preis | None: Preis pro Einheit/Stückpreis des angebotenen Artikels.

typ: Annotated[Literal[ComTyp.ANGEBOTSPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.angebotsteil module

Contains Angebotsteil class

class bo4e.com.angebotsteil.Angebotsteil(*, _version: str | None = '202607.1.0', _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.

Hint

Angebotsteil JSON Schema

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

typ: Annotated[Literal[ComTyp.ANGEBOTSTEIL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.angebotsvariante module

Contains Angebotsvariante

class bo4e.com.angebotsvariante.Angebotsvariante(*, _version: str | None = '202607.1.0', _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

Hint

Angebotsvariante JSON Schema

angebotsstatus: Angebotsstatus | None: Gibt den Status eines Angebotes an.

bindefrist: AwareDatetime | None: Bis zu diesem Zeitpunkt gilt die Angebotsvariante

erstellungsdatum: AwareDatetime | None: Datum der Erstellung der Angebotsvariante

gesamtkosten: Betrag | None: Aufsummierte Kosten aller Angebotsteile

gesamtmenge: Menge | None: Aufsummierte Wirkarbeitsmenge aller Angebotsteile

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.

typ: Annotated[Literal[ComTyp.ANGEBOTSVARIANTE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.aufabschlag module

Contains AufAbschlag class

class bo4e.com.aufabschlag.AufAbschlag(*, _version: str | None = '202607.1.0', _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.

Hint

AufAbschlag JSON Schema

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

beschreibung: str | None: Beschreibung zum Auf-/Abschlag

bezeichnung: str | None: Bezeichnung des Auf-/Abschlags

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.

typ: Annotated[Literal[ComTyp.AUFABSCHLAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

website: str | None: Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.

bo4e.com.ausschreibungsdetail module

Contains class Ausschreibungsdetail

class bo4e.com.ausschreibungsdetail.Ausschreibungsdetail(*, _version: str | None = '202607.1.0', _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.

Hint

Ausschreibungsdetail JSON Schema

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

kunde: str | None: Bezeichnung des Kunden, der die Marktlokation nutzt

lieferzeitraum: Zeitraum | None: Angefragter Zeitraum für die ausgeschriebene Belieferung

marktlokations_id: str | None: Identifikation einer ausgeschriebenen Marktlokation

marktlokationsadresse: Adresse | None: Die Adresse an der die Marktlokation sich befindet

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

rechnungsadresse: Adresse | None: Die (evtl. abweichende) Rechnungsadresse

typ: Annotated[Literal[ComTyp.AUSSCHREIBUNGSDETAIL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zaehlernummer: str | None: Die Bezeichnung des Zählers an der Marktlokation

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 = '202607.1.0', _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

Hint

Ausschreibungslos JSON Schema

anzahl_lieferstellen: int | None: Anzahl der Lieferstellen in dieser Ausschreibung

bemerkung: str | None: Bemerkung des Kunden zum Los

betreut_durch: str | None: Name des Lizenzpartners

bezeichnung: str | None: Bezeichnung der Ausschreibung

energieart: Sparte | None: Unterscheidungsmöglichkeiten für die Sparte

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

losnummer: str | None: Laufende Nummer des Loses

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_kuendingungsfrist: Zeitraum | None: Kundenwunsch zur Kündigungsfrist in der Ausschreibung

wunsch_maximalmenge: Menge | None: Maximalmenge Toleranzband (kWh, %)

wunsch_mindestmenge: Menge | None: Mindesmenge Toleranzband (kWh, %)

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

wunsch_zahlungsziel: Zeitraum | None: Kundenwunsch zum Zahlungsziel in der Ausschreibung

bo4e.com.betrag module

Contains Betrag class

class bo4e.com.betrag.Betrag(*, _version: str | None = '202607.1.0', _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

Betrag JSON Schema

typ: Annotated[Literal[ComTyp.BETRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

waehrung: Waehrungscode | None: Die entsprechende Waehrung

wert: Decimal | None: Gibt den Betrag des Preises an.

bo4e.com.com module

Contains base class for all components

class bo4e.com.com.COM(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, **extra_data: Any)[source]

Bases: BaseModel

base class for all components

Hint

COM JSON Schema

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 = '202607.1.0', _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.

Hint

Dienstleistung JSON Schema

bezeichnung: str | None: Bezeichnung der Dienstleistung

dienstleistungstyp: Dienstleistungstyp | None: Kennzeichnung der Dienstleistung

typ: Annotated[Literal[ComTyp.DIENSTLEISTUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.einheitspreisposition module

Contains EinheitsPreisposition class

class bo4e.com.einheitspreisposition.EinheitsPreisposition(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.EINHEITSPREISPOSITION] = ComTyp.EINHEITSPREISPOSITION, bezeichnung: str | None = None, preisreferenz: Preisreferenz | None = None, preis: Preis | None = None, **extra_data: Any)[source]

Bases: COM

Die Einheits-Preisposition modelliert Preispositionen ohne Variabilität (bis auf die übergeordnete Variabilität durch eine Zeitscheibe und einer Region).

Dies kann z.B. ein Arbeitspreis sein. Der Bezug wird dabei durch die Preisreferenz angegeben.

Hint

EinheitsPreisposition JSON Schema

bezeichnung: str | None: Eine (beliebige) Bezeichnung für die Preisposition.

preis: Preis | None: Der Preis für diese Position.

preisreferenz: Preisreferenz | None: Die Referenz worauf sich der Preis bezieht. Die explizite Einheit wird durch das Feld bezugswert im COM Preis angegeben.

typ: Annotated[Literal[ComTyp.EINHEITSPREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.energieherkunft module

Contains Energieherkunft class

class bo4e.com.energieherkunft.Energieherkunft(*, _version: str | None = '202607.1.0', _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

Hint

Energieherkunft JSON Schema

anteil_prozent: Decimal | None: Prozentualer Anteil der jeweiligen Erzeugungsart.

erzeugungsart: Erzeugungsart | None: Art der Erzeugung der Energie.

typ: Annotated[Literal[ComTyp.ENERGIEHERKUNFT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.energiemix module

Contains Energiemix class

class bo4e.com.energiemix.Energiemix(*, _version: str | None = '202607.1.0', _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.

Hint

Energiemix JSON Schema

anteil: list[Energieherkunft] | None: Anteile der jeweiligen Erzeugungsart

atommuell: Decimal | None: Höhe des erzeugten Atommülls in g/kWh

bemerkung: str | None: Bemerkung zum Energiemix

bezeichnung: str | None: Bezeichnung des Energiemix

co2_emission: Decimal | None: Höhe des erzeugten CO2-Ausstosses in g/kWh

energieart: Sparte | None: Strom oder Gas etc.

energiemixnummer: int | None: Eindeutige Nummer zur Identifizierung des Energiemixes

gueltigkeitsjahr: int | None: Jahr, für das der Energiemix gilt

ist_in_oeko_top_ten: bool | None: Kennzeichen, ob der Versorger zu den Öko Top Ten gehört

oekolabel: list[Oekolabel] | None: Ökolabel für den Energiemix

oekozertifikate: list[Oekozertifikat] | None: Zertifikate für den Energiemix

typ: Annotated[Literal[ComTyp.ENERGIEMIX], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

website: str | None: Internetseite, auf der die Strommixdaten veröffentlicht sind

bo4e.com.fremdkostenblock module

Contains Fremdkostenblock class

class bo4e.com.fremdkostenblock.Fremdkostenblock(*, _version: str | None = '202607.1.0', _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

Hint

Fremdkostenblock JSON Schema

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 €

summe_kostenblock: Betrag | None: Die Summe aller Kostenpositionen dieses Blocks

typ: Annotated[Literal[ComTyp.FREMDKOSTENBLOCK], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.fremdkostenposition module

Contains Fremdkostenposition

class bo4e.com.fremdkostenposition.Fremdkostenposition(*, _version: str | None = '202607.1.0', _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

Hint

Fremdkostenposition JSON Schema

gebietcode_eic: str | None: EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. ‘10YDE-EON——1’ für die Regelzone TenneT

link_preisblatt: str | None: Link zum veröffentlichten Preisblatt

marktpartnercode: str | None: Die Codenummer (z.B. BDEW-Codenummer) des Marktpartners, der die Preise festlegt / die Kosten in Rechnung stellt

marktpartnername: str | None: Der Name des Marktpartners, der die Preise festlegt, bzw. die Kosten in Rechnung stellt

typ: Annotated[Literal[ComTyp.FREMDKOSTENPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.geokoordinaten module

Contains Geokoordinaten class

class bo4e.com.geokoordinaten.Geokoordinaten(*, _version: str | None = '202607.1.0', _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.

Hint

Geokoordinaten JSON Schema

breitengrad: Decimal | None

laengengrad: Decimal | None

typ: Annotated[Literal[ComTyp.GEOKOORDINATEN], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.katasteradresse module

Contains Katasteradresse class

class bo4e.com.katasteradresse.Katasteradresse(*, _version: str | None = '202607.1.0', _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.

Hint

Katasteradresse JSON Schema

flurstueck: str | None

gemarkung_flur: str | None

typ: Annotated[Literal[ComTyp.KATASTERADRESSE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.konfigurationsprodukt module

Contains Konfigurationsprodukt class

class bo4e.com.konfigurationsprodukt.Konfigurationsprodukt(*, _version: str | None = '202607.1.0', _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

Hint

Konfigurationsprodukt JSON Schema

leistungskurvendefinition: str | None

marktpartner: Marktteilnehmer | None

produktcode: str | None

schaltzeitdefinition: str | None

typ: Annotated[Literal[ComTyp.KONFIGURATIONSPRODUKT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.kontaktweg module

Contains Kontaktweg class

class bo4e.com.kontaktweg.Kontaktweg(*, _version: str | None = '202607.1.0', _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

Kontakt JSON Schema

beschreibung: str | None: Spezifikation, beispielsweise “Durchwahl”, “Sammelnummer” etc.

ist_bevorzugter_kontaktweg: bool | None: Gibt an, ob es sich um den bevorzugten Kontaktweg handelt.

kontaktart: Kontaktart | None: Gibt die Kontaktart des Kontaktes an.

kontaktwert: str | None: Die Nummer oder E-Mail-Adresse.

typ: Annotated[Literal[ComTyp.KONTAKTWEG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.konzessionsabgabe module

Contains Konzessionsabgabe

class bo4e.com.konzessionsabgabe.Konzessionsabgabe(*, _version: str | None = '202607.1.0', _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.

Hint

Konzessionsabgabe JSON Schema

kategorie: str | None: Gebührenkategorie der Konzessionsabgabe

kosten: Decimal | None: Konzessionsabgabe in E/kWh

satz: AbgabeArt | None: Art der Abgabe

typ: Annotated[Literal[ComTyp.KONZESSIONSABGABE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.kostenblock module

Contains Kostenblock

class bo4e.com.kostenblock.Kostenblock(*, _version: str | None = '202607.1.0', _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.

Hint

Kostenblock JSON Schema

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 €

summe_kostenblock: Betrag | None: Die Summe aller Kostenpositionen dieses Blocks

typ: Annotated[Literal[ComTyp.KOSTENBLOCK], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.kostenposition module

Contains Kostenposition

class bo4e.com.kostenposition.Kostenposition(*, _version: str | None = '202607.1.0', _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.

Hint

Kostenposition JSON Schema

artikelbezeichnung: str | None

Arbeitspreis HT

Type:: Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel

artikeldetail: str | None

‘Drehstromzähler’

Type:: Detaillierung des Artikels (optional). Beispiel

betrag_kostenposition: Betrag | None: Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung <Menge * Einzelpreis> oder <Einzelpreis / (Anzahl Tage Jahr) * zeitmenge>

bis: AwareDatetime | None: exklusiver bis-Zeitpunkt der Kostenzeitscheibe

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.

typ: Annotated[Literal[ComTyp.KOSTENPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

von: AwareDatetime | None: inklusiver von-Zeitpunkt der Kostenzeitscheibe

zeitmenge: Menge | None: Wenn es einen zeitbasierten Preis gibt (z.B. €/Jahr), dann ist hier die Menge angegeben mit der die Kosten berechnet wurden. Z.B. 138 Tage.

bo4e.com.lastprofil module

Contains class Lastprofil

class bo4e.com.lastprofil.Lastprofil(*, _version: str | None = '202607.1.0', _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.

Hint

Lastprofil JSON Schema

bezeichnung: str | None: Bezeichnung des Profils, durch DVGW bzw. den Netzbetreiber vergeben (z.B. H0)

herausgeber: str | None: Herausgeber des Lastprofil-Codes, e.g. BDEW

ist_einspeisung: bool | None

True/False

Type:: Einspeiseprofil

profilart: Profilart | None: Profilart des Lastprofils, e.g. ART_STANDARDLASTPROFIL

profilschar: str | None

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.lastvariablepreisposition module

Contains LastvariablePreisposition class

class bo4e.com.lastvariablepreisposition.LastvariablePreisposition(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.LASTVARIABLEPREISPOSITION] = ComTyp.LASTVARIABLEPREISPOSITION, bezeichnung: str | None = None, preisreferenz: Preisreferenz | None = None, preisWaehrungseinheit: Waehrungseinheit | None = None, preisBezugseinheit: Mengeneinheit | None = None, staffelgrenzeneinheit: Mengeneinheit | None = None, tarifkalkulationsmethode: Tarifkalkulationsmethode | None = None, preisstaffeln: list[Preisstaffel] | None = None, **extra_data: Any)[source]

Bases: COM

Modelliert eine lastvariable Preisposition.

Hint

LastvariablePreisposition JSON Schema

bezeichnung: str | None: Eine (beliebige) Bezeichnung für die Preisposition.

preis_bezugseinheit: Mengeneinheit | None: Angabe, für welche Bezugsgröße die Preise in den Preisstaffeln gelten. Z.B. kWh.

preis_waehrungseinheit: Waehrungseinheit | None: Währungseinheit für die Preise in allen Preisstaffeln, z.B. Euro oder Ct.

preisreferenz: Preisreferenz | None: Die Referenz worauf sich der Preis bezieht. Die explizite Einheit wird durch das Feld preis_bezugseinheit angegeben.

preisstaffeln: list[Preisstaffel] | None: Preisstaffeln, die zu dieser Preisposition gehören

staffelgrenzeneinheit: Mengeneinheit | None: Die Einheit, in denen die Staffelgrenzen in den Preisstaffeln angegeben sind.

tarifkalkulationsmethode: Tarifkalkulationsmethode | None: Das Modell, das der Preisbildung zugrunde liegt

typ: Annotated[Literal[ComTyp.LASTVARIABLEPREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.marktgebietinfo module

Contains Marktgebietinfo class

class bo4e.com.marktgebietinfo.MarktgebietInfo(*, _version: str | None = '202607.1.0', _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.

Hint

MarktgebietInfo JSON Schema

marktgebiet: str | None: Der Name des Marktgebietes

marktgebietcode: str | None: Die standardisierte Codenummer des Marktgebietes

typ: Annotated[Literal[ComTyp.MARKTGEBIETINFO], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.menge module

Contains Menge class

class bo4e.com.menge.Menge(*, _version: str | None = '202607.1.0', _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

Menge JSON Schema

einheit: Mengeneinheit | None: Gibt die Einheit zum jeweiligen Wert an

typ: Annotated[Literal[ComTyp.MENGE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert: Decimal | None: Gibt den absoluten Wert der Menge an

bo4e.com.messwert module

Contains Messwert class

class bo4e.com.messwert.Messwert(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.MESSWERT] = ComTyp.MESSWERT, messwertstatus: Messwertstatus | None = None, messwertstatuszusatz: Messwertstatuszusatz | None = None, zeitpunkt: AwareDatetime | None = None, wert: Menge | None = None, **extra_data: Any)[source]

Bases: COM

Abbildung eines Messwertes mit Stati, Zeitpunkt und Wert.

Hint

Messwert JSON Schema

messwertstatus: Messwertstatus | None: Gibt den Status des Messwerts an.

messwertstatuszusatz: Messwertstatuszusatz | None: Gibt den Status Zusatz des Messwerts an.

typ: Annotated[Literal[ComTyp.MESSWERT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert: Menge | None: Gibt die gemessene Menge an.

zeitpunkt: AwareDatetime | None: Gibt den Zeitpunkt des Messwerts an.

bo4e.com.preis module

Contains Preis class

class bo4e.com.preis.Preis(*, _version: str | None = '202607.1.0', _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

Preis JSON Schema

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

typ: Annotated[Literal[ComTyp.PREIS], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert: Decimal | None: Gibt die nominale Höhe des Preises an.

bo4e.com.preisgarantie module

Contains Preisgarantie class

class bo4e.com.preisgarantie.Preisgarantie(*, _version: str | None = '202607.1.0', _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.

Hint

Preisgarantie JSON Schema

beschreibung: str | None: Freitext zur Beschreibung der Preisgarantie.

preisgarantietyp: Preisgarantietyp | None: Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.

typ: Annotated[Literal[ComTyp.PREISGARANTIE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zeitliche_gueltigkeit: Zeitraum | None: Zeitraum, bis zu dem die Preisgarantie gilt, z.B. bis zu einem absolutem / fixem Datum oder als Laufzeit in Monaten.

bo4e.com.preisposition module

Contains Preisposition class

class bo4e.com.preisposition.Preisposition(*, _version: str | None = '202607.1.0', _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

Hint

Preisposition JSON Schema

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

tarifzeit: Tarifzeit | None: Festlegung, für welche Tarifzeit der Preis hier festgelegt ist

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 = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.PREISSTAFFEL] = ComTyp.PREISSTAFFEL, bezeichnung: str | None = None, preis: 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

Hint

Preisstaffel JSON Schema

artikel_id: str | None: Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst.

bezeichnung: str | None: Eine (beliebige) Bezeichnung für die Preisstaffel.

preis: Decimal | None: Preis pro abgerechneter Mengeneinheit. Die Mengeneinheit wird durch das übergeordnete Objekt angegeben.

sigmoidparameter: Sigmoidparameter | None: Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter

staffelgrenze_bis: Decimal | None: Exklusiver oberer Wert, bis zu dem die Staffel gilt (inklusiv). Grenzen werden bspw. wie folgt angegeben: 0 - 1000, 1001 - 2000, etc. Werte zwischen den Grenzen (z.B. 1000,6) rutschen in die obere Zone / Staffel.

staffelgrenze_von: Decimal | None: Inklusiver unterer Wert, ab dem die Staffel gilt (inklusiv). Grenzen werden bspw. wie folgt angegeben: 0 - 1000, 1001 - 2000, etc. Werte zwischen den Grenzen (z.B. 1000,6) rutschen in die obere Zone / Staffel.

typ: Annotated[Literal[ComTyp.PREISSTAFFEL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.rechnungsposition module

Contains Rechnungsposition class

class bo4e.com.rechnungsposition.Rechnungsposition(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.RECHNUNGSPOSITION] = ComTyp.RECHNUNGSPOSITION, positionsnummer: int | None = None, lieferungszeitraum: Zeitraum | None = None, positionstext: str | None = None, positionsMenge: Menge | None = None, einzelpreis: Preis | None = None, gesamtpreis: Betrag | None = None, artikelnummer: BDEWArtikelnummer | None = None, artikelId: str | None = None, steuerbetrag: Steuerbetrag | None = None, zeiteinheit: Mengeneinheit | None = None, zeitbezogeneMenge: Menge | None = None, **extra_data: Any)[source]

Bases: COM

Über Rechnungspositionen werden Rechnungen strukturiert. In einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet.

Hint

Rechnungsposition JSON Schema

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

einzelpreis: Preis | None: Der Preis für eine Einheit der energetischen Menge

gesamtpreis: Betrag | None: Das Ergebnis der Multiplikation aus einzelpreis * positionsMenge * (Faktor aus zeitbezogeneMenge). Z.B. 12,60€ * 120 kW * 3/12 (für 3 Monate).

lieferungszeitraum: Zeitraum | None: Zeitraum der Lieferung für die abgerechnete Leistung

positions_menge: Menge | None: Die abgerechnete Menge mit Einheit

positionsnummer: int | None: Fortlaufende Nummer für die Rechnungsposition

positionstext: str | None: Bezeichung für die abgerechnete Position

steuerbetrag: 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.regionsoperation module

Contains Regionskriterium class

class bo4e.com.regionsoperation.Regionsoperation(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONSOPERATION] = ComTyp.REGIONSOPERATION, regionsoperator: Operator | None = None, prioritaet: int | None = None, bezeichnung: str | None = None, bezeichnung2: str | None = None, wertVon: str | None = None, wertBis: str | None = None, radiusInKm: Decimal | None = None, regionskriterium: Regionskriterium | None = None, **extra_data: Any)[source]

Bases: COM

Komponente zur Abbildung einer Regionsoperation.

In Kombination mit anderen Regionsoperationen kann eine Region definiert werden. Eine Regionsoperation ermöglicht die Definition einer Region in eingeschränkter Form. Durch den Operator können mehrere “einfache” Regionsoperationen miteinander kombiniert werden, um eine komplexere Region zu definieren.

Hint

Regionsoperation JSON Schema

bezeichnung: str | None: (auch IDs und PLZ möglich)

bezeichnung2: str | None

PLZ & Ort als Schnittmenge)

Type:: (TODO
Type:: bessere Benamung! geht vor allem um Postort

prioritaet: int | None: Priorität dieser Regionsoperation. Theoretisch sind Listen in JSON sortiert, jedoch ist eine solche Sortierung eventuell implementierungsbedingt fehleranfällig. Daher nutzen wir dieses Feld. angefangen bei 1 (höchste Priorität) und aufsteigend

radius_in_km: Decimal | None: (inklusiv)

regionskriterium: Regionskriterium | None: (ehemals Regionskriteriumtyp)]

regionsoperator: Operator | None

typ: Annotated[Literal[ComTyp.REGIONSOPERATION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert_bis: str | None: (inklusiv)

wert_von: str | None: (inklusiv)

bo4e.com.regionspreis module

Contains Regionspreis class

class bo4e.com.regionspreis.Regionspreis(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONSPREIS] = ComTyp.REGIONSPREIS, regionszeitscheiben: list[Regionszeitscheibe] | None = None, tarifpreiszeitscheiben: list[Tarifpreiszeitscheibe] | None = None, **extra_data: Any)[source]

Bases: COM

Mit dieser Komponente wird ein aus mehreren Positionen zusammengesetzter Preis regionsaufgelöst dargestellt. Zu jedem Zeitpunkt darf es nur eine gültige Region und einen gültigen Preis geben.

Hint

Regionspreis JSON Schema

regionszeitscheiben: list[Regionszeitscheibe] | None: Eine Liste von mit Zeitscheiben versehenen Regionen. Die Zeitscheiben sollten sich nicht überschneiden.

tarifpreiszeitscheiben: list[Tarifpreiszeitscheibe] | None: Eine Liste von mit Zeitscheiben versehenen Tarifpreisen. Die Zeitscheiben sollten sich nicht überschneiden. Die Tarifpreise sind aus mehreren Tarifpreispositionen zusammengesetzt.

typ: Annotated[Literal[ComTyp.REGIONSPREIS], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.regionszeitscheibe module

Contains Regionszeitscheibe class

class bo4e.com.regionszeitscheibe.Regionszeitscheibe(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.REGIONSZEITSCHEIBE] = ComTyp.REGIONSZEITSCHEIBE, region: Region | None = None, zeitscheibengueltigkeit: Zeitraum | None = None, **extra_data: Any)[source]

Bases: COM

Komponente zur Abbildung einer Region mit einer Zeitscheibe.

Hint

Regionszeitscheibe JSON Schema

region: Region | None: Die Region wird durch das Feld zeitscheibengueltigkeit mit einer Zeitscheibe versehen.

typ: Annotated[Literal[ComTyp.REGIONSZEITSCHEIBE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zeitscheibengueltigkeit: Zeitraum | None: Versieht die Region mit einer Zeitscheibe. Der Start- und Endzeitpunkt sollte durch das Objekt ermittelbar sein.

bo4e.com.relativepreisposition module

Contains RelativePreisposition class

class bo4e.com.relativepreisposition.RelativePreisposition(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.RELATIVEPREISPOSITION] = ComTyp.RELATIVEPREISPOSITION, bezeichnung: str | None = None, idReferenz: str | None = None, wert: Decimal | None = None, **extra_data: Any)[source]

Bases: COM

Modelliert eine relative Preisposition.

Hint

RelativePreisposition JSON Schema

bezeichnung: str | None: Eine (beliebige) Bezeichnung für die Preisposition.

id_referenz: str | None: Referenziert auf eine andere Preisposition. Die Referenz bezieht sich auf das technische Feld _id, da es sich hier um eine technische Lösung handelt und der Wert selbst keine fachliche Bedeutung hat. Das _id Feld der unterschiedlichen Preispositionen muss innerhalb einer Tarifpreiszeitscheibe entsprechend unique sein.

typ: Annotated[Literal[ComTyp.RELATIVEPREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert: Decimal | None: Der Modifikator in Prozent, der auf den Preis der referenzierten Preisposition angewendet wird. Der Wert wird multiplikativ angewendet. D.h. wenn bspw. ein Rabatt von 20% angewendet werden soll, muss der Wert 0,8 betragen.

bo4e.com.sigmoidparameter module

Contains Sigmoidparameter class

class bo4e.com.sigmoidparameter.Sigmoidparameter(*, _version: str | None = '202607.1.0', _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

Hint

Sigmoidparameter JSON Schema

A: Decimal | None: Briefmarke Ortsverteilnetz (EUR/kWh)

B: Decimal | None: Wendepunkt für die bepreiste Menge (kW)

C: Decimal | None: Exponent (einheitenlos)

D: Decimal | None: Briefmarke Transportnetz (EUR/kWh)

typ: Annotated[Literal[ComTyp.SIGMOIDPARAMETER], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.standorteigenschaftengas module

Contains StandorteigenschaftenGas class

class bo4e.com.standorteigenschaftengas.StandorteigenschaftenGas(*, _version: str | None = '202607.1.0', _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

Hint

StandorteigenschaftenGas JSON Schema

marktgebiete: list[MarktgebietInfo] | None: Die Informationen zu Marktgebieten in dem Netz.

netzkontonummern: list[str] | None: Netzkontonummern der Gasnetze

typ: Annotated[Literal[ComTyp.STANDORTEIGENSCHAFTENGAS], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.standorteigenschaftenstrom module

Contains StandorteigenschaftenStrom class

class bo4e.com.standorteigenschaftenstrom.StandorteigenschaftenStrom(*, _version: str | None = '202607.1.0', _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

Hint

StandorteigenschaftenStrom JSON Schema

bilanzierungsgebiet_eic: str | None: Die EIC-Nummer des Bilanzierungsgebietes

regelzone: str | None: Der Name der Regelzone

regelzone_eic: str | None: De EIC-Nummer der Regelzone

typ: Annotated[Literal[ComTyp.STANDORTEIGENSCHAFTENSTROM], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.steuerbetrag module

Contains Steuerbetrag class

class bo4e.com.steuerbetrag.Steuerbetrag(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.STEUERBETRAG] = ComTyp.STEUERBETRAG, steuerart: Steuerart | None = None, steuersatz: Decimal | None = None, basiswert: Decimal | None = None, steuerwert: Decimal | None = None, waehrungscode: Waehrungscode | None = None, **extra_data: Any)[source]

Bases: COM

Abbildung eines Steuerbetrages.

Hint

Steuerbetrag JSON Schema

basiswert: Decimal | None: Nettobetrag für den die Steuer berechnet wurde. Z.B. 100

steuerart: Steuerart | None: Kennzeichnung der Steuerart, bzw. Verfahrens.

steuersatz: Decimal | None: Angabe des Steuersatzes in %

steuerwert: Decimal | None: Aus dem Basiswert berechnete Steuer. Z.B. 19 (bei UST_19)

typ: Annotated[Literal[ComTyp.STEUERBETRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

waehrungscode: Waehrungscode | None: Währung. Z.B. Euro.

bo4e.com.tagesparameter module

Contains tagesparameter class

class bo4e.com.tagesparameter.Tagesparameter(*, _version: str | None = '202607.1.0', _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

dienstanbieter: str | None: Dienstanbieter (bei Temperaturmessstellen), e.g. ZT1

herausgeber: str | None: Herausgeber des Lastprofil-Codes, e.g. BDEW

klimazone: str | None: Qualifier der Klimazone, e.g. 7624q

temperaturmessstelle: str | None: Qualifier der Temperaturmessstelle, e.g. 1234x

typ: Annotated[Literal[ComTyp.TAGESPARAMETER], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.tarifberechnungsparameter module

Contains Tarifberechnungsparameter class

class bo4e.com.tarifberechnungsparameter.Tarifberechnungsparameter(*, _version: str | None = '202607.1.0', _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.

Hint

Tarifberechnungsparameter JSON Schema

berechnungsmethode: Tarifkalkulationsmethode | None: Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind

hoechstpreis_h_t: Preis | None: Höchstpreis für den Durchschnitts-Arbeitspreis HT

hoechstpreis_n_t: Preis | None: Höchstpreis für den Durchschnitts-Arbeitspreis NT

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_inklusive: Decimal | None: Im Preis bereits eingeschlossene Leistung (für Gas)

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

mindestpreis: Preis | None: Mindestpreis für den Durchschnitts-Arbeitspreis

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 = '202607.1.0', _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.

Hint

Tarifeinschraenkung JSON Schema

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

zusatzprodukte: list[str] | None: Weitere Produkte, die gemeinsam mit diesem Tarif bestellt werden können

bo4e.com.tarifpreis module

Contains Tarifpreis class

class bo4e.com.tarifpreis.Tarifpreis(*, _version: str | None = '202607.1.0', _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.

Hint

Tarifpreis JSON Schema

beschreibung: str | None: Beschreibung des Preises. Hier können z.B. Preisdetails angegeben sein, beispielsweise “Drehstromzähler”.

preistyp: Preistyp | None: Angabe des Preistypes (z.B. Grundpreis)

typ: Annotated[Literal[ComTyp.TARIFPREIS], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.tarifpreisposition module

Contains Tarifpreisposition class

class bo4e.com.tarifpreisposition.Tarifpreisposition(*, _version: str | None = '202607.1.0', _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.

Hint

Tarifpreisposition JSON Schema

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

preistyp: Preistyp | None: Angabe des Preistypes (z.B. Grundpreis)

typ: Annotated[Literal[ComTyp.TARIFPREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.tarifpreiszeitscheibe module

Contains Tarifpreiszeitscheibe class

class bo4e.com.tarifpreiszeitscheibe.Tarifpreiszeitscheibe(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.TARIFPREISZEITSCHEIBE] = ComTyp.TARIFPREISZEITSCHEIBE, zeitscheibengueltigkeit: Zeitraum | None = None, einheitsPreispositionen: list[EinheitsPreisposition] | None = None, zeitvariablePreispositionen: list[ZeitvariablePreisposition] | None = None, lastvariablePreispositionen: list[LastvariablePreisposition] | None = None, relativePreispositionen: list[RelativePreisposition] | None = None, **extra_data: Any)[source]

Bases: COM

Mit dieser Komponente kann ein aus verschiedenen Preispositionen zusammengesetzter Tarifpreis zeitaufgelöst dargestellt werden.

Hint

Tarifpreiszeitscheibe JSON Schema

einheits_preispositionen: list[EinheitsPreisposition] | None: Eine Liste von Einheits-Preispositionen.

lastvariable_preispositionen: list[LastvariablePreisposition] | None: Eine Liste von lastvariablen Preispositionen. Diese Preispositionen sind vorgesehen, um bspw. ein Staffel- oder Zonenmodell abzubilden.

relative_preispositionen: list[RelativePreisposition] | None

Eine Liste von relativen Preispositionen. Diese Preispositionen modellieren prozentuale Modifikationen auf bestehende Preispositionen.

Dazu wird über ein Feld in RelativePreisposition auf die _id einer anderen Preispositionen verwiesen. Die ID hat hierbei kein vorgegebenes Format und hat auch keine fachliche Bedeutung. Es handelt sich hierbei um eine rein technische Lösung, um einen Querverweis zu modellieren.

typ: Annotated[Literal[ComTyp.TARIFPREISZEITSCHEIBE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zeitscheibengueltigkeit: Zeitraum | None: Gibt an für welchen Zeitraum dieser zusammengesetzte Tarifpreis gültig ist.

zeitvariable_preispositionen: list[ZeitvariablePreisposition] | None: Eine Liste von zeitvariablen Preispositionen. Dies können z.B. Preispositionen mit Zählzeitdefinitionen sein, um ein klassisches HT/NT Modell abzubilden.

bo4e.com.umschaltzeit module

Contains Umschaltzeit class

class bo4e.com.umschaltzeit.Umschaltzeit(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.UMSCHALTZEIT] = ComTyp.UMSCHALTZEIT, umschaltzeit: time | None = None, registercode: str | None = None, **extra_data: Any)[source]

Bases: COM

Modelliert eine Umschaltzeit, wann auf ein bestimmtes Register geschaltet werden soll.

Hint

Umschaltzeit JSON Schema

registercode: str | None: Ein Code, der ein Register spezifiziert. Typischerweise eine 3-stellige Zeichenkette.

typ: Annotated[Literal[ComTyp.UMSCHALTZEIT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

umschaltzeit: time | None: Definiert den Zeitpunkt ab dem auf das Register geschaltet wird, das im Feld registercode spezifiziert ist.

bo4e.com.unterschrift module

Contains Unterschrift class

class bo4e.com.unterschrift.Unterschrift(*, _version: str | None = '202607.1.0', _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.

Hint

Unterschrift JSON Schema

datum: AwareDatetime | None: Datum der Unterschrift

name: str | None: Name des Unterschreibers

ort: str | None: Ort, an dem die Unterschrift geleistet wird

typ: Annotated[Literal[ComTyp.UNTERSCHRIFT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.vertragskonditionen module

Contains Vertragskonditionen class

class bo4e.com.vertragskonditionen.Vertragskonditionen(*, _version: str | None = '202607.1.0', _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.

Hint

Vertragskonditionen JSON Schema

abschlagszyklus: Zeitraum | None: In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden.

anzahl_abschlaege: Decimal | None: Anzahl der vereinbarten Abschläge pro Jahr, z.B. 12

beschreibung: str | None: Freitext zur Beschreibung der Konditionen, z.B. “Standardkonditionen Gas”

kuendigungsfrist: Zeitraum | None: Innerhalb dieser Frist kann der Vertrag gekündigt werden

typ: Annotated[Literal[ComTyp.VERTRAGSKONDITIONEN], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

vertragslaufzeit: Zeitraum | None: Über diesen Zeitraum läuft der Vertrag

vertragsverlaengerung: Zeitraum | None: Falls der Vertrag nicht gekündigt wird, verlängert er sich automatisch um die hier angegebene Zeit

bo4e.com.vertragsteil module

Contains Vertragsteil class

class bo4e.com.vertragsteil.Vertragsteil(*, _version: str | None = '202607.1.0', _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.

Hint

Vertragsteil JSON Schema

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

maximale_abnahmemenge: Menge | None: Für die Lokation festgelegte maximale Abnahmemenge (exklusiv)

minimale_abnahmemenge: Menge | None: Für die Lokation festgelegte Mindestabnahmemenge (inklusiv)

typ: Annotated[Literal[ComTyp.VERTRAGSTEIL], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

vertraglich_fixierte_menge: Menge | None: Für die Lokation festgeschriebene Abnahmemenge

vertragsteilbeginn: AwareDatetime | None: Start der Gültigkeit des Vertragsteils (inklusiv)

vertragsteilende: AwareDatetime | None: Ende der Gültigkeit des Vertragsteils (exklusiv)

bo4e.com.verwendungszweckpromarktrolle module

Contains VerwendungszweckProMarktrolle class

class bo4e.com.verwendungszweckpromarktrolle.VerwendungszweckProMarktrolle(*, _version: str | None = '202607.1.0', _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.

Hint

VerwendungszweckProMarktrolle JSON Schema

Zwecke: list[Verwendungszweck] | None: Verwendungszwecke

marktrolle: Marktrolle | None: Marktrolle, für die die Daten relevant sind

typ: Annotated[Literal[ComTyp.VERWENDUNGSZWECKPROMARKTROLLE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.vorauszahlung module

Contains Vorauszahlung class

class bo4e.com.vorauszahlung.Vorauszahlung(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.VORAUSZAHLUNG] = ComTyp.VORAUSZAHLUNG, betrag: Betrag | None = None, datum: AwareDatetime | None = None, referenz: str | None = None, **extra_data: Any)[source]

Bases: COM

Dient zur Identifizierung eines vorausgezahlten Betrags.

Hint

Vorauszahlung JSON Schema

betrag: Betrag | None

datum: AwareDatetime | None

referenz: str | None

typ: Annotated[Literal[ComTyp.VORAUSZAHLUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.zaehlwerk module

Contains Zaehlwerk class

class bo4e.com.zaehlwerk.Zaehlwerk(*, _version: str | None = '202607.1.0', _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, 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, messwerte: list[Messwert] | None = None, **extra_data: Any)[source]

Bases: COM

Mit dieser Komponente werden Zählwerke modelliert.

Hint

Zaehlwerk JSON Schema

anzahlAblesungen: int | None: Anzahl Ablesungen pro Jahr

bezeichnung: str | None: Zusätzliche Bezeichnung, z.B. Zählwerk_Wirkarbeit.

einheit: Mengeneinheit | None: Die Einheit der gemessenen Größe, z.B. kWh

ist_abrechnungsrelevant: bool | None: Abrechnungsrelevant

ist_schwachlastfaehig: bool | None: Schwachlastfaehigkeit

ist_steuerbefreit: bool | None: Steuerbefreiung

konzessionsabgabe: Konzessionsabgabe | None: Konzessionsabgabe

messwerte: list[Messwert] | None: Gemessene Werte des Zählwerks

nachkommastelle: int | None: Anzahl der Nachkommastellen

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

vorkommastelle: int | None: Anzahl der Vorkommastellen

waermenutzung: Waermenutzung | None: 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 = '202607.1.0', _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.

Hint

Zaehlzeitregister JSON Schema

ist_schwachlastfaehig: bool | None: Schwachlastfaehigkeit

typ: Annotated[Literal[ComTyp.ZAEHLZEITREGISTER], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zaehlzeit_definition: str | None: Zählzeitdefinition

zaehlzeit_register: str | None: Zählzeitregister

bo4e.com.zaehlzeitsaison module

Contains Zaehlzeitsaison class

class bo4e.com.zaehlzeitsaison.Zaehlzeitsaison(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZAEHLZEITSAISON] = ComTyp.ZAEHLZEITSAISON, bezeichnung: str | None = None, tagtypen: list[Zaehlzeittagtyp] | None = None, **extra_data: Any)[source]

Bases: COM

Bündelt alle Schaltschemata, die innerhalb einer Saison einer Zaehlzeitdefinition gelten.

Eine Saison ist ein Teil des Jahres, in dem dieselben Schaltschemata gelten – typischerweise Sommer und Winter. Welche Tage zu welcher Saison gehören, wird nicht in diesem COM, sondern über das saisonprofil der übergeordneten Zaehlzeitdefinition festgelegt; bezeichnung bildet hier die textuelle Verknüpfung zwischen Profil und Saisonabschnitt.

Hint

Zaehlzeitsaison JSON Schema

bezeichnung: str | None: Bezeichnung der Saison (z.B. “Sommer”, “Winter”). Muss zu einem Saisonabschnitt des in der übergeordneten Zaehlzeitdefinition referenzierten saisonprofil passen. Leer, wenn keine Saisonunterscheidung getroffen wird.

tagtypen: list[Zaehlzeittagtyp] | None: Die Schaltschemata für die unterschiedlichen Tagtypen (z.B. Werktag, Wochenende, Feiertag) innerhalb dieser Saison.

typ: Annotated[Literal[ComTyp.ZAEHLZEITSAISON], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.zaehlzeittagtyp module

Contains Zaehlzeittagtyp class

class bo4e.com.zaehlzeittagtyp.Zaehlzeittagtyp(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZAEHLZEITTAGTYP] = ComTyp.ZAEHLZEITTAGTYP, tagtyp: Wiederholungstyp | None = None, umschaltzeiten: list[Umschaltzeit] | None = None, **extra_data: Any)[source]

Bases: COM

Beschreibt das Schaltschema eines Tagtyps innerhalb einer Zaehlzeitsaison: welcher Tagtyp gemeint ist und zu welchen Uhrzeiten welches Register an diesem Tagtyp aktiv ist.

Der Tagtyp wird über einen Wiederholungstyp ausgedrückt (z.B. WERKTAGS, MONTAGS, FEIERTAGS).

Die umschaltzeiten füllen einen ganzen Tag vollständig und überlappungsfrei aus. Die jeweilige Umschaltzeit definiert (wenn der Größe nach sortiert) die untere Grenze (inklusiv); der Beginn des Tages (00:00 Uhr) und das Ende des Tages (24:00 Uhr) bilden die äußeren Grenzen.

Hint

Zaehlzeittagtyp JSON Schema

tagtyp: Wiederholungstyp | None: An welchen Tagen das Schaltschema dieses Tagtyps gilt (z.B. WERKTAGS, MONTAGS, FEIERTAGS).

typ: Annotated[Literal[ComTyp.ZAEHLZEITTAGTYP], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

umschaltzeiten: list[Umschaltzeit] | None: Die Umschaltzeiten dieses Tagtyps. Sortiert ergibt sich daraus das Schaltschema für einen Tag.

bo4e.com.zahlungsinformation module

Contains Zahlungsinformation class

class bo4e.com.zahlungsinformation.Zahlungsinformation(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZAHLUNGSINFORMATION] = ComTyp.ZAHLUNGSINFORMATION, zahlungsart: Zahlungsart | None = None, iban: str | None = None, bic: str | None = None, kontoinhaber: str | None = None, betreff: str | None = None, sepaReferenz: str | None = None, **extra_data: Any)[source]

Bases: COM

Mit dieser Komponente kann eine einzelne Zahlungsinformation dargestellt werden.

Hint

Zahlungsinformation JSON Schema

betreff: str | None: Eine konstante Betreffzeile für Überweisungen

bic: str | None: Eine BIC-Nummer

iban: str | None: Eine IBAN-Nummer

kontoinhaber: str | None: Der Name des Kontoinhabers

sepa_referenz: str | None: Eine SEPA-Referenz

typ: Annotated[Literal[ComTyp.ZAHLUNGSINFORMATION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zahlungsart: Zahlungsart | None: Die Zahlungsart dieser Zahlungsinformation

bo4e.com.zeitraum module

Contains Zeitraum class

class bo4e.com.zeitraum.Zeitraum(*, _version: str | None = '202607.1.0', _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

Zeitraum JSON Schema

dauer: str | None

Dauer in ISO 8601 Format.

Example

‘P1DT30H4S’

See RFC 3339

enddatum: date | None

Enddatum des betrachteten Zeitraums ist inklusiv.

Example

‘2025-01-01’

enduhrzeit: time | None

Enduhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum exklusiv.

Example

‘19:00:00+01:00’

startdatum: date | None

Startdatum des betrachteten Zeitraums ist inklusiv.

Example

‘2025-01-01’

startuhrzeit: time | None

Startuhrzeit mit Zeitzone. Die angegebene Uhrzeit ist im betrachteten Zeitraum inklusiv.

Example

‘18:00:00+01:00’

typ: Annotated[Literal[ComTyp.ZEITRAUM], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com.zeitreihenwert module

Contains Zeitreihenwert class

class bo4e.com.zeitreihenwert.Zeitreihenwert(*, _version: str | None = '202607.1.0', _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.

Hint

Zeitreihenwert JSON Schema

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.

typ: Annotated[Literal[ComTyp.ZEITREIHENWERT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

wert: Decimal | None: Der in dem Zeitraum gültige Wert.

zeitraum: Zeitraum | None: Zeitraum für das Messintervall

bo4e.com.zeitvariablepreisposition module

Contains ZeitvariablePreisposition class

class bo4e.com.zeitvariablepreisposition.ZeitvariablePreisposition(*, _version: str | None = '202607.1.0', _id: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _typ: Literal[ComTyp.ZEITVARIABLEPREISPOSITION] = ComTyp.ZEITVARIABLEPREISPOSITION, bezeichnung: str | None = None, preisreferenz: Preisreferenz | None = None, preis: Preis | None = None, zaehlzeitdefinition: Zaehlzeitdefinition | None = None, zaehlzeitregister: str | None = None, **extra_data: Any)[source]

Bases: COM

Modelliert eine zeitvariable Preisposition.

Hint

ZeitvariablePreisposition JSON Schema

bezeichnung: str | None: Eine (beliebige) Bezeichnung für die Preisposition.

preis: Preis | None: Der Preis für diese Position.

preisreferenz: Preisreferenz | None: Die Referenz worauf sich der Preis bezieht. Die explizite Einheit wird durch das Feld bezugswert im COM Preis angegeben.

typ: Annotated[Literal[ComTyp.ZEITVARIABLEPREISPOSITION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

zaehlzeitdefinition: Zaehlzeitdefinition | None: Die Zählzeitdefinition, deren Schaltschema bestimmt, wann diese Preisposition gilt.

zaehlzeitregister: str | None: Der freie Register-Code (z.B. “HT”, “NT”, “ST”, “SuperHT”) innerhalb der referenzierten zaehlzeitdefinition, auf den sich diese Preisposition bezieht. Der Code sollte als registercode in mindestens einer Umschaltzeit der referenzierten Zählzeitdefinition vorkommen.

bo4e.com.zustaendigkeit module

Contains Zustaendigkeit class

class bo4e.com.zustaendigkeit.Zustaendigkeit(*, _version: str | None = '202607.1.0', _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.

Hint

Zustaendigkeit JSON Schema

abteilung: str | None: Abteilung, in der der Ansprechpartner/ die Person tätig ist

position: str | None: Berufliche Rolle des Ansprechpartners/ der Person

themengebiet: Themengebiet | None: Hier kann eine thematische Zuordnung des Ansprechpartners bzw. der Person angegeben werden

typ: Annotated[Literal[ComTyp.ZUSTAENDIGKEIT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

bo4e.com package

Submodules

bo4e.com.adresse module

bo4e.com.angebotsposition module

bo4e.com.angebotsteil module

bo4e.com.angebotsvariante module

bo4e.com.aufabschlag module

bo4e.com.ausschreibungsdetail module

bo4e.com.ausschreibungslos module

bo4e.com.betrag module

bo4e.com.com module

bo4e.com.dienstleistung module

bo4e.com.einheitspreisposition module

bo4e.com.energieherkunft module

bo4e.com.energiemix module

bo4e.com.fremdkostenblock module

bo4e.com.fremdkostenposition module

bo4e.com.geokoordinaten module

bo4e.com.katasteradresse module

bo4e.com.konfigurationsprodukt module

bo4e.com.kontaktweg module

bo4e.com.konzessionsabgabe module

bo4e.com.kostenblock module

bo4e.com.kostenposition module

bo4e.com.lastprofil module

bo4e.com.lastvariablepreisposition module

bo4e.com.marktgebietinfo module

bo4e.com.menge module

bo4e.com.messwert module

bo4e.com.preis module

bo4e.com.preisgarantie module

bo4e.com.preisposition module

bo4e.com.preisstaffel module

bo4e.com.rechnungsposition module

bo4e.com.regionsoperation module

bo4e.com.regionspreis module

bo4e.com.regionszeitscheibe module

bo4e.com.relativepreisposition module

bo4e.com.sigmoidparameter module

bo4e.com.standorteigenschaftengas module

bo4e.com.standorteigenschaftenstrom module

bo4e.com.steuerbetrag module

bo4e.com.tagesparameter module

bo4e.com.tarifberechnungsparameter module

bo4e.com.tarifeinschraenkung module

bo4e.com.tarifpreis module

bo4e.com.tarifpreisposition module

bo4e.com.tarifpreiszeitscheibe module

bo4e.com.umschaltzeit module

bo4e.com.unterschrift module

bo4e.com.vertragskonditionen module

bo4e.com.vertragsteil module

bo4e.com.verwendungszweckpromarktrolle module

bo4e.com.vorauszahlung module

bo4e.com.zaehlwerk module

bo4e.com.zaehlzeitregister module

bo4e.com.zaehlzeitsaison module

bo4e.com.zaehlzeittagtyp module

bo4e.com.zahlungsinformation module

bo4e.com.zeitraum module

bo4e.com.zeitreihenwert module

bo4e.com.zeitvariablepreisposition module

bo4e.com.zustaendigkeit module

Module contents