bo4e.bo package
Submodules
bo4e.bo.angebot module
Contains Angebot class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.angebot.Angebot(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.ANGEBOT] = Typ.ANGEBOT, angebotsnummer: str | None = None, angebotsdatum: AwareDatetime | None = None, sparte: Sparte | None = None, angebotsgeber: Geschaeftspartner | None = None, angebotsnehmer: Geschaeftspartner | None = None, varianten: list[Angebotsvariante] | None = None, anfragereferenz: str | None = None, bindefrist: AwareDatetime | None = None, unterzeichnerAngebotsnehmer: Person | None = None, unterzeichnerAngebotsgeber: Person | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektMit diesem BO kann ein Versorgungsangebot zur Strom- oder Gasversorgung oder die Teilnahme an einer Ausschreibung übertragen werden. Es können verschiedene Varianten enthalten sein (z.B. ein- und mehrjährige Laufzeit). Innerhalb jeder Variante können Teile enthalten sein, die jeweils für eine oder mehrere Marktlokationen erstellt werden.
Hint
- anfragereferenz: str | None
Referenz auf eine Anfrage oder Ausschreibung; Kann dem Empfänger des Angebotes bei Zuordnung des Angebotes zur Anfrage bzw. Ausschreibung helfen.
- angebotsgeber: Geschaeftspartner | None
Ersteller des Angebots
- angebotsnehmer: Geschaeftspartner | None
Empfänger des Angebots
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.ANGEBOT], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- unterzeichner_angebotsgeber: Person | None
Person, die als Angebotsgeber das Angebots ausgestellt hat
- unterzeichner_angebotsnehmer: Person | None
Person, die als Angebotsnehmer das Angebot angenommen hat
- varianten: list[Angebotsvariante] | None
Eine oder mehrere Varianten des Angebots mit den Angebotsteilen; Ein Angebot besteht mindestens aus einer Variante.
bo4e.bo.ausschreibung module
Contains Ausschreibung class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.ausschreibung.Ausschreibung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.AUSSCHREIBUNG] = Typ.AUSSCHREIBUNG, ausschreibungsnummer: str | None = None, ausschreibungstyp: Ausschreibungstyp | None = None, ausschreibungsstatus: Ausschreibungsstatus | None = None, istKostenpflichtig: bool | None = None, veroeffentlichungszeitpunkt: AwareDatetime | None = None, ausschreibender: Geschaeftspartner | None = None, abgabefrist: Zeitraum | None = None, bindefrist: Zeitraum | None = None, lose: list[Ausschreibungslos] | None = None, ausschreibungportal: Ausschreibungsportal | None = None, webseite: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektDas BO Ausschreibung dient zur detaillierten Darstellung von ausgeschriebenen Energiemengen in der Energiewirtschaft
- abgabefrist: Zeitraum | None
Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet. Es muss daher entweder eine Dauer oder ein Zeitraum in Form von Start und Ende angegeben sein
- ausschreibender: Geschaeftspartner | None
Mit diesem Objekt können Geschäftspartner übertragen werden. Sowohl Unternehmen, als auch Privatpersonen können Geschäftspartner sein
- ausschreibungportal: Ausschreibungsportal | None
Aufzählung der unterstützten Ausschreibungsportale
- ausschreibungsstatus: Ausschreibungsstatus | None
Bezeichnungen für die Ausschreibungsphasen
- ausschreibungstyp: Ausschreibungstyp | None
Aufzählung für die Typisierung von Ausschreibungen
- bindefrist: Zeitraum | None
Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet. Es muss daher entweder eine Dauer oder ein Zeitraum in Form von Start und Ende angegeben sein
- lose: list[Ausschreibungslos] | None
Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.AUSSCHREIBUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
bo4e.bo.buendelvertrag module
Contains Buendelvertrag class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.buendelvertrag.Buendelvertrag(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.BUENDELVERTRAG] = Typ.BUENDELVERTRAG, vertragsnummer: str | None = None, vertragsart: Vertragsart | None = None, vertragsstatus: Vertragsstatus | None = None, sparte: Sparte | None = None, vertragsbeginn: AwareDatetime | None = None, vertragsende: AwareDatetime | None = None, vertragspartner1: Geschaeftspartner | None = None, vertragspartner2: Geschaeftspartner | None = None, einzelvertraege: list[Vertrag] | None = None, vertragskonditionen: list[Vertragskonditionen] | None = None, unterzeichnervp1: list[Unterschrift] | None = None, unterzeichnervp2: list[Unterschrift] | None = None, beschreibung: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektAbbildung eines Bündelvertrags. Es handelt sich hierbei um eine Liste von Einzelverträgen, die in einem Vertragsobjekt gebündelt sind.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.BUENDELVERTRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- unterzeichnervp1: list[Unterschrift] | None
Unterzeichner des Vertragspartners1
- unterzeichnervp2: list[Unterschrift] | None
Unterzeichner des Vertragspartners2
- vertragsart: Vertragsart | None
Hier ist festgelegt, um welche Art von Vertrag es sich handelt. Z.B. Netznutzungvertrag
- vertragsende: AwareDatetime | None
Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)
- vertragskonditionen: list[Vertragskonditionen] | None
Festlegungen zu Laufzeiten und Kündigungsfristen
- vertragspartner1: Geschaeftspartner | None
Der “erstgenannte” Vertragspartner. In der Regel der Aussteller des Vertrags. Beispiel: “Vertrag zwischen Vertagspartner 1 …”
- vertragspartner2: Geschaeftspartner | None
Der “zweitgenannte” Vertragspartner. In der Regel der Empfänger des Vertrags. Beispiel “Vertrag zwischen Vertagspartner 1 und Vertragspartner 2”
- vertragsstatus: Vertragsstatus | None
Gibt den Status des Vertrages an
bo4e.bo.energiemenge module
Contains Energiemenge class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.energiemenge.Energiemenge(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.ENERGIEMENGE] = Typ.ENERGIEMENGE, lokationsId: str | None = None, lokationstyp: Lokationstyp | None = None, energieverbrauch: list[Verbrauch] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektAbbildung von Mengen, die Lokationen zugeordnet sind
- lokations_id: str | None
Eindeutige Nummer der Marktlokation bzw. der Messlokation, zu der die Energiemenge gehört
- lokationstyp: Lokationstyp | None
Gibt an, ob es sich um eine Markt- oder Messlokation handelt
bo4e.bo.fremdkosten module
Contains Fremdkosten class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.fremdkosten.Fremdkosten(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.FREMDKOSTEN] = Typ.FREMDKOSTEN, gueltigkeit: Zeitraum | None = None, summeKosten: Betrag | None = None, kostenbloecke: list[Fremdkostenblock] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektMit diesem BO werden die Fremdkosten, beispielsweise für eine Angebotserstellung oder eine Rechnungsprüfung, übertragen. Die Fremdkosten enthalten dabei alle Kostenblöcke, die von anderen Marktteilnehmern oder Instanzen erhoben werden.
- kostenbloecke: list[Fremdkostenblock] | None
Netzkosten, Umlagen, Steuern etc
- Type:
In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele
bo4e.bo.geraet module
Contains Geraet class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.geraet.Geraet(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.GERAET] = Typ.GERAET, geraetenummer: str | None = None, bezeichnung: str | None = None, geraeteklasse: Geraeteklasse | None = None, geraetetyp: Geraetetyp | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektMit diesem BO werden alle Geräte modelliert, die keine Zähler sind.
Hint
- geraeteklasse: Geraeteklasse | None
Die übergreifende Klasse eines Geräts, beispielsweise Wandler
- geraetetyp: Geraetetyp | None
Der speziellere Typ eines Gerätes, beispielsweise Stromwandler
bo4e.bo.geschaeftsobjekt module
- class bo4e.bo.geschaeftsobjekt.Geschaeftsobjekt(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, **extra_data: Any)[source]
Bases:
BaseModelDas BO Geschäftsobjekt ist der Master für alle Geschäftsobjekte. Alle Attribute, die hier in diesem BO enthalten sind, werden an alle BOs vererbt.
- 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.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- version: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='_version', alias_priority=2)]
Version der BO-Struktur aka “fachliche Versionierung”
- zusatz_attribute: list[ZusatzAttribut] | None
bo4e.bo.geschaeftspartner module
Contains Geschaeftspartner class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.geschaeftspartner.Geschaeftspartner(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.GESCHAEFTSPARTNER] = Typ.GESCHAEFTSPARTNER, anrede: Anrede | None = None, individuelleAnrede: str | None = None, titel: Titel | None = None, vorname: str | None = None, nachname: str | None = None, ansprechpartner: list[Person] | None = None, organisationstyp: Organisationstyp | None = None, organisationsname: str | None = None, kontaktwege: list[Kontaktweg] | None = None, geschaeftspartnerrollen: list[Geschaeftspartnerrolle] | None = None, handelsregisternummer: str | None = None, amtsgericht: str | None = None, umsatzsteuerId: str | None = None, glaeubigerId: str | None = None, website: str | None = None, adresse: Adresse | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektMit diesem Objekt können Geschäftspartner übertragen werden. Sowohl Unternehmen, als auch Privatpersonen können Geschäftspartner sein. Hinweis: “Marktteilnehmer” haben ein eigenes BO, welches sich von diesem BO ableitet. Hier sollte daher keine Zuordnung zu Marktrollen erfolgen.
- amtsgericht: str | None
Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat
- geschaeftspartnerrollen: list[Geschaeftspartnerrolle] | None
Rollen, die die Geschäftspartner inne haben (z.B. Interessent, Kunde)
- glaeubiger_id: str | None
Die Gläubiger-ID welche im Zahlungsverkehr verwendet wird; Z.B. “DE 47116789”
- individuelle_anrede: str | None
Im Falle einer nicht standardisierten Anrede kann hier eine frei definierbare Anrede vorgegeben werden. Beispiel: “Vereinsgemeinschaft”, “Pfarrer”, “Hochwürdigster Herr Abt”.
- kontaktwege: list[Kontaktweg] | None
Kontaktwege des Geschäftspartners
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- organisationstyp: Organisationstyp | None
Kennzeichnung ob es sich um ein Gewerbe/Unternehmen, eine Privatperson oder eine andere Art von Organisation handelt.
bo4e.bo.kosten module
Contains Kosten class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.kosten.Kosten(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.KOSTEN] = Typ.KOSTEN, kostenklasse: Kostenklasse | None = None, gueltigkeit: Zeitraum | None = None, kostenbloecke: list[Kostenblock] | None = None, summeKosten: list[Betrag] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektDieses BO wird zur Übertagung von hierarchischen Kostenstrukturen verwendet. Die Kosten werden dabei in Kostenblöcke und diese wiederum in Kostenpositionen strukturiert.
Hint
- kostenbloecke: list[Kostenblock] | None
Netzkosten, Umlagen, Steuern etc
- Type:
In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele
- kostenklasse: Kostenklasse | None
Klasse der Kosten, beispielsweise Fremdkosten
bo4e.bo.lastgang module
Contains Lastgang class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.lastgang.Lastgang(*, version: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.LASTGANG] = Typ.LASTGANG, sparte: Sparte | None = None, messgroesse: Mengeneinheit | None = None, marktlokation: Marktlokation | None = None, messlokation: Messlokation | None = None, werte: list[Zeitreihenwert] | None = None, obisKennzahl: str | None = None, zeitIntervallLaenge: Menge | None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModell zur Abbildung eines Lastganges; In diesem Modell werden die Messwerte mit einem vollständigen Zeitintervall (zeit_intervall_laenge) angegeben und es bietet daher eine hohe Flexibilität in der Übertragung jeglicher zeitlich veränderlicher Messgrössen.
Hint
- marktlokation: Marktlokation | None
Marktlokation, zu der der Lastgang gehört
- messgroesse: Mengeneinheit | None
Definition der gemessenen Größe anhand ihrer Einheit
- messlokation: Messlokation | None
Marktlokation, zu der der Lastgang gehört
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- obis_kennzahl: str | None
1.8.1’
- Type:
Die OBIS-Kennzahl für den Wert, die festlegt, welche Größe mit dem Stand gemeldet wird, z.B. ‘1-0
- typ: Annotated[Literal[Typ.LASTGANG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- werte: list[Zeitreihenwert] | None
Die im Lastgang enthaltenen Messwerte
bo4e.bo.lokationszuordnung module
Contains Lokationszuordnung class
- class bo4e.bo.lokationszuordnung.Lokationszuordnung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.LOKATIONSZUORDNUNG] = Typ.LOKATIONSZUORDNUNG, marktlokationen: list[Marktlokation] | None = None, messlokationen: list[Messlokation] | None = None, netzlokationen: list[Netzlokation] | None = None, technischeRessourcen: list[TechnischeRessource] | None = None, steuerbareRessourcen: list[SteuerbareRessource] | None = None, gueltigkeit: Zeitspanne | None = None, zuordnungstyp: str | None = None, lokationsbuendelcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModell für die Abbildung der Referenz auf die Lokationsbündelstruktur. Diese gibt an welche Marktlokationen, Messlokationen, Netzlokationen, technische/steuerbaren Ressourcen an einer Lokation vorhanden sind.
- gueltigkeit: Zeitspanne | None
Zeitspanne der Gültigkeit
- lokationsbuendelcode: str | None
//www.edi-energy.de/index.php?id=38)
- Type:
Code, der angibt wie die Lokationsbündelstruktur zusammengesetzt ist (zu finden unter “Codeliste der Lokationsbündelstrukturen” auf https
- marktlokationen: list[Marktlokation] | None
Liste mit referenzierten Marktlokationen
- messlokationen: list[Messlokation] | None
Liste mit referenzierten Messlokationen
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- netzlokationen: list[Netzlokation] | None
Liste mit referenzierten Netzlokationen
- steuerbare_ressourcen: list[SteuerbareRessource] | None
Liste mit referenzierten steuerbaren Ressourcen
- technische_ressourcen: list[TechnischeRessource] | None
Liste mit referenzierten technischen Ressourcen
bo4e.bo.marktlokation module
Contains Marktlokation class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.marktlokation.Marktlokation(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.MARKTLOKATION] = Typ.MARKTLOKATION, marktlokationsId: str | None = None, sparte: Sparte | None = None, energierichtung: Energierichtung | None = None, bilanzierungsmethode: Bilanzierungsmethode | None = None, netzebene: Netzebene | None = None, verbrauchsart: Verbrauchsart | None = None, istUnterbrechbar: bool | None = None, netzbetreibercodenr: str | None = None, gebietstyp: Gebiettyp | None = None, netzgebietsnr: str | None = None, bilanzierungsgebiet: str | None = None, grundversorgercodenr: str | None = None, gasqualitaet: Gasqualitaet | None = None, endkunde: Geschaeftspartner | None = None, lokationsadresse: Adresse | None = None, geoadresse: Geokoordinaten | None = None, katasterinformation: Katasteradresse | None = None, kundengruppen: list[Kundentyp] | None = None, regelzone: str | None = None, marktgebiet: str | None = None, zaehlwerke: list[Zaehlwerk] | None = None, verbrauchsmengen: list[Verbrauch] | None = None, zaehlwerkeDerBeteiligtenMarktrolle: list[Zaehlwerk] | None = None, lokationszuordnungen: list[Lokationszuordnung] | None = None, lokationsbuendelObjektcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a Marktlokation
- bilanzierungsgebiet: str | None
Bilanzierungsgebiet, dem das Netzgebiet zugeordnet ist - im Falle eines Strom Netzes
- bilanzierungsmethode: Bilanzierungsmethode | None
Die Bilanzierungsmethode, RLM oder SLP
- endkunde: Geschaeftspartner | None
Geschäftspartner, dem diese Marktlokation gehört
- energierichtung: Energierichtung | None
Kennzeichnung, ob Energie eingespeist oder entnommen (ausgespeist) wird
- gasqualitaet: Gasqualitaet | None
Die Gasqualität in diesem Netzgebiet. H-Gas oder L-Gas. Im Falle eines Gas-Netzes
- geoadresse: Geokoordinaten | None
Alternativ zu einer postalischen Adresse kann hier ein Ort mittels Geokoordinaten angegeben werden (z.B. zur Identifikation von Sendemasten).
- grundversorgercodenr: str | None
Codenummer des Grundversorgers, der für diese Marktlokation zuständig ist
- katasterinformation: Katasteradresse | None
Alternativ zu einer postalischen Adresse und Geokoordinaten kann hier eine Ortsangabe mittels Gemarkung und Flurstück erfolgen.
- lokationsadresse: Adresse | None
Die Adresse, an der die Energie-Lieferung oder -Einspeisung erfolgt
- lokationsbuendel_objektcode: str | None
Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.
- lokationszuordnungen: list[Lokationszuordnung] | None
Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben
- marktgebiet: str | None
//www.entsog.eu/data/data-portal/codes-list
- Type:
für Gas. Code vom EIC, https
- marktlokations_id: str | None
Identifikationsnummer einer Marktlokation, an der Energie entweder verbraucht, oder erzeugt wird.
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- netzbetreibercodenr: str | None
Codenummer des Netzbetreibers, an dessen Netz diese Marktlokation angeschlossen ist.
- netzebene: Netzebene | None
Netzebene, in der der Bezug der Energie erfolgt. Bei Strom Spannungsebene der Lieferung, bei Gas Druckstufe. Beispiel Strom: Niederspannung Beispiel Gas: Niederdruck.
- regelzone: str | None
//www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/
- Type:
für Strom. Code vom EIC, https
- typ: Annotated[Literal[Typ.MARKTLOKATION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- verbrauchsart: Verbrauchsart | None
Verbrauchsart der Marktlokation.
bo4e.bo.marktteilnehmer module
Contains Marktteilnehmer class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.marktteilnehmer.Marktteilnehmer(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.MARKTTEILNEHMER] = Typ.MARKTTEILNEHMER, marktrolle: Marktrolle | None = None, rollencodenummer: str | None = None, rollencodetyp: Rollencodetyp | None = None, sparte: Sparte | None = None, makoadresse: list[str] | None = None, geschaeftspartner: Geschaeftspartner | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObjekt zur Aufnahme der Information zu einem Marktteilnehmer
- geschaeftspartner: Geschaeftspartner | None
Der zu diesem Marktteilnehmer gehörende Geschäftspartner
- makoadresse: list[str] | None
1-Kommunikationsadresse des Marktteilnehmers. Diese wird in der Marktkommunikation verwendet. Konkret kann dies eine eMail-Adresse oder ein AS4-Endpunkt sein.
- Type:
Die 1
- marktrolle: Marktrolle | None
Gibt im Klartext die Bezeichnung der Marktrolle an
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- rollencodetyp: Rollencodetyp | None
Gibt den Typ des Codes an
bo4e.bo.messlokation module
Contains Messlokation class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.messlokation.Messlokation(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.MESSLOKATION] = Typ.MESSLOKATION, messlokationsId: str | None = None, sparte: Sparte | None = None, netzebeneMessung: Netzebene | None = None, messgebietnr: str | None = None, geraete: list[Geraet] | None = None, messdienstleistung: list[Dienstleistung] | None = None, messlokationszaehler: list[Zaehler] | None = None, grundzustaendigerMsbCodenr: str | None = None, grundzustaendigerMsbimCodenr: str | None = None, messadresse: Adresse | None = None, geoadresse: Geokoordinaten | None = None, katasterinformation: Katasteradresse | None = None, lokationszuordnungen: list[Lokationszuordnung] | None = None, lokationsbuendelObjektcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a Messlokation
- geoadresse: Geokoordinaten | None
Alternativ zu einer postalischen Adresse kann hier ein Ort mittels Geokoordinaten angegeben werden (z.B. zur Identifikation von Sendemasten).
- grundzustaendiger_msb_codenr: str | None
Codenummer des grundzuständigen Messstellenbetreibers, der für diese Messlokation zuständig ist. (Dieser ist immer dann Messstellenbetreiber, wenn kein anderer MSB die Einrichtungen an der Messlokation betreibt.)
- grundzustaendiger_msbim_codenr: str | None
Codenummer des grundzuständigen Messstellenbetreibers für intelligente Messsysteme, der für diese Messlokation zuständig ist. (Dieser ist immer dann Messstellenbetreiber, wenn kein anderer MSB die Einrichtungen an der Messlokation betreibt.)
- katasterinformation: Katasteradresse | None
Alternativ zu einer postalischen Adresse und Geokoordinaten kann hier eine Ortsangabe mittels Gemarkung und Flurstück erfolgen.
- lokationsbuendel_objektcode: str | None
Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.
- lokationszuordnungen: list[Lokationszuordnung] | None
Lokationszuordnung, um bspw. die zugehörigen Marktlokationen anzugeben
- messadresse: Adresse | None
Die Adresse, an der die Messeinrichtungen zu finden sind. (Nur angeben, wenn diese von der Adresse der Marktlokation abweicht.)
- messdienstleistung: list[Dienstleistung] | None
Liste der Messdienstleistungen, die zu dieser Messstelle gehört
- messlokations_id: str | None
Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung
bo4e.bo.netzlokation module
Contains Netzlokation class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.netzlokation.Netzlokation(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.NETZLOKATION] = Typ.NETZLOKATION, netzlokationsId: str | None = None, sparte: Sparte | None = None, netzanschlussleistung: Menge | None = None, grundzustaendigerMsbCodenr: str | None = None, steuerkanal: bool | None = None, obiskennzahl: str | None = None, verwendungszweck: VerwendungszweckProMarktrolle | None = None, konfigurationsprodukte: list[Konfigurationsprodukt] | None = None, eigenschaftMsbLokation: Marktrolle | None = None, lokationszuordnungen: list[Lokationszuordnung] | None = None, lokationsbuendelObjektcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a Netzlokation
- eigenschaft_msb_lokation: Marktrolle | None
Eigenschaft des Messstellenbetreibers an der Lokation
- grundzustaendiger_msb_codenr: str | None
Codenummer des grundzuständigen Messstellenbetreibers, der für diese Netzlokation zuständig ist.
- konfigurationsprodukte: list[Konfigurationsprodukt] | None
Produkt-Daten der Netzlokation
- lokationsbuendel_objektcode: str | None
Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.
- lokationszuordnungen: list[Lokationszuordnung] | None
Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- netzlokations_id: str | None
Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird
- steuerkanal: bool | None
Ob ein Steuerkanal der Netzlokation zugeordnet ist und somit die Netzlokation gesteuert werden kann.
- typ: Annotated[Literal[Typ.NETZLOKATION], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- verwendungszweck: VerwendungszweckProMarktrolle | None
Verwendungungszweck der Werte Netzlokation
bo4e.bo.person module
Contains Person class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.person.Person(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PERSON] = Typ.PERSON, anrede: Anrede | None = None, individuelleAnrede: str | None = None, titel: Titel | None = None, vorname: str | None = None, nachname: str | None = None, kontaktwege: list[Kontaktweg] | None = None, geburtsdatum: AwareDatetime | None = None, kommentar: str | None = None, zustaendigkeiten: list[Zustaendigkeit] | None = None, adresse: Adresse | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a Person
Hint
- adresse: Adresse | None
Adresse der Person, falls diese von der Adresse des Geschäftspartners abweicht
- individuelle_anrede: str | None
Im Falle einer nicht standardisierten Anrede kann hier eine frei definierbare Anrede vorgegeben werden. Beispiel: “Vereinsgemeinschaft”, “Pfarrer”, “Hochwürdigster Herr Abt”.
- kontaktwege: list[Kontaktweg] | None
Kontaktwege der Person
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.PERSON], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zustaendigkeiten: list[Zustaendigkeit] | None
Liste der Abteilungen und Zuständigkeiten der Person
bo4e.bo.preisblatt module
Contains Preisblatt class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblatt.Preisblatt(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATT] = Typ.PREISBLATT, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektDas allgemeine Modell zur Abbildung von Preisen; Davon abgeleitet können, über die Zuordnung identifizierender Merkmale, spezielle Preisblatt-Varianten modelliert werden.
Die jeweiligen Sätze von Merkmalen sind in der Grafik ergänzt worden und stellen jeweils eine Ausprägung für die verschiedenen Anwendungsfälle der Preisblätter dar.
- herausgeber: Marktteilnehmer | None
Der Netzbetreiber, der die Preise veröffentlicht hat
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- preispositionen: list[Preisposition] | None
Die einzelnen Positionen, die mit dem Preisblatt abgerechnet werden können. Z.B. Arbeitspreis, Grundpreis etc
- preisstatus: Preisstatus | None
Merkmal, das anzeigt, ob es sich um vorläufige oder endgültige Preise handelt
bo4e.bo.preisblattdienstleistung module
Contains PreisblattDienstleistung class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblattdienstleistung.PreisblattDienstleistung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATTDIENSTLEISTUNG] = Typ.PREISBLATTDIENSTLEISTUNG, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, bilanzierungsmethode: Bilanzierungsmethode | None = None, basisdienstleistung: Dienstleistungstyp | None = None, geraetedetails: Geraet | None = None, inklusiveDienstleistungen: list[Dienstleistungstyp] | None = None, **extra_data: Any)[source]
Bases:
PreisblattVariante des Preisblattmodells zur Abbildung der Preise für wahlfreie Dienstleistungen
- basisdienstleistung: Dienstleistungstyp | None
Dienstleistung, für die der Preis abgebildet wird, z.B. Sperrung/Entsperrung
- bilanzierungsmethode: Bilanzierungsmethode | None
Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode
- geraetedetails: Geraet | None
Hier kann der Preis auf bestimmte Geräte eingegrenzt werden. Z.B. auf die Zählergröße
- inklusive_dienstleistungen: list[Dienstleistungstyp] | None
Weitere Dienstleistungen, die im Preis enthalten sind
bo4e.bo.preisblatthardware module
Contains PreisblattHardware class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblatthardware.PreisblattHardware(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATTHARDWARE] = Typ.PREISBLATTHARDWARE, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, bilanzierungsmethode: Bilanzierungsmethode | None = None, messebene: Netzebene | None = None, basisgeraet: Geraet | None = None, inklusiveDienstleistungen: list[Dienstleistungstyp] | None = None, inklusiveGeraete: list[Geraet] | None = None, **extra_data: Any)[source]
Bases:
PreisblattVariante des Preisblattmodells zur Abbildung der Preise für zusätzliche Hardware
- bilanzierungsmethode: Bilanzierungsmethode | None
Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode
- inklusive_dienstleistungen: list[Dienstleistungstyp] | None
Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung
- inklusive_geraete: list[Geraet] | None
Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler
bo4e.bo.preisblattkonzessionsabgabe module
Contains PreisblattKonzessionsabgabe class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblattkonzessionsabgabe.PreisblattKonzessionsabgabe(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATTKONZESSIONSABGABE] = Typ.PREISBLATTKONZESSIONSABGABE, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, kundengruppeKA: KundengruppeKA | None = None, **extra_data: Any)[source]
Bases:
PreisblattDie Variante des Preisblattmodells zur Abbildung von allgemeinen Abgaben
- kundengruppe_k_a: KundengruppeKA | None
Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist
bo4e.bo.preisblattmessung module
Contains PreisblattMessung class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblattmessung.PreisblattMessung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATTMESSUNG] = Typ.PREISBLATTMESSUNG, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, bilanzierungsmethode: Bilanzierungsmethode | None = None, messebene: Netzebene | None = None, zaehler: Zaehler | None = None, inklusiveDienstleistungen: list[Dienstleistungstyp] | None = None, inklusiveGeraete: list[Geraet] | None = None, **extra_data: Any)[source]
Bases:
PreisblattVariante des Preisblattmodells zur Abbildung der Preise des Messstellenbetriebs und damit verbundener Leistungen
- bilanzierungsmethode: Bilanzierungsmethode | None
Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode
- inklusive_dienstleistungen: list[Dienstleistungstyp] | None
Im Preis sind die hier angegebenen Dienstleistungen enthalten, z.B. Jährliche Ablesung
- inklusive_geraete: list[Geraet] | None
Im Preis sind die hier angegebenen Geräte mit enthalten, z.B. ein Wandler
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
bo4e.bo.preisblattnetznutzung module
Contains PreisblattNetnutzung class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.preisblattnetznutzung.PreisblattNetznutzung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.PREISBLATTNETZNUTZUNG] = Typ.PREISBLATTNETZNUTZUNG, bezeichnung: str | None = None, sparte: Sparte | None = None, preisstatus: Preisstatus | None = None, gueltigkeit: Zeitraum | None = None, preispositionen: list[Preisposition] | None = None, herausgeber: Marktteilnehmer | None = None, bilanzierungsmethode: Bilanzierungsmethode | None = None, netzebene: Netzebene | None = None, kundengruppe: Kundengruppe | None = None, **extra_data: Any)[source]
Bases:
PreisblattDie Variante des Preisblattmodells zur Abbildung der Netznutzungspreise
- bilanzierungsmethode: Bilanzierungsmethode | None
Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode
- kundengruppe: Kundengruppe | None
bo4e.bo.rechnung module
Contains Rechnung class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.rechnung.Rechnung(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.RECHNUNG] = Typ.RECHNUNG, istStorno: bool | None = None, rechnungsnummer: str | None = None, rechnungsdatum: AwareDatetime | None = None, faelligkeitsdatum: AwareDatetime | None = None, rechnungstyp: Rechnungstyp | None = None, rechnungsperiode: Zeitraum | None = None, rechnungsersteller: Geschaeftspartner | None = None, rechnungsempfaenger: Geschaeftspartner | None = None, gesamtnetto: Betrag | None = None, gesamtsteuer: Betrag | None = None, gesamtbrutto: Betrag | None = None, zuZahlen: Betrag | None = None, rechnungspositionen: list[Rechnungsposition] | None = None, rechnungstitel: str | None = None, rechnungsstatus: Rechnungsstatus | None = None, originalRechnungsnummer: str | None = None, vorausgezahlt: Betrag | None = None, rabattBrutto: Betrag | None = None, steuerbetraege: list[Steuerbetrag] | None = None, sparte: Sparte | None = None, netznutzungrechnungsart: NetznutzungRechnungsart | None = None, netznutzungrechnungstyp: NetznutzungRechnungstyp | None = None, istOriginal: bool | None = None, istSimuliert: bool | None = None, marktlokation: Marktlokation | None = None, messlokation: Messlokation | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModell für die Abbildung von Rechnungen und Netznutzungsrechnungen im Kontext der Energiewirtschaft;
Hint
- ist_original: bool | None
Kennzeichen, ob es sich um ein Original (true) oder eine Kopie handelt (false)
- ist_simuliert: bool | None
Kennzeichen, ob es sich um eine simulierte Rechnung, z.B. zur Rechnungsprüfung handelt
- ist_storno: bool | None
Kennzeichnung, ob es sich um eine Stornorechnung handelt; im Falle “true” findet sich im Attribut “originalrechnungsnummer” die Nummer der Originalrechnung.
- marktlokation: Marktlokation | None
Marktlokation, auf die sich die Rechnung bezieht
- messlokation: Messlokation | None
Messlokation, auf die sich die Rechnung bezieht
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- netznutzungrechnungsart: NetznutzungRechnungsart | None
Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt
- netznutzungrechnungstyp: NetznutzungRechnungstyp | None
Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt
- original_rechnungsnummer: str | None
Im Falle einer Stornorechnung (storno = true) steht hier die Rechnungsnummer der stornierten Rechnung
- rechnungsempfaenger: Geschaeftspartner | None
Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer
- rechnungsersteller: Geschaeftspartner | None
Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer
- rechnungspositionen: list[Rechnungsposition] | None
Die Rechnungspositionen
- rechnungsstatus: Rechnungsstatus | None
Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes
- rechnungstyp: Rechnungstyp | None
Ein kontextbezogender Rechnungstyp, z.B. Netznutzungsrechnung
- steuerbetraege: list[Steuerbetrag] | None
Eine Liste mit Steuerbeträgen pro Steuerkennzeichen/Steuersatz; die Summe dieser Beträge ergibt den Wert für gesamtsteuer.
- typ: Annotated[Literal[Typ.RECHNUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
bo4e.bo.region module
Contains Region class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.region.Region(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.REGION] = Typ.REGION, bezeichnung: str | None = None, positivListe: list[Regionskriterium] | None = None, negativListe: list[Regionskriterium] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModellierung einer Region als Menge von Kriterien, die eine Region beschreiben
Hint
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- negativ_liste: list[Regionskriterium] | None
Negativliste der Kriterien zur Definition der Region
- positiv_liste: list[Regionskriterium] | None
Positivliste der Kriterien zur Definition der Region
bo4e.bo.regionaltarif module
Contains Regionaltarif class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.regionaltarif.Regionaltarif(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.REGIONALTARIF] = Typ.REGIONALTARIF, bezeichnung: str | None = None, anbietername: str | None = None, sparte: Sparte | None = None, kundentypen: list[Kundentyp] | None = None, registeranzahl: Registeranzahl | None = None, tariftyp: Tariftyp | None = None, tarifmerkmale: list[Tarifmerkmal] | None = None, anbieter: Marktteilnehmer | None = None, website: str | None = None, bemerkung: str | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, energiemix: Energiemix | None = None, vertragskonditionen: Vertragskonditionen | None = None, anwendungVon: AwareDatetime | None = None, preisstand: AwareDatetime | None = None, berechnungsparameter: Tarifberechnungsparameter | None = None, tarifpreise: list[RegionaleTarifpreisposition] | None = None, tarifAufAbschlaege: list[RegionalerAufAbschlag] | None = None, preisgarantien: list[RegionalePreisgarantie] | None = None, tarifeinschraenkung: Tarifeinschraenkung | None = None, **extra_data: Any)[source]
Bases:
TarifinfoAbbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen.
- berechnungsparameter: Tarifberechnungsparameter | None
Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- preisgarantien: list[RegionalePreisgarantie] | None
Festlegung von Garantien für bestimmte Preisanteile
- tarif_auf_abschlaege: list[RegionalerAufAbschlag] | None
Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung
- tarifeinschraenkung: Tarifeinschraenkung | None
Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann
- tarifpreise: list[RegionaleTarifpreisposition] | None
Die festgelegten Preise mit regionaler Eingrenzung, z.B. für Arbeitspreis, Grundpreis etc.
bo4e.bo.standorteigenschaften module
Contains Standorteigenschaften class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.standorteigenschaften.Standorteigenschaften(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.STANDORTEIGENSCHAFTEN] = Typ.STANDORTEIGENSCHAFTEN, eigenschaftenStrom: list[StandorteigenschaftenStrom] | None = None, eigenschaftenGas: StandorteigenschaftenGas | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModelliert die regionalen und spartenspezifischen Eigenschaften einer gegebenen Adresse.
- eigenschaften_gas: StandorteigenschaftenGas | None
Eigenschaften zur Sparte Gas
- eigenschaften_strom: list[StandorteigenschaftenStrom] | None
Eigenschaften zur Sparte Strom
bo4e.bo.steuerbareressource module
Contains steuerbare Ressource class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.steuerbareressource.SteuerbareRessource(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.STEUERBARERESSOURCE] = Typ.STEUERBARERESSOURCE, steuerbareRessourceId: str | None = None, steuerkanalLeistungsbeschreibung: SteuerkanalLeistungsbeschreibung | None = None, zugeordneteMsbCodenummer: str | None = None, konfigurationsprodukte: list[Konfigurationsprodukt] | None = None, eigenschaftMsbLokation: Marktrolle | None = None, lokationszuordnungen: list[Lokationszuordnung] | None = None, lokationsbuendelObjektcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a steuerbare Ressource
- eigenschaft_msb_lokation: Marktrolle | None
Eigenschaft des Messstellenbetreibers an der Lokation
- konfigurationsprodukte: list[Konfigurationsprodukt] | None
Produkt-Daten der Steuerbaren Ressource
- lokationsbuendel_objektcode: str | None
Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.
- lokationszuordnungen: list[Lokationszuordnung] | None
Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- steuerkanal_leistungsbeschreibung: SteuerkanalLeistungsbeschreibung | None
Leistungsbeschreibung des Steuerkanals
bo4e.bo.tarif module
Contains Tarif class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.tarif.Tarif(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.TARIF] = Typ.TARIF, bezeichnung: str | None = None, anbietername: str | None = None, sparte: Sparte | None = None, kundentypen: list[Kundentyp] | None = None, registeranzahl: Registeranzahl | None = None, tariftyp: Tariftyp | None = None, tarifmerkmale: list[Tarifmerkmal] | None = None, anbieter: Marktteilnehmer | None = None, website: str | None = None, bemerkung: str | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, energiemix: Energiemix | None = None, vertragskonditionen: Vertragskonditionen | None = None, anwendungVon: AwareDatetime | None = None, preisstand: AwareDatetime | None = None, berechnungsparameter: Tarifberechnungsparameter | None = None, tarifpreise: list[TarifpreispositionProOrt] | None = None, tarifAufAbschlaege: list[AufAbschlagRegional] | None = None, preisgarantie: Preisgarantie | None = None, tarifeinschraenkung: Tarifeinschraenkung | None = None, **extra_data: Any)[source]
Bases:
TarifinfoAbbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen
Hint
- berechnungsparameter: Tarifberechnungsparameter | None
Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- preisgarantie: Preisgarantie | None
Preisgarantie für diesen Tarif
- tarif_auf_abschlaege: list[AufAbschlagRegional] | None
Auf- und Abschläge auf die Preise oder Kosten mit regionaler Eingrenzung
- tarifeinschraenkung: Tarifeinschraenkung | None
Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann
- tarifpreise: list[TarifpreispositionProOrt] | None
Die festgelegten Preise mit regionaler Eingrenzung z.B. für Arbeitspreis, Grundpreis etc.
bo4e.bo.tarifinfo module
Contains Tarifinfo class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.tarifinfo.Tarifinfo(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.TARIFINFO] = Typ.TARIFINFO, bezeichnung: str | None = None, anbietername: str | None = None, sparte: Sparte | None = None, kundentypen: list[Kundentyp] | None = None, registeranzahl: Registeranzahl | None = None, tariftyp: Tariftyp | None = None, tarifmerkmale: list[Tarifmerkmal] | None = None, anbieter: Marktteilnehmer | None = None, website: str | None = None, bemerkung: str | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, energiemix: Energiemix | None = None, vertragskonditionen: Vertragskonditionen | None = None, anwendungVon: AwareDatetime | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektDas BO Tarifinfo liefert die Merkmale, die einen Endkundentarif identifizierbar machen. Dieses BO dient als Basis für weitere BOs mit erweiterten Anwendungsmöglichkeiten.
- anbieter: Marktteilnehmer | None
Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet
- anwendung_von: AwareDatetime | None
Angabe des inklusiven Zeitpunkts, ab dem der Tarif bzw. der Preis angewendet und abgerechnet wird, z.B. “2021-07-20T18:31:48Z”
- energiemix: Energiemix | None
Der Energiemix, der für diesen Tarif gilt
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- registeranzahl: Registeranzahl | None
Die Art des Tarifes, z.B. Eintarif oder Mehrtarif
- tarifmerkmale: list[Tarifmerkmal] | None
Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse
- typ: Annotated[Literal[Typ.TARIFINFO], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- vertragskonditionen: Vertragskonditionen | None
Mindestlaufzeiten und Kündigungsfristen zusammengefasst
bo4e.bo.tarifkosten module
Contains Tarifkosten class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.tarifkosten.Tarifkosten(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.TARIFKOSTEN] = Typ.TARIFKOSTEN, bezeichnung: str | None = None, anbietername: str | None = None, sparte: Sparte | None = None, kundentypen: list[Kundentyp] | None = None, registeranzahl: Registeranzahl | None = None, tariftyp: Tariftyp | None = None, tarifmerkmale: list[Tarifmerkmal] | None = None, anbieter: Marktteilnehmer | None = None, website: str | None = None, bemerkung: str | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, energiemix: Energiemix | None = None, vertragskonditionen: Vertragskonditionen | None = None, anwendungVon: AwareDatetime | None = None, kosten: Kosten | None = None, **extra_data: Any)[source]
Bases:
TarifinfoObjekt zur Kommunikation von Kosten, die im Rahmen der Tarifanwendung entstehen
- kosten: Kosten | None
Referenz (Link) zu einem Kostenobjekt, in dem die Kosten für die Anwendung des Tarifs auf eine Abnahmesituation berechnet wurden
bo4e.bo.tarifpreisblatt module
Contains Tarifpreisblatt class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.tarifpreisblatt.Tarifpreisblatt(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.TARIFPREISBLATT] = Typ.TARIFPREISBLATT, bezeichnung: str | None = None, anbietername: str | None = None, sparte: Sparte | None = None, kundentypen: list[Kundentyp] | None = None, registeranzahl: Registeranzahl | None = None, tariftyp: Tariftyp | None = None, tarifmerkmale: list[Tarifmerkmal] | None = None, anbieter: Marktteilnehmer | None = None, website: str | None = None, bemerkung: str | None = None, zeitlicheGueltigkeit: Zeitraum | None = None, energiemix: Energiemix | None = None, vertragskonditionen: Vertragskonditionen | None = None, anwendungVon: AwareDatetime | None = None, preisstand: AwareDatetime | None = None, tarifpreise: list[Tarifpreisposition] | None = None, berechnungsparameter: Tarifberechnungsparameter | None = None, tarifeinschraenkung: Tarifeinschraenkung | None = None, preisgarantie: Preisgarantie | None = None, tarifAufAbschlaege: list[AufAbschlag] | None = None, **extra_data: Any)[source]
Bases:
TarifinfoTarifinformation mit Preisen, Aufschlägen und Berechnungssystematik
- berechnungsparameter: Tarifberechnungsparameter | None
Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- preisgarantie: Preisgarantie | None
Festlegung von Garantien für bestimmte Preisanteile
- tarif_auf_abschlaege: list[AufAbschlag] | None
Auf- und Abschläge auf die Preise oder Kosten
- tarifeinschraenkung: Tarifeinschraenkung | None
Die Bedingungen und Einschränkungen unter denen ein Tarif angewendet werden kann
- tarifpreise: list[Tarifpreisposition] | None
Die festgelegten Preise, z.B. für Arbeitspreis, Grundpreis etc.
bo4e.bo.technischeressource module
Contains technische Ressource class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.technischeressource.TechnischeRessource(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.TECHNISCHERESSOURCE] = Typ.TECHNISCHERESSOURCE, technischeRessourceId: str | None = None, vorgelagerteMesslokationId: str | None = None, zugeordneteMarktlokationId: str | None = None, zugeordneteSteuerbareRessourceId: str | None = None, nennleistungaufnahme: Menge | None = None, nennleistungabgabe: Menge | None = None, speicherkapazitaet: Menge | None = None, technischeRessourceNutzung: TechnischeRessourceNutzung | None = None, technischeRessourceVerbrauchsart: TechnischeRessourceVerbrauchsart | None = None, waermenutzung: Waermenutzung | None = None, emobilitaetsart: EMobilitaetsart | None = None, erzeugungsart: Erzeugungsart | None = None, speicherart: Speicherart | None = None, lokationszuordnungen: list[Lokationszuordnung] | None = None, lokationsbuendelObjektcode: str | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a technische Ressource
- emobilitaetsart: EMobilitaetsart | None
Art der E-Mobilität
- erzeugungsart: Erzeugungsart | None
Art der Erzeugung der Energie
- lokationsbuendel_objektcode: str | None
Lokationsbuendel Code, der die Funktion dieses BOs an der Lokationsbuendelstruktur beschreibt.
- lokationszuordnungen: list[Lokationszuordnung] | None
Lokationszuordnung, um bspw. die zugehörigen Messlokationen anzugeben
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- speicherart: Speicherart | None
Art des Speichers
- technische_ressource_nutzung: TechnischeRessourceNutzung | None
Art und Nutzung der technischen Ressource
- technische_ressource_verbrauchsart: TechnischeRessourceVerbrauchsart | None
Verbrauchsart der technischen Ressource
- typ: Annotated[Literal[Typ.TECHNISCHERESSOURCE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
Wärmenutzung
bo4e.bo.vertrag module
Contains Vertrag class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.vertrag.Vertrag(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.VERTRAG] = Typ.VERTRAG, vertragsnummer: str | None = None, vertragsart: Vertragsart | None = None, vertragsstatus: Vertragsstatus | None = None, sparte: Sparte | None = None, vertragsbeginn: AwareDatetime | None = None, vertragsende: AwareDatetime | None = None, vertragspartner1: Geschaeftspartner | None = None, vertragspartner2: Geschaeftspartner | None = None, vertragsteile: list[Vertragsteil] | None = None, beschreibung: str | None = None, vertragskonditionen: Vertragskonditionen | None = None, unterzeichnervp1: list[Unterschrift] | None = None, unterzeichnervp2: list[Unterschrift] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektModell für die Abbildung von Vertragsbeziehungen; Das Objekt dient dazu, alle Arten von Verträgen, die in der Energiewirtschaft Verwendung finden, abzubilden.
Hint
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.VERTRAG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- unterzeichnervp1: list[Unterschrift] | None
Unterzeichner des Vertragspartners 1
- unterzeichnervp2: list[Unterschrift] | None
Unterzeichner des Vertragspartners 2
- vertragsart: Vertragsart | None
Hier ist festgelegt, um welche Art von Vertrag es sich handelt.
- vertragsende: AwareDatetime | None
Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)
- vertragskonditionen: Vertragskonditionen | None
Festlegungen zu Laufzeiten und Kündigungsfristen
- vertragspartner1: Geschaeftspartner | None
Der “erstgenannte” Vertragspartner. In der Regel der Aussteller des Vertrags. Beispiel: “Vertrag zwischen Vertragspartner 1 …”
- vertragspartner2: Geschaeftspartner | None
Der “zweitgenannte” Vertragspartner. In der Regel der Empfänger des Vertrags. Beispiel “Vertrag zwischen Vertragspartner 1 und Vertragspartner 2”.
- vertragsstatus: Vertragsstatus | None
Gibt den Status des Vertrags an
- vertragsteile: list[Vertragsteil] | None
Der Vertragsteil wird dazu verwendet, eine vertragliche Leistung in Bezug zu einer Lokation (Markt- oder Messlokation) festzulegen.
bo4e.bo.zaehler module
Contains Zaehler class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.zaehler.Zaehler(*, _version: str | None = '202401.4.1.dev50+g7314aa9f', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.ZAEHLER] = Typ.ZAEHLER, zaehlernummer: str | None = None, sparte: Sparte | None = None, zaehlerauspraegung: Zaehlerauspraegung | None = None, zaehlertyp: Zaehlertyp | None = None, zaehlwerke: list[Zaehlwerk] | None = None, registeranzahl: Registeranzahl | None = None, zaehlerkonstante: Decimal | None = None, eichungBis: AwareDatetime | None = None, letzteEichung: AwareDatetime | None = None, zaehlerhersteller: Geschaeftspartner | None = None, istFernschaltbar: bool | None = None, messwerterfassung: Messwerterfassung | None = None, zaehlertypSpezifikation: ZaehlertypSpezifikation | None = None, befestigungsart: Befestigungsart | None = None, zaehlergroesse: Zaehlergroesse | None = None, geraete: list[Geraet] | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektObject containing information about a meter/”Zaehler”.
Hint
- befestigungsart: Befestigungsart | None
Befestigungsart
- geraete: list[Geraet] | None
Liste der Geräte, die zu diesem Zähler gehören, bspw. Smartmeter-Gateway
- letzte_eichung: AwareDatetime | None
Zu diesem Datum fand die letzte Eichprüfung des Zählers statt.
- messwerterfassung: Messwerterfassung | None
Messwerterfassung des Zählers
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- registeranzahl: Registeranzahl | None
Spezifikation bezüglich unterstützter Tarif
- typ: Annotated[Literal[Typ.ZAEHLER], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- zaehlerauspraegung: Zaehlerauspraegung | None
Spezifikation die Richtung des Zählers betreffend
- zaehlergroesse: Zaehlergroesse | None
Größe des Zählers
- zaehlerhersteller: Geschaeftspartner | None
Der Hersteller des Zählers
- zaehlertyp: Zaehlertyp | None
Typisierung des Zählers
- zaehlertypSpezifikation: ZaehlertypSpezifikation | None
Besondere Spezifikation des Zählers
bo4e.bo.zeitreihe module
Contains Zeitreihe class and corresponding marshmallow schema for de-/serialization
- class bo4e.bo.zeitreihe.Zeitreihe(*, version: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[Typ.ZEITREIHE] = Typ.ZEITREIHE, bezeichnung: str | None = None, messgroesse: Messgroesse | None = None, messart: Messart | None = None, medium: Medium | None = None, einheit: Mengeneinheit | None = None, werte: list[Zeitreihenwert] | None = None, beschreibung: str | None = None, wertherkunft: Wertermittlungsverfahren | None = None, **extra_data: Any)[source]
Bases:
GeschaeftsobjektAbbildung einer allgemeinen Zeitreihe mit einem Wertvektor. Die Werte können mit wahlfreier zeitlicher Distanz im Vektor abgelegt sein.
- einheit: Mengeneinheit | None
Alle Werte in der Tabelle haben die Einheit, die hier angegeben ist
- messart: Messart | None
Beschreibt die Art der Messung (z.B. aktueller Wert, mittlerer Wert, maximaler Wert)
- messgroesse: Messgroesse | None
Beschreibt, was gemessen wurde (z.B. Strom, Spannung, Wirkleistung, Scheinleistung)
- model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}
A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
- typ: Annotated[Literal[Typ.ZEITREIHE], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]
- werte: list[Zeitreihenwert] | None
Hier liegen jeweils die Werte
- wertherkunft: Wertermittlungsverfahren | None
Kennzeichnung, wie die Werte entstanden sind, z.B. durch Messung