bo4e.com package
Submodules
bo4e.com.adresse module
Contains Adresse class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.adresse.Adresse(*, postleitzahl: str, ort: str, strasse: Optional[str] = None, hausnummer: Optional[str] = None, postfach: Optional[str] = None, adresszusatz: Optional[str] = None, coErgaenzung: Optional[str] = None, landescode: Landescode = Landescode.DE)[source]
Bases:
COMContains an address that can be used for most purposes.
Hint
- co_ergaenzung: Optional[str]
Im Falle einer c/o-Adresse steht in diesem Attribut die Anrede. Z.B. “c/o Veronica Hauptmieterin”
- landescode: Landescode
Offizieller ISO-Landescode
- postfach: Optional[str]
Im Falle einer Postfachadresse das Postfach; Damit werden Straße und Hausnummer nicht berücksichtigt
- classmethod strasse_xor_postfach(postfach: Optional[str], values: Dict[str, Any]) Optional[str][source]
An address is valid if it contains a postfach XOR (a strasse AND hausnummer). This functions checks for these conditions of a valid address.
Nur folgende Angabekombinationen sind (nach der Abfrage) möglich: Straße w f f Hausnummer w f f Postfach f w f Postleitzahl w w w Ort w w w
bo4e.com.angebotsposition module
Contains Angebotsposition class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.angebotsposition.Angebotsposition(*, positionsbezeichnung: str, positionspreis: Preis, positionsmenge: Optional[Menge] = None, positionskosten: Optional[Betrag] = None)[source]
Bases:
COMUnterhalb 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
- positionskosten: Optional[Betrag]
Kosten (positionspreis * positionsmenge) für diese Angebotsposition
bo4e.com.angebotsteil module
Contains Angebotsteil class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.angebotsteil.Angebotsteil(*, positionen: ConstrainedListValue[Angebotsposition], anfrageSubreferenz: Optional[str] = None, lieferstellenangebotsteil: Optional[List[Marktlokation]] = None, gesamtmengeangebotsteil: Optional[Menge] = None, gesamtkostenangebotsteil: Optional[Betrag] = None, lieferzeitraum: Optional[Zeitraum] = None)[source]
Bases:
COMMit 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: Optional[str]
Identifizierung eines Subkapitels einer Anfrage, beispielsweise das Los einer Ausschreibung
- gesamtkostenangebotsteil: Optional[Betrag]
Summe der Jahresenergiekosten aller in diesem Angebotsteil enthaltenen Lieferstellen
- gesamtmengeangebotsteil: Optional[Menge]
Summe der Verbräuche aller in diesem Angebotsteil eingeschlossenen Lieferstellen
- lieferstellenangebotsteil: Optional[List[Marktlokation]]
Marktlokationen, für die dieses Angebotsteil gilt, falls vorhanden. Durch die Marktlokation ist auch die Lieferadresse festgelegt
- lieferzeitraum: Optional[Zeitraum]
Hier kann der Belieferungszeitraum angegeben werden, für den dieser Angebotsteil gilt
- positionen: ConstrainedListValue[Angebotsposition]
Einzelne Positionen, die zu diesem Angebotsteil gehören
bo4e.com.angebotsvariante module
Contains Angebotsvariante and corresponding marshmallow schema for de-/serialization
- class bo4e.com.angebotsvariante.Angebotsvariante(*, angebotsstatus: Angebotsstatus, erstellungsdatum: datetime, bindefrist: datetime, teile: ConstrainedListValue[Angebotsteil], gesamtmenge: Optional[Menge] = None, gesamtkosten: Optional[Betrag] = None)[source]
Bases:
COMFührt die verschiedenen Ausprägungen der Angebotsberechnung auf
- angebotsstatus: Angebotsstatus
Gibt den Status eines Angebotes an.
- teile: ConstrainedListValue[Angebotsteil]
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 and corresponding marshmallow schema for de-/serialization
- class bo4e.com.aufabschlag.AufAbschlag(*, bezeichnung: str, staffeln: List[Preisstaffel], beschreibung: Optional[str] = None, aufAbschlagstyp: Optional[AufAbschlagstyp] = None, aufAbschlagsziel: Optional[AufAbschlagsziel] = None, einheit: Optional[Waehrungseinheit] = None, website: Optional[str] = None, gueltigkeitszeitraum: Optional[Zeitraum] = None)[source]
Bases:
COMModell für die preiserhöhenden (Aufschlag) bzw. preisvermindernden (Abschlag) Zusatzvereinbarungen, die individuell zu einem neuen oder bestehenden Liefervertrag abgeschlossen wurden.
- auf_abschlagstyp: Optional[AufAbschlagstyp]
Typ des Aufabschlages (z.B. absolut oder prozentual).
- auf_abschlagsziel: Optional[AufAbschlagsziel]
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc..
- einheit: Optional[Waehrungseinheit]
- gueltigkeitszeitraum: Optional[Zeitraum]
Internetseite, auf der die Informationen zum Auf-/Abschlag veröffentlicht sind.
- staffeln: List[Preisstaffel]
Werte für die gestaffelten Auf/Abschläge.
bo4e.com.aufabschlagproort module
Contains AufAbschlagProOrt class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.aufabschlagproort.AufAbschlagProOrt(*, postleitzahl: str, ort: str, netznr: str, staffeln: ConstrainedListValue[AufAbschlagstaffelProOrt])[source]
Bases:
COMMit dieser Komponente können Auf- und Abschläge verschiedener Typen im Zusammenhang mit örtlichen Gültigkeiten abgebildet werden.
- staffeln: ConstrainedListValue[AufAbschlagstaffelProOrt]
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung.
bo4e.com.aufabschlagregional module
Contains AufAbschlagRegional and corresponding marshmallow schema for de-/serialization
- class bo4e.com.aufabschlagregional.AufAbschlagRegional(*, bezeichnung: str, betraege: ConstrainedListValue[AufAbschlagProOrt], beschreibung: Optional[str] = None, aufAbschlagstyp: Optional[AufAbschlagstyp] = None, aufAbschlagsziel: Optional[AufAbschlagsziel] = None, einheit: Optional[Waehrungseinheit] = None, website: Optional[str] = None, zusatzprodukte: Optional[List[str]] = None, voraussetzungen: Optional[List[str]] = None, tarifnamensaenderungen: Optional[str] = None, gueltigkeitszeitraum: Optional[Zeitraum] = None, energiemixaenderung: Optional[Energiemix] = None, vertagskonditionsaenderung: Optional[Vertragskonditionen] = None, garantieaenderung: Optional[Preisgarantie] = None, einschraenkungsaenderung: Optional[Tarifeinschraenkung] = None)[source]
Bases:
COMMit 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: Optional[AufAbschlagstyp]
Typ des Aufabschlages (z.B. absolut oder prozentual)
- auf_abschlagsziel: Optional[AufAbschlagsziel]
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.
- betraege: ConstrainedListValue[AufAbschlagProOrt]
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung
- einheit: Optional[Waehrungseinheit]
Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird. Euro oder Ct.
- einschraenkungsaenderung: Optional[Tarifeinschraenkung]
Änderungen in den Einschränkungen zum Tarif. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- energiemixaenderung: Optional[Energiemix]
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: Optional[Preisgarantie]
Änderungen in den Garantievereinbarungen. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- tarifnamensaenderungen: Optional[str]
Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten.
- vertagskonditionsaenderung: Optional[Vertragskonditionen]
Änderungen in den Vertragskonditionen. Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- voraussetzungen: Optional[List[str]]
Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann
bo4e.com.aufabschlagstaffelproort module
Contains AufAbschlagstaffelProOrt class and corresponding marshmallow schema for de-/serialization
bo4e.com.ausschreibungsdetail module
Contains class Ausschreibungsdetail and corresponding marshmallow schema for de-/serialization
- class bo4e.com.ausschreibungsdetail.Ausschreibungsdetail(*, marktlokationsId: str, netzebeneLieferung: str, netzebeneMessung: str, marktlokationsadresse: Adresse, lieferzeitraum: Zeitraum, netzbetreiber: Optional[str] = None, kunde: Optional[str] = None, zaehlernummer: Optional[str] = None, marktlokationsbezeichnung: Optional[str] = None, zaehlertechnik: Optional[Zaehlertyp] = None, lastgangVorhanden: Optional[bool] = None, prognoseJahresarbeit: Optional[Menge] = None, prognoseArbeitLieferzeitraum: Optional[Menge] = None, prognoseLeistung: Optional[Menge] = None, rechnungsadresse: Optional[Adresse] = None)[source]
Bases:
COMDie Komponente Ausschreibungsdetail wird verwendet um die Informationen zu einer Abnahmestelle innerhalb eines Ausschreibungsloses abzubilden.
- lastgang_vorhanden: Optional[bool]
Zeigt an, ob es zu der Marktlokation einen Lastgang gibt. Falls ja, kann dieser abgerufen werden und daraus die Verbrauchswerte ermittelt werden
- marktlokationsbezeichnung: Optional[str]
Bezeichnung für die Lokation, z.B. ‘Zentraler Einkauf, Hamburg’
- netzbetreiber: Optional[str]
Bezeichnung des zuständigen Netzbetreibers, z.B. ‘Stromnetz Hamburg GmbH’
- netzebene_lieferung: str
In der angegebenen Netzebene wird die Marktlokation versorgt, z.B. MSP für Mittelspannung
- netzebene_messung: str
In der angegebenen Netzebene wird die Lokation gemessen, z.B. NSP für Niederspannung
- prognose_arbeit_lieferzeitraum: Optional[Menge]
Ein Prognosewert für die Arbeit innerhalb des angefragten Lieferzeitraums der ausgeschriebenen Lokation
- prognose_jahresarbeit: Optional[Menge]
Prognosewert für die Jahresarbeit der ausgeschriebenen Lokation
- prognose_leistung: Optional[Menge]
Prognosewert für die abgenommene maximale Leistung der ausgeschriebenen Lokation
- zaehlertechnik: Optional[Zaehlertyp]
Spezifikation, um welche Zählertechnik es sich im vorliegenden Fall handelt, z.B. Leistungsmessung
bo4e.com.ausschreibungslos module
Contains Ausschreibungslos class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.ausschreibungslos.Ausschreibungslos(*, losnummer: str, bezeichnung: str, preismodell: Preismodell, energieart: Sparte, wunschRechnungslegung: Rechnungslegung, wunschVertragsform: Vertragsform, betreutDurch: str, anzahlLieferstellen: int, lieferstellen: ConstrainedListValue[Ausschreibungsdetail], lieferzeitraum: Zeitraum, bemerkung: Optional[str] = None, gesamtMenge: Optional[Menge] = None, wunschMindestmenge: Optional[Menge] = None, wunschMaximalmenge: Optional[Menge] = None, wiederholungsintervall: Optional[Zeitraum] = None, wunschKuendingungsfrist: Optional[Zeitraum] = None, wunschZahlungsziel: Optional[Zeitraum] = None)[source]
Bases:
COMEine Komponente zur Abbildung einzelner Lose einer Ausschreibung
- gesamt_menge: Optional[Menge]
Gibt den Gesamtjahresverbrauch (z.B. in kWh) aller in diesem Los enthaltenen Lieferstellen an
- lieferstellen: ConstrainedListValue[Ausschreibungsdetail]
Die ausgeschriebenen Lieferstellen
- lieferzeitraum: Zeitraum
Zeitraum, für den die in diesem Los enthaltenen Lieferstellen beliefert werden sollen
- preismodell: Preismodell
Bezeichnung der Preismodelle in Ausschreibungen für die Energielieferung
- wiederholungsintervall: Optional[Zeitraum]
In welchem Intervall die Angebotsabgabe wiederholt werden darf. Angabe nur gesetzt für die 2. Phase bei öffentlich-rechtlichen Ausschreibungen
- wunsch_rechnungslegung: Rechnungslegung
Aufzählung der Möglichkeiten zur Rechnungslegung in Ausschreibungen
- wunsch_vertragsform: Vertragsform
Aufzählung der Möglichkeiten zu Vertragsformen in Ausschreibungen
bo4e.com.betrag module
Contains Betrag class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.betrag.Betrag(*, wert: Decimal, waehrung: Waehrungscode)[source]
Bases:
COMDie 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
- waehrung: Waehrungscode
Die entsprechende Waehrung
bo4e.com.com module
Contains base class for all components
- class bo4e.com.com.COM[source]
Bases:
BaseModelbase class for all components
Hint
bo4e.com.dienstleistung module
Contains Dienstleistung class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.dienstleistung.Dienstleistung(*, dienstleistungstyp: Dienstleistungstyp, bezeichnung: str)[source]
Bases:
COMAbbildung einer abrechenbaren Dienstleistung.
- dienstleistungstyp: Dienstleistungstyp
Kennzeichnung der Dienstleistung
bo4e.com.energieherkunft module
Contains Energieherkunft class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.energieherkunft.Energieherkunft(*, erzeugungsart: Erzeugungsart, anteilProzent: ConstrainedDecimalValue)[source]
Bases:
COMAbbildung einer Energieherkunft
- anteil_prozent: ConstrainedDecimalValue
Prozentualer Anteil der jeweiligen Erzeugungsart.
- erzeugungsart: Erzeugungsart
Art der Erzeugung der Energie.
bo4e.com.energiemix module
Contains Energiemix class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.energiemix.Energiemix(*, energiemixnummer: int, energieart: Sparte, bezeichnung: str, gueltigkeitsjahr: int, anteil: ConstrainedListValue[Energieherkunft], bemerkung: Optional[str] = None, co2Emission: Optional[Decimal] = None, atommuell: Optional[Decimal] = None, oekozertifikate: List[Oekozertifikat] = [], oekolabel: List[Oekolabel] = [], oekoTopTen: Optional[bool] = None, website: Optional[str] = None)[source]
Bases:
COMZusammensetzung der gelieferten Energie aus den verschiedenen Primärenergieformen.
- anteil: ConstrainedListValue[Energieherkunft]
Anteile der jeweiligen Erzeugungsart
- oekozertifikate: List[Oekozertifikat]
Zertifikate für den Energiemix
bo4e.com.externereferenz module
Contains ExterenzeReferenz class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.externereferenz.ExterneReferenz(*, exRefName: str, exRefWert: str)[source]
Bases:
COMViele Datenobjekte weisen in unterschiedlichen Systemen eine eindeutige ID (Kundennummer, GP-Nummer etc.) auf. Beim Austausch von Datenobjekten zwischen verschiedenen Systemen ist es daher hilfreich, sich die eindeutigen IDs der anzubindenden Systeme zu merken.
bo4e.com.fremdkostenblock module
Contains Fremdkostenblock class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.fremdkostenblock.Fremdkostenblock(*, kostenblockbezeichnung: str, kostenpositionen: Optional[List[Fremdkostenposition]] = None, summeKostenblock: Optional[Betrag] = None)[source]
Bases:
COMKomponente zur Abbildung eines Kostenblocks in den Fremdkosten
- kostenblockbezeichnung: str
Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.
- kostenpositionen: Optional[List[Fremdkostenposition]]
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 and corresponding marshmallow schema for de-/serialization
- class bo4e.com.fremdkostenposition.Fremdkostenposition(*, positionstitel: str, betragKostenposition: Betrag, artikelbezeichnung: str, einzelpreis: Preis, von: Optional[datetime] = None, bis: Optional[datetime] = None, menge: Optional[Menge] = None, zeitmenge: Optional[Menge] = None, artikeldetail: Optional[str] = None, marktpartnername: Optional[str] = None, marktpartnercode: Optional[str] = None, gebietcodeEic: Optional[str] = None, linkPreisblatt: Optional[str] = None)[source]
Bases:
KostenpositionEine Kostenposition im Bereich der Fremdkosten
- gebietcode_eic: Optional[str]
EIC-Code des Regel- oder Marktgebietes eingetragen. Z.B. ‘10YDE-EON——1’ für die Regelzone TenneT
bo4e.com.geokoordinaten module
Contains Geokoordinaten class and corresponding marshmallow schema for de-/serialization
bo4e.com.geraet module
Contains Geraet class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.geraet.Geraet(*, geraetenummer: Optional[str] = None, geraeteeigenschaften: Optional[Geraeteeigenschaften] = None)[source]
Bases:
COMMit dieser Komponente werden alle Geräte modelliert, die keine Zähler sind.
Hint
- geraeteeigenschaften: Optional[Geraeteeigenschaften]
Festlegung der Eigenschaften des Gerätes. Z.B. Wandler MS/NS.
bo4e.com.geraeteeigenschaften module
Contains Geraeteeigenschaften and corresponding marshmallow schema for de-/serialization
- class bo4e.com.geraeteeigenschaften.Geraeteeigenschaften(*, geraetetyp: Geraetetyp, geraetemerkmal: Optional[Geraetemerkmal] = None)[source]
Bases:
COMMit dieser Komponente werden die Eigenschaften eines Gerätes in Bezug auf den Typ und weitere Merkmale modelliert
- geraetemerkmal: Optional[Geraetemerkmal]
Weitere Merkmale des Geräts, zum Beispiel Mehrtarif, Eintarif etc..
- geraetetyp: Geraetetyp
Der Typ eines Gerätes, beispielsweise Drehstromzähler
bo4e.com.hardware module
Contains Hardware class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.hardware.Hardware(*, geraetetyp: Geraetetyp, bezeichnung: str)[source]
Bases:
COMAbbildung einer abrechenbaren Hardware
Hint
- geraetetyp: Geraetetyp
Eindeutiger Typ der Hardware
bo4e.com.katasteradresse module
Contains Katasteradresse class and corresponding marshmallow schema for de-/serialization
bo4e.com.kostenblock module
Contains Kostenblock and corresponding marshmallow schema for de-/serialization
- class bo4e.com.kostenblock.Kostenblock(*, kostenblockbezeichnung: str, summeKostenblock: Optional[Betrag] = None, kostenpositionen: Optional[List[Kostenposition]] = None)[source]
Bases:
COMMit dieser Komponente werden mehrere Kostenpositionen zusammengefasst.
- kostenblockbezeichnung: str
Bezeichnung für einen Kostenblock. Z.B. Netzkosten, Messkosten, Umlagen, etc.
- kostenpositionen: Optional[List[Kostenposition]]
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 and corresponding marshmallow schema for de-/serialization
- class bo4e.com.kostenposition.Kostenposition(*, positionstitel: str, betragKostenposition: Betrag, artikelbezeichnung: str, einzelpreis: Preis, von: Optional[datetime] = None, bis: Optional[datetime] = None, menge: Optional[Menge] = None, zeitmenge: Optional[Menge] = None, artikeldetail: Optional[str] = None)[source]
Bases:
COMDiese Komponente wird zur Übertagung der Details zu einer Kostenposition verwendet.
- artikelbezeichnung: str
Arbeitspreis HT
- Type
Bezeichnung für den Artikel für den die Kosten ermittelt wurden. Beispiel
- artikeldetail: Optional[str]
‘Drehstromzähler’
- Type
Detaillierung des Artikels (optional). Beispiel
- betrag_kostenposition: Betrag
Der errechnete Gesamtbetrag der Position als Ergebnis der Berechnung <Menge * Einzelpreis> oder <Einzelpreis / (Anzahl Tage Jahr) * zeitmenge>
- menge: Optional[Menge]
3.660 kWh
- Type
Die Menge, die in die Kostenberechnung eingeflossen ist. Beispiel
bo4e.com.kriteriumwert module
Contains KriteriumWert class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.kriteriumwert.KriteriumWert(*, kriterium: Tarifregionskriterium, wert: str)[source]
Bases:
COMMit dieser Komponente können Kriterien und deren Werte definiert werden
- kriterium: Tarifregionskriterium
Hier steht, für welches Kriterium der Wert gilt. Z.B. Postleitzahlen
bo4e.com.marktgebietinfo module
Contains Marktgebietinfo class and corresponding marshmallow schema for de-/serialization
bo4e.com.menge module
Contains Menge class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.menge.Menge(*, wert: Decimal, einheit: Mengeneinheit)[source]
Bases:
COMAbbildung einer Menge mit Wert und Einheit.
Hint
- einheit: Mengeneinheit
Gibt die Einheit zum jeweiligen Wert an
bo4e.com.messlokationszuordnung module
Contains Messlokationszuordnung class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.messlokationszuordnung.Messlokationszuordnung(*, messlokationsId: str, arithmetik: ArithmetischeOperation, gueltigSeit: Optional[datetime] = None, gueltigBis: Optional[datetime] = None)[source]
Bases:
COMMit dieser Komponente werden Messlokationen zu Marktlokationen zugeordnet. Dabei kann eine arithmetische Operation (Addition, Subtraktion, Multiplikation, Division) angegeben werden, mit der die Messlokation zum Verbrauch der Marktlokation beiträgt.
- arithmetik: ArithmetischeOperation
bo4e.com.positionsaufabschlag module
Contains PositionsAufAbschlag and corresponding marshmallow schema for de-/serialization
- class bo4e.com.positionsaufabschlag.PositionsAufAbschlag(*, bezeichnung: str, beschreibung: Optional[str] = None, aufAbschlagstyp: AufAbschlagstyp, aufAbschlagswert: Decimal, aufAbschlagswaehrung: Waehrungseinheit)[source]
Bases:
COMDifferenzierung 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
Typ des AufAbschlages
- auf_abschlagswaehrung: Waehrungseinheit
Einheit, in der der Auf-/Abschlag angegeben ist (z.B. ct/kWh).
bo4e.com.preis module
Contains Preis class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.preis.Preis(*, wert: Decimal, einheit: Waehrungseinheit, bezugswert: Mengeneinheit, status: Optional[Preisstatus] = None)[source]
Bases:
COMAbbildung eines Preises mit Wert, Einheit, Bezugswert und Status.
Hint
- bezugswert: Mengeneinheit
Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.
- einheit: Waehrungseinheit
Währungseinheit für den Preis, z.B. Euro oder Ct.
- status: Optional[Preisstatus]
Gibt den Status des veröffentlichten Preises an
bo4e.com.preisgarantie module
Contains Preisgarantie class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.preisgarantie.Preisgarantie(*, preisgarantietyp: Preisgarantietyp, zeitlicheGueltigkeit: Zeitraum, beschreibung: Optional[str] = None)[source]
Bases:
COMDefinition für eine Preisgarantie mit der Möglichkeit verschiedener Ausprägungen.
- preisgarantietyp: Preisgarantietyp
Festlegung, auf welche Preisbestandteile die Garantie gewährt wird.
bo4e.com.preisposition module
Contains Preisposition class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.preisposition.Preisposition(*, berechnungsmethode: Kalkulationsmethode, leistungstyp: Leistungstyp, leistungsbezeichnung: str, preiseinheit: Waehrungseinheit, bezugsgroesse: Mengeneinheit, preisstaffeln: ConstrainedListValue[Preisstaffel], zeitbasis: Optional[Zeiteinheit] = None, tarifzeit: Optional[Tarifzeit] = None, bdewArtikelnummer: Optional[BDEWArtikelnummer] = None, zonungsgroesse: Optional[Bemessungsgroesse] = None, freimengeBlindarbeit: Optional[Decimal] = None, freimengeLeistungsfaktor: Optional[Decimal] = None, gruppenartikelId: Optional[str] = None)[source]
Bases:
COMPreis für eine definierte Lieferung oder Leistung innerhalb eines Preisblattes
- bdew_artikelnummer: Optional[BDEWArtikelnummer]
Eine vom BDEW standardisierte Bezeichnug für die abgerechnete Leistungserbringung; Diese Artikelnummer wird auch im Rechnungsteil der INVOIC verwendet.
- berechnungsmethode: Kalkulationsmethode
Das Modell, das der Preisbildung zugrunde liegt
- bezugsgroesse: Mengeneinheit
Hier wird festgelegt, auf welche Bezugsgrösse sich der Preis bezieht, z.B. kWh oder Stück
- freimenge_blindarbeit: Optional[Decimal]
Der Anteil der Menge der Blindarbeit in Prozent von der Wirkarbeit, für die keine Abrechnung erfolgt
- freimenge_leistungsfaktor: Optional[Decimal]
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: Optional[str]
Übergeordnete Gruppen-ID, die sich ggf. auf die Artikel-ID in der Preisstaffel bezieht
- leistungstyp: Leistungstyp
Standardisierte Bezeichnung für die abgerechnete Leistungserbringung
- preiseinheit: Waehrungseinheit
Festlegung, mit welcher Preiseinheit abgerechnet wird, z.B. Ct. oder €
- preisstaffeln: ConstrainedListValue[Preisstaffel]
Preisstaffeln, die zu dieser Preisposition gehören
- zeitbasis: Optional[Zeiteinheit]
Die Zeit(dauer) auf die sich der Preis bezieht. Z.B. ein Jahr für einen Leistungspreis der in €/kW/Jahr ausgegeben wird
- zonungsgroesse: Optional[Bemessungsgroesse]
Mit der Menge der hier angegebenen Größe wird die Staffelung/Zonung durchgeführt. Z.B. Vollbenutzungsstunden
bo4e.com.preisstaffel module
Contains Preisstaffel and corresponding marshmallow schema for de-/serialization
- class bo4e.com.preisstaffel.Preisstaffel(*, einheitspreis: Decimal, staffelgrenzeVon: Decimal, staffelgrenzeBis: Decimal, sigmoidparameter: Optional[Sigmoidparameter] = None)[source]
Bases:
COMGibt die Staffelgrenzen der jeweiligen Preise an
- sigmoidparameter: Optional[Sigmoidparameter]
Parameter zur Berechnung des Preises anhand der Jahresmenge und weiterer netzbezogener Parameter
bo4e.com.rechnungsposition module
Contains Rechnungsposition class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.rechnungsposition.Rechnungsposition(*, positionsnummer: int, lieferungVon: datetime, lieferungBis: datetime, positionstext: str, positionsMenge: Menge, einzelpreis: Preis, teilsummeNetto: Betrag, teilsummeSteuer: Steuerbetrag, zeiteinheit: Optional[Zeiteinheit] = None, artikelnummer: Optional[BDEWArtikelnummer] = None, lokationsId: Optional[str] = None, zeitbezogeneMenge: Optional[Menge] = None, teilrabattNetto: Optional[Betrag] = None, artikelId: Optional[str] = None)[source]
Bases:
COMÜber Rechnungspositionen werden Rechnungen strukturiert. In einem Rechnungsteil wird jeweils eine in sich geschlossene Leistung abgerechnet.
- artikel_id: Optional[str]
Standardisierte vom BDEW herausgegebene Liste, welche im Strommarkt die BDEW-Artikelnummer ablöst
- artikelnummer: Optional[BDEWArtikelnummer]
Kennzeichnung der Rechnungsposition mit der Standard-Artikelnummer des BDEW
- teilsumme_netto: Betrag
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
Auf die Position entfallende Steuer, bestehend aus Steuersatz und Betrag
- zeitbezogene_menge: Optional[Menge]
Eine auf die Zeiteinheit bezogene Untermenge. Z.B. bei einem Jahrespreis, 3 Monate oder 146 Tage. Basierend darauf wird der Preis aufgeteilt.
- zeiteinheit: Optional[Zeiteinheit]
Falls sich der Preis auf eine Zeit bezieht, steht hier die Einheit
bo4e.com.regionalegueltigkeit module
Contains RegionaleGueltigkeit class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionalegueltigkeit.RegionaleGueltigkeit(*, gueltigkeitstyp: Gueltigkeitstyp, kriteriumsWerte: ConstrainedListValue[KriteriumWert])[source]
Bases:
COMMit dieser Komponente können regionale Gültigkeiten, z.B. für Tarife, Zu- und Abschläge und Preise definiert werden.
- gueltigkeitstyp: Gueltigkeitstyp
Unterscheidung ob Positivliste oder Negativliste übertragen wird
- kriteriums_werte: ConstrainedListValue[KriteriumWert]
bo4e.com.regionalepreisgarantie module
Contains RegionalePreisgarantie class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionalepreisgarantie.RegionalePreisgarantie(*, preisgarantietyp: Preisgarantietyp, zeitlicheGueltigkeit: Zeitraum, beschreibung: Optional[str] = None, regionaleGueltigkeit: RegionaleGueltigkeit)[source]
Bases:
PreisgarantieAbbildung einer Preisgarantie mit regionaler Abgrenzung
- regionale_gueltigkeit: RegionaleGueltigkeit
Regionale Eingrenzung der Preisgarantie.
bo4e.com.regionalepreisstaffel module
Contains RegionalePreisstaffel class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionalepreisstaffel.RegionalePreisstaffel(*, einheitspreis: Decimal, staffelgrenzeVon: Decimal, staffelgrenzeBis: Decimal, sigmoidparameter: Optional[Sigmoidparameter] = None, regionaleGueltigkeit: RegionaleGueltigkeit)[source]
Bases:
PreisstaffelAbbildung einer Preisstaffel mit regionaler Abgrenzung
- regionale_gueltigkeit: RegionaleGueltigkeit
Regionale Eingrenzung der Preisstaffel
bo4e.com.regionaleraufabschlag module
Contains RegionalerAufAbschlag class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionaleraufabschlag.RegionalerAufAbschlag(*, bezeichnung: str, staffeln: ConstrainedListValue[RegionalePreisstaffel], beschreibung: Optional[str] = None, aufAbschlagstyp: Optional[AufAbschlagstyp] = None, aufAbschlagsziel: Optional[AufAbschlagsziel] = None, einheit: Optional[Waehrungseinheit] = None, website: Optional[str] = None, zusatzprodukte: Optional[List[str]] = None, voraussetzungen: Optional[List[str]] = None, tarifnamensaenderungen: Optional[str] = None, gueltigkeitszeitraum: Optional[Zeitraum] = None, energiemixaenderung: Optional[Energiemix] = None, vertagskonditionsaenderung: Optional[Vertragskonditionen] = None, garantieaenderung: Optional[Preisgarantie] = None, einschraenkungsaenderung: Optional[Tarifeinschraenkung] = None)[source]
Bases:
COMMit 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: Optional[AufAbschlagstyp]
Typ des Aufabschlages (z.B. absolut oder prozentual)
- auf_abschlagsziel: Optional[AufAbschlagsziel]
Diesem Preis oder den Kosten ist der Auf/Abschlag zugeordnet. Z.B. Arbeitspreis, Gesamtpreis etc.
- einheit: Optional[Waehrungseinheit]
Gibt an in welcher Währungseinheit der Auf/Abschlag berechnet wird (nur im Falle absoluter Aufschlagstypen).
- einschraenkungsaenderung: Optional[Tarifeinschraenkung]
Änderungen in den Einschränkungen zum Tarif; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- energiemixaenderung: Optional[Energiemix]
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: Optional[Preisgarantie]
Änderungen in den Garantievereinbarungen; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- staffeln: ConstrainedListValue[RegionalePreisstaffel]
Werte für die gestaffelten Auf/Abschläge mit regionaler Eingrenzung
- tarifnamensaenderungen: Optional[str]
Durch die Anwendung des Auf/Abschlags kann eine Änderung des Tarifnamens auftreten
- vertagskonditionsaenderung: Optional[Vertragskonditionen]
Änderungen in den Vertragskonditionen; Falls in dieser Komponenten angegeben, werden die Tarifparameter hiermit überschrieben.
- voraussetzungen: Optional[List[str]]
Voraussetzungen, die erfüllt sein müssen, damit dieser AufAbschlag zur Anwendung kommen kann
bo4e.com.regionaletarifpreisposition module
Contains RegionaleTarifpreisposition class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionaletarifpreisposition.RegionaleTarifpreisposition(*, preistyp: Preistyp, einheit: Waehrungseinheit, bezugseinheit: Mengeneinheit, preisstaffeln: ConstrainedListValue[RegionalePreisstaffel], mengeneinheitstaffel: Optional[Mengeneinheit] = None)[source]
Bases:
COMMit dieser Komponente können Tarifpreise verschiedener Typen im Zusammenhang mit regionalen Gültigkeiten abgebildet werden.
- bezugseinheit: Mengeneinheit
Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr
- einheit: Waehrungseinheit
Einheit des Preises (z.B. EURO)
- mengeneinheitstaffel: Optional[Mengeneinheit]
Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)
- preisstaffeln: ConstrainedListValue[RegionalePreisstaffel]
Hier sind die Staffeln mit ihren Preisangaben und regionalen Gültigkeiten definiert
bo4e.com.regionskriterium module
Contains Regionskriterium class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.regionskriterium.Regionskriterium(*, gueltigkeitstyp: Gueltigkeitstyp, regionskriteriumtyp: Regionskriteriumtyp, wert: str)[source]
Bases:
COMKomponente zur Abbildung eines Regionskriteriums
- gueltigkeitstyp: Gueltigkeitstyp
Hier wird festgelegt, ob es sich um ein einschließendes oder ausschließendes Kriterium handelt.
- regionskriteriumtyp: Regionskriteriumtyp
Hier wird das Kriterium selbst angegeben, z.B. Bundesland.
bo4e.com.rufnummer module
Contains Rufnummer class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.rufnummer.Rufnummer(*, nummerntyp: Rufnummernart, rufnummer: str)[source]
Bases:
COMContains information to call or fax someone
- nummerntyp: Rufnummernart
Ausprägung der Nummer
bo4e.com.sigmoidparameter module
Contains Sigmoidparameter class and corresponding marshmallow schema for de-/serialization
bo4e.com.standorteigenschaftengas module
Contains StandorteigenschaftenGas class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.standorteigenschaftengas.StandorteigenschaftenGas(*, netzkontonummern: ConstrainedListValue[str], marktgebiete: List[MarktgebietInfo])[source]
Bases:
COMStandorteigenschaften der Sparte Gas
- marktgebiete: List[MarktgebietInfo]
Die Informationen zu Marktgebieten in dem Netz.
bo4e.com.standorteigenschaftenstrom module
Contains StandorteigenschaftenStrom class and corresponding marshmallow schema for de-/serialization
bo4e.com.steuerbetrag module
Contains Steuerbetrag class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.steuerbetrag.Steuerbetrag(*, steuerkennzeichen: Steuerkennzeichen, basiswert: Decimal, steuerwert: Decimal, waehrung: Waehrungscode)[source]
Bases:
COMAbbildung eines Steuerbetrages.
- steuerkennzeichen: Steuerkennzeichen
Kennzeichnung des Steuersatzes, bzw. Verfahrens.
- waehrung: Waehrungscode
Währung. Z.B. Euro.
bo4e.com.tagesvektor module
Contains Tagesvektor class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tagesvektor.Tagesvektor(*, tag: datetime, werte: ConstrainedListValue[Zeitreihenwertkompakt])[source]
Bases:
COMAbbildung eines Tagesvektors eines beliebigen äquidistanten Zeitrasters
- tag: datetime
Der Zeitpunkt ab dem die Werte ermittelt wurden. Es kann entweder der Beginn des Strom- oder Gastages verwendet werden. Der Zeitpunkt sollte eindeutig sein, d.h. sowohl Datum+Uhrzeit als auch den UTC-Offset spezifizieren.
- werte: ConstrainedListValue[Zeitreihenwertkompakt]
Die Werte am angegebenen Tag; In Kombination aus Zeitintervall und Tag lassen sich die Zeiten der Werte eindeutig konstruieren.
bo4e.com.tarifberechnungsparameter module
Contains Tarifberechnungsparameter class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tarifberechnungsparameter.Tarifberechnungsparameter(*, berechnungsmethode: Optional[Tarifkalkulationsmethode] = None, messpreisInGpEnthalten: Optional[bool] = None, messpreisBeruecksichtigen: Optional[bool] = None, messpreistyp: Optional[Messpreistyp] = None, kwInklusive: Optional[Decimal] = None, kwWeitereMengen: Optional[Decimal] = None, hoechstpreisNT: Optional[Preis] = None, hoechstpreisHT: Optional[Preis] = None, mindestpreis: Optional[Preis] = None, zusatzpreise: Optional[List[Tarifpreis]] = None)[source]
Bases:
COMIn dieser Komponente sind die Berechnungsparameter für die Ermittlung der Tarifkosten zusammengefasst. .. raw:: html
<object data=”../_static/images/bo4e/com/Tarifberechnungsparameter.svg” type=”image/svg+xml”></object>
- berechnungsmethode: Optional[Tarifkalkulationsmethode]
Gibt an, wie die Einzelpreise des Tarifes zu verarbeiten sind
- kw_weitere_mengen: Optional[Decimal]
Intervall, indem die über “kwInklusive” hinaus abgenommene Leistung kostenpflichtig wird (z.B. je 5 kW 20 EURO)
- messpreis_beruecksichtigen: Optional[bool]
True, falls bei der Bildung des Durchschnittspreises für die Höchst- und Mindestpreisbetrachtung der Messpreis mit berücksichtigt wird
- messpreis_in_gp_enthalten: Optional[bool]
True, falls der Messpreis im Grundpreis (GP) enthalten ist
- messpreistyp: Optional[Messpreistyp]
Typ des Messpreises
- zusatzpreise: Optional[List[Tarifpreis]]
Liste mit zusätzlichen Preisen, beispielsweise Messpreise und/oder Leistungspreise
bo4e.com.tarifeinschraenkung module
Contains Tarifeinschraenkung and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tarifeinschraenkung.Tarifeinschraenkung(*, zusatzprodukte: Optional[List[str]] = None, voraussetzungen: Optional[List[Voraussetzungen]] = None, einschraenkungzaehler: Optional[List[Geraet]] = None, einschraenkungleistung: Optional[List[Menge]] = None)[source]
Bases:
COMMit dieser Komponente werden Einschränkungen für die Anwendung von Tarifen modelliert.
- einschraenkungleistung: Optional[List[Menge]]
Die vereinbarte Leistung, die (näherungsweise) abgenommen wird. Insbesondere Gastarife können daran gebunden sein, dass die Leistung einer vereinbarten Höhe entspricht.
- einschraenkungzaehler: Optional[List[Geraet]]
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.)
- voraussetzungen: Optional[List[Voraussetzungen]]
Voraussetzungen, die erfüllt sein müssen, damit dieser Tarif zur Anwendung kommen kann
bo4e.com.tarifpreis module
Contains Tarifpreis class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tarifpreis.Tarifpreis(*, wert: Decimal, einheit: Waehrungseinheit, bezugswert: Mengeneinheit, status: Optional[Preisstatus] = None, preistyp: Preistyp, beschreibung: Optional[str] = None)[source]
Bases:
PreisAbbildung eines Tarifpreises mit Preistyp und Beschreibung abgeleitet von COM Preis.
bo4e.com.tarifpreisposition module
Contains Tarifpreisposition class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tarifpreisposition.Tarifpreisposition(*, preistyp: Preistyp, einheit: Waehrungseinheit, bezugseinheit: Mengeneinheit, preisstaffeln: ConstrainedListValue[Preisstaffel], mengeneinheitstaffel: Optional[Mengeneinheit] = None)[source]
Bases:
COMMit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden.
- bezugseinheit: Mengeneinheit
Größe, auf die sich die Einheit bezieht, beispielsweise kWh, Jahr
- einheit: Waehrungseinheit
Einheit des Preises (z.B. EURO)
- mengeneinheitstaffel: Optional[Mengeneinheit]
Gibt an, nach welcher Menge die vorgenannte Einschränkung erfolgt (z.B. Jahresstromverbrauch in kWh)
- preisstaffeln: ConstrainedListValue[Preisstaffel]
Hier sind die Staffeln mit ihren Preisenangaben definiert
bo4e.com.tarifpreispositionproort module
Contains TarifpreispositionProOrt class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.tarifpreispositionproort.TarifpreispositionProOrt(*, postleitzahl: ConstrainedStrValue, ort: str, netznr: str, preisstaffeln: ConstrainedListValue[TarifpreisstaffelProOrt])[source]
Bases:
COMMit dieser Komponente können Tarifpreise verschiedener Typen abgebildet werden
- postleitzahl: ConstrainedStrValue
Postleitzahl des Ortes für den der Preis gilt
- preisstaffeln: ConstrainedListValue[TarifpreisstaffelProOrt]
bo4e.com.tarifpreisstaffelproort module
Contains TarifpreisstaffelProOrt class and corresponding marshmallow schema for de-/serialization
bo4e.com.unterschrift module
Contains Unterschrift class and corresponding marshmallow schema for de-/serialization
bo4e.com.verbrauch module
Contains Verbrauch and corresponding marshmallow schema for de-/serialization
- class bo4e.com.verbrauch.Verbrauch(*, wertermittlungsverfahren: Wertermittlungsverfahren, obisKennzahl: ConstrainedStrValue, wert: Decimal, mengeneinheit: Mengeneinheit, startdatum: Optional[datetime] = None, enddatum: Optional[datetime] = None)[source]
Bases:
COMAbbildung eines zeitlich abgegrenzten Verbrauchs
- mengeneinheit: Mengeneinheit
Gibt die Einheit zum jeweiligen Wert an
- obis_kennzahl: ConstrainedStrValue
Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. ‘1-0:
- startdatum: Optional[datetime]
Inklusiver Beginn des Zeitraumes, für den der Verbrauch angegeben wird
- wertermittlungsverfahren: Wertermittlungsverfahren
Gibt an, ob es sich um eine PROGNOSE oder eine MESSUNG handelt
bo4e.com.vertragskonditionen module
Contains Vertragskonditionen class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.vertragskonditionen.Vertragskonditionen(*, beschreibung: Optional[str] = None, anzahlAbschlaege: Optional[Decimal] = None, vertragslaufzeit: Optional[Zeitraum] = None, kuendigungsfrist: Optional[Zeitraum] = None, vertragsverlaengerung: Optional[Zeitraum] = None, abschlagszyklus: Optional[Zeitraum] = None)[source]
Bases:
COMAbbildung für Vertragskonditionen. Die Komponente wird sowohl im Vertrag als auch im Tarif verwendet.
- abschlagszyklus: Optional[Zeitraum]
In diesen Zyklen werden Abschläge gestellt. Alternativ kann auch die Anzahl in den Konditionen angeben werden.
bo4e.com.vertragsteil module
Contains Vertragsteil class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.vertragsteil.Vertragsteil(*, vertragsteilbeginn: datetime, vertragsteilende: datetime, lokation: Optional[str] = None, vertraglichFixierteMenge: Optional[Menge] = None, minimaleAbnahmemenge: Optional[Menge] = None, maximaleAbnahmemenge: Optional[Menge] = None)[source]
Bases:
COMAbbildung für einen Vertragsteil. Der Vertragsteil wird dazu verwendet, eine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen.
- lokation: Optional[str]
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.zaehlwerk module
Contains Zaehlwerk class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zaehlwerk.Zaehlwerk(*, zaehlwerkId: str, bezeichnung: str, richtung: Energierichtung, obisKennzahl: ConstrainedStrValue, wandlerfaktor: Decimal, einheit: Mengeneinheit)[source]
Bases:
COMMit dieser Komponente werden Zählwerke modelliert.
- einheit: Mengeneinheit
- obis_kennzahl: ConstrainedStrValue
- richtung: Energierichtung
bo4e.com.zeitintervall module
Contains Zeitintervall class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zeitintervall.Zeitintervall(*, wert: int, zeiteinheit: Zeiteinheit)[source]
Bases:
COMAbbildung für ein Zeitintervall. Die Abbildung eines Zeitintervalls. Z.B. zur Anwendung als Raster in äquidistanten Zeitreihen/Lastgängen, beispielsweise 15 Minuten.
- zeiteinheit: Zeiteinheit
Die Einheit des Zeitintervalls
bo4e.com.zeitraum module
Contains Zeitraum class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zeitraum.Zeitraum(*, einheit: Optional[Zeiteinheit] = None, dauer: Optional[Decimal] = None, startdatum: Optional[datetime] = None, enddatum: Optional[datetime] = None, startzeitpunkt: Optional[datetime] = None, endzeitpunkt: Optional[datetime] = None)[source]
Bases:
COMDiese 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
- einheit: Optional[Zeiteinheit]
bo4e.com.zeitreihenwert module
Contains Zeitreihenwert class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zeitreihenwert.Zeitreihenwert(*, wert: Decimal, status: Optional[Messwertstatus] = None, statuszusatz: Optional[Messwertstatuszusatz] = None, datumUhrzeitVon: datetime, datumUhrzeitBis: datetime)[source]
Bases:
ZeitreihenwertkompaktAbbildung eines Zeitreihenwertes bestehend aus Zeitraum, Wert und Statusinformationen.
bo4e.com.zeitreihenwertkompakt module
Contains Zeitreihenwertkompakt class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zeitreihenwertkompakt.Zeitreihenwertkompakt(*, wert: Decimal, status: Optional[Messwertstatus] = None, statuszusatz: Optional[Messwertstatuszusatz] = None)[source]
Bases:
COMAbbildung eines kompakten Zeitreihenwertes in dem ausschliesslich der Wert und Statusinformationen stehen.
- status: Optional[Messwertstatus]
Der Status gibt an, wie der Wert zu interpretieren ist, z.B. in Berechnungen.
- statuszusatz: Optional[Messwertstatuszusatz]
Eine Zusatzinformation zum Status, beispielsweise ein Grund für einen fehlenden Wert.
bo4e.com.zustaendigkeit module
Contains Zustaendigkeit class and corresponding marshmallow schema for de-/serialization
- class bo4e.com.zustaendigkeit.Zustaendigkeit(*, themengebiet: Themengebiet, jobtitel: Optional[str] = None, abteilung: Optional[str] = None)[source]
Bases:
COMEnthält die zeitliche Zuordnung eines Ansprechpartners zu Abteilungen und Zuständigkeiten.
- themengebiet: Themengebiet
Hier kann eine thematische Zuordnung des Ansprechpartners angegeben werden