bo4e.bo package

Submodules

bo4e.bo.angebot module

Contains Angebot class

class bo4e.bo.angebot.Angebot(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.ANGEBOT] = BoTyp.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: Geschaeftsobjekt

Mit 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

Angebot JSON Schema

anfragereferenz: str | None: Referenz auf eine Anfrage oder Ausschreibung; Kann dem Empfänger des Angebotes bei Zuordnung des Angebotes zur Anfrage bzw. Ausschreibung helfen.

angebotsdatum: AwareDatetime | None: Erstellungsdatum des Angebots

angebotsgeber: Geschaeftspartner | None: Ersteller des Angebots

angebotsnehmer: Geschaeftspartner | None: Empfänger des Angebots

angebotsnummer: str | None: Eindeutige Nummer des Angebotes

bindefrist: AwareDatetime | None: Bis zu diesem Zeitpunkt (Tag/Uhrzeit) inklusive gilt das Angebot

sparte: Sparte | None: Sparte, für die das Angebot abgegeben wird (Strom/Gas)

typ: Annotated[Literal[BoTyp.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

class bo4e.bo.ausschreibung.Ausschreibung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.AUSSCHREIBUNG] = BoTyp.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: Geschaeftsobjekt

Das BO Ausschreibung dient zur detaillierten Darstellung von ausgeschriebenen Energiemengen in der Energiewirtschaft

Hint

Ausschreibung JSON Schema

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

ausschreibungsnummer: str | None: Vom Herausgeber der Ausschreibung vergebene eindeutige Nummer

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

ist_kostenpflichtig: bool | None: Kennzeichen, ob die Ausschreibung kostenpflichtig ist

lose: list[Ausschreibungslos] | None: Die einzelnen Lose, aus denen sich die Ausschreibung zusammensetzt

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

veroeffentlichungszeitpunkt: AwareDatetime | None: Gibt den Veröffentlichungszeitpunkt der Ausschreibung an

webseite: str | None: Internetseite, auf der die Ausschreibung veröffentlicht wurde (falls vorhanden)

bo4e.bo.bilanzierung module

Contains class Bilanzierung

class bo4e.bo.bilanzierung.Bilanzierung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: BoTyp | None = BoTyp.BILANZIERUNG, marktlokationsId: str | None = None, lastprofil: list[Lastprofil] | None = None, bilanzierungsbeginn: datetime | None = None, bilanzierungsende: datetime | None = None, bilanzkreis: str | None = None, jahresverbrauchsprognose: Menge | None = None, temperaturArbeit: Menge | None = None, kundenwert: Menge | None = None, verbrauchsaufteilung: Decimal | None = None, zeitreihentyp: Zeitreihentyp | None = None, aggregationsverantwortung: Aggregationsverantwortung | None = None, prognosegrundlage: Prognosegrundlage | None = None, detailsPrognosegrundlage: list[Profiltyp] | None = None, wahlrechtPrognosegrundlage: WahlrechtPrognosegrundlage | None = None, fallgruppenzuordnung: Fallgruppenzuordnung | None = None, prioritaet: int | None = None, grundWahlrechtPrognosegrundlage: WahlrechtPrognosegrundlage | None = None, abwicklungsmodell: Abwicklungsmodell | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Das BO Bilanzierung erfasst alle relevanten Informationen zur Bilanzierung.

Hint

Lastprofil JSON Schema

abwicklungsmodell: Abwicklungsmodell | None: Abwicklungsmodell

aggregationsverantwortung: Aggregationsverantwortung | None: Aggregationsverantwortung

bilanzierungsbeginn: datetime | None: Inklusiver Start der Bilanzierung

bilanzierungsende: datetime | None: Exklusives Ende der Bilanzierung

bilanzkreis: str | None: Bilanzkreis

details_prognosegrundlage: list[Profiltyp] | None

Prognosegrundlage.

Besteht der Bedarf ein tagesparameteräbhängiges Lastprofil mit gemeinsamer Messung anzugeben, so ist dies über die 2 -malige Wiederholung des CAV Segments mit der Angabe der Codes E02 und E14 möglich.

fallgruppenzuordnung: Fallgruppenzuordnung | None: Fallgruppenzuordnung (für gas RLM)

grund_wahlrecht_prognosegrundlage: WahlrechtPrognosegrundlage | None

Grund Wahlrecht der Prognosegrundlage.

true=Wahlrecht beim Lieferanten vorhanden

jahresverbrauchsprognose: Menge | None: Jahresverbrauchsprognose

kundenwert: Menge | None: Kundenwert

lastprofil: list[Lastprofil] | None: Eine Liste der verwendeten Lastprofile (SLP, SLP/TLP, ALP etc.)

marktlokations_id: str | None: ID der Marktlokation

prioritaet: int | None: Priorität des Bilanzkreises (für Gas)

prognosegrundlage: Prognosegrundlage | None: Prognosegrundlage

temperatur_arbeit: Menge | None: Temperatur Arbeit

typ: Annotated[BoTyp | None, FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

verbrauchsaufteilung: Decimal | None

Verbrauchsaufteilung in % zwischen SLP und TLP-Profil.

1. [Gemessene Energiemenge der OBIS “nicht Schwachlast”] * [Verbrauchsaufteilung in % / 100%] = [zu verlagernde Energiemenge] 2. [Gemessene Energiemenge der OBIS “Schwachlast”] - [zu verlagernde Energiemenge] = [Ermittelte Energiemenge für Schwachlast] 3. [Gemessene Energiemenge der OBIS “nicht Schwachlast”] + [zu verlagernde Energiemenge] = [Ermittelte Energiemenge für nicht Schwachlast]

wahlrecht_prognosegrundlage: WahlrechtPrognosegrundlage | None: Wahlrecht der Prognosegrundlage.

zeitreihentyp: Zeitreihentyp | None: Zeitreihentyp (SLS, TLS, etc.)

bo4e.bo.buendelvertrag module

Contains Buendelvertrag class

class bo4e.bo.buendelvertrag.Buendelvertrag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.BUENDELVERTRAG] = BoTyp.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: Geschaeftsobjekt

Abbildung eines Bündelvertrags. Es handelt sich hierbei um eine Liste von Einzelverträgen, die in einem Vertragsobjekt gebündelt sind.

Hint

Buendelvertrag JSON Schema

beschreibung: str | None: Beschreibung zum Vertrag

einzelvertraege: list[Vertrag] | None: Die Liste mit den Einzelverträgen zu den Abnahmestellen

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

typ: Annotated[Literal[BoTyp.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

vertragsbeginn: AwareDatetime | None: Gibt an, wann der Vertrag beginnt (inklusiv)

vertragsende: AwareDatetime | None: Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)

vertragskonditionen: list[Vertragskonditionen] | None: Festlegungen zu Laufzeiten und Kündigungsfristen

vertragsnummer: str | None: Eine im Verwendungskontext eindeutige Nummer für den Vertrag

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

class bo4e.bo.energiemenge.Energiemenge(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.ENERGIEMENGE] = BoTyp.ENERGIEMENGE, lokationsId: str | None = None, lokationstyp: Lokationstyp | None = None, energieverbrauch: list[Verbrauch] | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Abbildung von Mengen, die Lokationen zugeordnet sind

Hint

Energiemenge JSON Schema

energieverbrauch: list[Verbrauch] | None: Gibt den Verbrauch in einer Zeiteinheit an

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

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

bo4e.bo.fremdkosten module

Contains Fremdkosten class

class bo4e.bo.fremdkosten.Fremdkosten(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.FREMDKOSTEN] = BoTyp.FREMDKOSTEN, gueltigkeit: Zeitraum | None = None, summeKosten: Betrag | None = None, kostenbloecke: list[Fremdkostenblock] | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

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

Hint

Fremdkosten JSON Schema

gueltigkeit: Zeitraum | None: Für diesen Zeitraum wurden die Kosten ermittelt

kostenbloecke: list[Fremdkostenblock] | None

Netzkosten, Umlagen, Steuern etc

Type:: In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele

summe_kosten: Betrag | None: Die Gesamtsumme über alle Kostenblöcke und -positionen

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

bo4e.bo.geraet module

Contains Geraet class

class bo4e.bo.geraet.Geraet(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.GERAET] = BoTyp.GERAET, geraetenummer: str | None = None, bezeichnung: str | None = None, geraeteklasse: Geraeteklasse | None = None, geraetetyp: Geraetetyp | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Mit diesem BO werden alle Geräte modelliert, die keine Zähler sind.

Hint

Geraet JSON Schema

bezeichnung: str | None: Bezeichnung des Geräts

geraeteklasse: Geraeteklasse | None: Die übergreifende Klasse eines Geräts, beispielsweise Wandler

geraetenummer: str | None: Die auf dem Gerät aufgedruckte Nummer, die vom MSB vergeben wird.

geraetetyp: Geraetetyp | None: Der speziellere Typ eines Gerätes, beispielsweise Stromwandler

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

bo4e.bo.geschaeftsobjekt module

class bo4e.bo.geschaeftsobjekt.Geschaeftsobjekt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, **extra_data: Any)[source]

Bases: BaseModel

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

Hint

Geschaeftsobjekt JSON Schema

id: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='_id', alias_priority=2)]: Eine generische ID, die für eigene Zwecke genutzt werden kann. Z.B. könnten hier UUIDs aus einer Datenbank stehen oder URLs zu einem Backend-System.

version: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='_version', alias_priority=2)]: Version der BO-Struktur aka “fachliche Versionierung”

zusatz_attribute: list[ZusatzAttribut] | None

bo4e.bo.geschaeftspartner module

Contains Geschaeftspartner class

class bo4e.bo.geschaeftspartner.Geschaeftspartner(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.GESCHAEFTSPARTNER] = BoTyp.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: Geschaeftsobjekt

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

Hint

Geschaeftspartner JSON Schema

adresse: Adresse | None: Adresse des Geschäftspartners

amtsgericht: str | None: Amtsgericht bzw Handelsregistergericht, das die Handelsregisternummer herausgegeben hat

anrede: Anrede | None: Mögliche Anrede der Person

ansprechpartner: list[Person] | None

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”

handelsregisternummer: str | None: Handelsregisternummer des Geschäftspartners

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

nachname: str | None: Nachname (Familienname) der Person

organisationsname: str | None: Name der Firma, wenn Gewerbe oder andere Organisation.

organisationstyp: Organisationstyp | None: Kennzeichnung ob es sich um ein Gewerbe/Unternehmen, eine Privatperson oder eine andere Art von Organisation handelt.

titel: Titel | None: Möglicher Titel der Person

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

umsatzsteuer_id: str | None

“DE 813281825”

Type:: Die Steuer-ID des Geschäftspartners; Beispiel

vorname: str | None: Vorname der Person

website: str | None: Internetseite des Marktpartners

bo4e.bo.kosten module

Contains Kosten class

class bo4e.bo.kosten.Kosten(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.KOSTEN] = BoTyp.KOSTEN, kostenklasse: Kostenklasse | None = None, gueltigkeit: Zeitraum | None = None, kostenbloecke: list[Kostenblock] | None = None, summeKosten: list[Betrag] | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Dieses BO wird zur Übertagung von hierarchischen Kostenstrukturen verwendet. Die Kosten werden dabei in Kostenblöcke und diese wiederum in Kostenpositionen strukturiert.

Hint

Kosten JSON Schema

gueltigkeit: Zeitraum | None: Für diesen Zeitraum wurden die Kosten ermittelt

kostenbloecke: list[Kostenblock] | None

Netzkosten, Umlagen, Steuern etc

Type:: In Kostenblöcken werden Kostenpositionen zusammengefasst. Beispiele

kostenklasse: Kostenklasse | None: Klasse der Kosten, beispielsweise Fremdkosten

summe_kosten: list[Betrag] | None: Die Gesamtsumme über alle Kostenblöcke und -positionen

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

bo4e.bo.lastgang module

Contains Lastgang class

class bo4e.bo.lastgang.Lastgang(*, version: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.LASTGANG] = BoTyp.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: Geschaeftsobjekt

Modell 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

Lastgang JSON Schema

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

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

sparte: Sparte | None: Angabe, ob es sich um einen Gas- oder Stromlastgang handelt

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

version: str | None: Versionsnummer des Lastgangs

werte: list[Zeitreihenwert] | None: Die im Lastgang enthaltenen Messwerte

zeit_intervall_laenge: Menge | None

bo4e.bo.lokationszuordnung module

Contains Lokationszuordnung class

class bo4e.bo.lokationszuordnung.Lokationszuordnung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.LOKATIONSZUORDNUNG] = BoTyp.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: Zeitraum | None = None, zuordnungstyp: str | None = None, lokationsbuendelcode: str | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

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

Hint

Lokationszuordnung JSON Schema

gueltigkeit: Zeitraum | None: Zeitraum 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

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

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

zuordnungstyp: str | None

Eventuell anderer Datentyp]

Type:: Verknüpfungsrichtung z.B. Malo-Melo [TODO

bo4e.bo.marktlokation module

Contains Marktlokation class

class bo4e.bo.marktlokation.Marktlokation(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.MARKTLOKATION] = BoTyp.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: Geschaeftsobjekt

Object containing information about a Marktlokation

Hint

Marktlokation JSON Schema

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

gebietstyp: Gebiettyp | None: Typ des Netzgebietes, z.B. Verteilnetz

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

ist_unterbrechbar: bool | None: Gibt an, ob es sich um eine unterbrechbare Belieferung handelt

katasterinformation: Katasteradresse | None: Alternativ zu einer postalischen Adresse und Geokoordinaten kann hier eine Ortsangabe mittels Gemarkung und Flurstück erfolgen.

kundengruppen: list[Kundentyp] | None: Kundengruppen der Marktlokation

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.

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.

netzgebietsnr: str | None: Die ID des Gebietes in der ene’t-Datenbank

regelzone: str | None

//www.entsoe.eu/data/energy-identification-codes-eic/eic-approved-codes/

Type:: für Strom. Code vom EIC, https

sparte: Sparte | None: Sparte der Marktlokation, z.B. Gas oder Strom

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

verbrauchsart: Verbrauchsart | None: Verbrauchsart der Marktlokation.

verbrauchsmengen: list[Verbrauch] | None

zaehlwerke: list[Zaehlwerk] | None

zaehlwerke_der_beteiligten_marktrolle: list[Zaehlwerk] | None

bo4e.bo.marktteilnehmer module

Contains Marktteilnehmer class

class bo4e.bo.marktteilnehmer.Marktteilnehmer(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.MARKTTEILNEHMER] = BoTyp.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: Geschaeftsobjekt

Objekt zur Aufnahme der Information zu einem Marktteilnehmer

Hint

Marktteilnehmer JSON Schema

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

rollencodenummer: str | None: Gibt die Codenummer der Marktrolle an

rollencodetyp: Rollencodetyp | None: Gibt den Typ des Codes an

sparte: Sparte | None: Sparte des Marktteilnehmers, z.B. Gas oder Strom

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

bo4e.bo.messlokation module

Contains Messlokation class

class bo4e.bo.messlokation.Messlokation(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.MESSLOKATION] = BoTyp.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: Geschaeftsobjekt

Object containing information about a Messlokation

Hint

Messlokation JSON Schema

geoadresse: Geokoordinaten | None: Alternativ zu einer postalischen Adresse kann hier ein Ort mittels Geokoordinaten angegeben werden (z.B. zur Identifikation von Sendemasten).

geraete: list[Geraet] | None: Liste der Geräte, die zu dieser Messstelle gehört

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

messgebietnr: str | None: Die Nummer des Messgebietes in der ene’t-Datenbank

messlokations_id: str | None: Die Messlokations-Identifikation; Das ist die frühere Zählpunktbezeichnung

messlokationszaehler: list[Zaehler] | None: Zähler, die zu dieser Messlokation gehören

netzebene_messung: Netzebene | None: Spannungsebene der Messung

sparte: Sparte | None: Sparte der Messlokation, z.B. Gas oder Strom

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

bo4e.bo.netzlokation module

Contains Netzlokation class

class bo4e.bo.netzlokation.Netzlokation(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.NETZLOKATION] = BoTyp.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: Geschaeftsobjekt

Object containing information about a Netzlokation

Hint

Netzlokation JSON Schema

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

netzanschlussleistung: Menge | None: Netzanschlussleistungsmenge der Netzlokation

netzlokations_id: str | None: Identifikationsnummer einer Netzlokation, an der Energie entweder verbraucht, oder erzeugt wird

obiskennzahl: str | None: Die OBIS-Kennzahl für die Netzlokation

sparte: Sparte | None: Sparte der Netzlokation, z.B. Gas oder Strom.

steuerkanal: bool | None: Ob ein Steuerkanal der Netzlokation zugeordnet ist und somit die Netzlokation gesteuert werden kann.

typ: Annotated[Literal[BoTyp.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

Bases: Geschaeftsobjekt

Object containing information about a Person

Hint

Person JSON Schema

adresse: Adresse | None: Adresse der Person, falls diese von der Adresse des Geschäftspartners abweicht

anrede: Anrede | None: Mögliche Anrede der Person

geburtsdatum: date | None: Geburtsdatum der Person

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

kommentar: str | None: Weitere Informationen zur Person

kontaktwege: list[Kontaktweg] | None: Kontaktwege der Person

nachname: str | None: Nachname (Familienname) der Person

titel: Titel | None: Möglicher Titel der Person

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

vorname: str | None: Vorname der Person

zustaendigkeiten: list[Zustaendigkeit] | None: Liste der Abteilungen und Zuständigkeiten der Person

bo4e.bo.preisblatt module

Contains Preisblatt class

class bo4e.bo.preisblatt.Preisblatt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATT] = BoTyp.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: Geschaeftsobjekt

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

Hint

Preisblatt JSON Schema

bezeichnung: str | None: Eine Bezeichnung für das Preisblatt

gueltigkeit: Zeitraum | None: Der Zeitraum für den der Preis festgelegt ist

herausgeber: Marktteilnehmer | None: Der Netzbetreiber, der die Preise veröffentlicht hat

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

sparte: Sparte | None: Preisblatt gilt für angegebene Sparte

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

bo4e.bo.preisblattdienstleistung module

Contains PreisblattDienstleistung class

class bo4e.bo.preisblattdienstleistung.PreisblattDienstleistung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATTDIENSTLEISTUNG] = BoTyp.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: Preisblatt

Variante des Preisblattmodells zur Abbildung der Preise für wahlfreie Dienstleistungen

Hint

PreisblattDienstleistung JSON Schema

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

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

bo4e.bo.preisblatthardware module

Contains PreisblattHardware class

class bo4e.bo.preisblatthardware.PreisblattHardware(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATTHARDWARE] = BoTyp.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: Preisblatt

Variante des Preisblattmodells zur Abbildung der Preise für zusätzliche Hardware

Hint

PreisblattHardware JSON Schema

basisgeraet: Geraet | None: Der Preis betriftt das hier angegebene Gerät, z.B. ein Tarifschaltgerät

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

messebene: Netzebene | None: Die Preise gelten für Messlokationen in der angebebenen Netzebene

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

bo4e.bo.preisblattkonzessionsabgabe module

Contains PreisblattKonzessionsabgabe class

class bo4e.bo.preisblattkonzessionsabgabe.PreisblattKonzessionsabgabe(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATTKONZESSIONSABGABE] = BoTyp.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: Preisblatt

Die Variante des Preisblattmodells zur Abbildung von allgemeinen Abgaben

Hint

PreisblattKonzessionsabgabe JSON Schema

kundengruppe_k_a: KundengruppeKA | None: Kundegruppe anhand derer die Höhe der Konzessionabgabe festgelegt ist

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

bo4e.bo.preisblattmessung module

Contains PreisblattMessung class

class bo4e.bo.preisblattmessung.PreisblattMessung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATTMESSUNG] = BoTyp.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: Preisblatt

Variante des Preisblattmodells zur Abbildung der Preise des Messstellenbetriebs und damit verbundener Leistungen

Hint

PreisblattMessung JSON Schema

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

messebene: Netzebene | None: Die Preise gelten für Messlokationen in der angebebenen Netzebene

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

zaehler: Zaehler | None: Der Preis betrifft den hier angegebenen Zähler, z.B. einen Drehstromzähler

bo4e.bo.preisblattnetznutzung module

Contains PreisblattNetnutzung class

class bo4e.bo.preisblattnetznutzung.PreisblattNetznutzung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.PREISBLATTNETZNUTZUNG] = BoTyp.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: Preisblatt

Die Variante des Preisblattmodells zur Abbildung der Netznutzungspreise

Hint

PreisblattNetznutzung JSON Schema

bilanzierungsmethode: Bilanzierungsmethode | None: Die Preise gelten für Marktlokationen der angebebenen Bilanzierungsmethode

kundengruppe: Kundengruppe | None

netzebene: Netzebene | None: Die Preise gelten für Marktlokationen in der angebebenen Netzebene

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

bo4e.bo.rechnung module

Contains Rechnung class

class bo4e.bo.rechnung.Rechnung(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.RECHNUNG] = BoTyp.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: Geschaeftsobjekt

Modell für die Abbildung von Rechnungen und Netznutzungsrechnungen im Kontext der Energiewirtschaft;

Hint

Rechnung JSON Schema

faelligkeitsdatum: AwareDatetime | None: Zu diesem Datum ist die Zahlung fällig

gesamtbrutto: Betrag | None: Die Summe aus Netto- und Steuerbetrag

gesamtnetto: Betrag | None: Die Summe der Nettobeträge der Rechnungsteile

gesamtsteuer: Betrag | None: Die Summe der Steuerbeträge der Rechnungsteile

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

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

rabatt_brutto: Betrag | None: Gesamtrabatt auf den Bruttobetrag

rechnungsdatum: AwareDatetime | None: Ausstellungsdatum der 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

rechnungsnummer: str | None: Eine im Verwendungskontext eindeutige Nummer für die Rechnung

rechnungsperiode: Zeitraum | None: Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung

rechnungspositionen: list[Rechnungsposition] | None: Die Rechnungspositionen

rechnungsstatus: Rechnungsstatus | None: Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes

rechnungstitel: str | None: Bezeichnung für die vorliegende Rechnung

rechnungstyp: Rechnungstyp | None: Ein kontextbezogender Rechnungstyp, z.B. Netznutzungsrechnung

sparte: Sparte | None: Sparte (Strom, Gas …) für die die Rechnung ausgestellt ist

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[BoTyp.RECHNUNG], FieldInfo(annotation=NoneType, required=True, alias='_typ', alias_priority=2)]

vorausgezahlt: Betrag | None: Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert

zu_zahlen: Betrag | None: Der zu zahlende Betrag, der sich aus (gesamtbrutto - vorausbezahlt - rabattBrutto) ergibt

bo4e.bo.region module

Contains Region class

class bo4e.bo.region.Region(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.REGION] = BoTyp.REGION, bezeichnung: str | None = None, positivListe: list[Regionskriterium] | None = None, negativListe: list[Regionskriterium] | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Modellierung einer Region als Menge von Kriterien, die eine Region beschreiben

Hint

Region JSON Schema

bezeichnung: str | None: Bezeichnung der Region

negativ_liste: list[Regionskriterium] | None: Negativliste der Kriterien zur Definition der Region

positiv_liste: list[Regionskriterium] | None: Positivliste der Kriterien zur Definition der Region

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

bo4e.bo.regionaltarif module

Contains Regionaltarif class

class bo4e.bo.regionaltarif.Regionaltarif(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.REGIONALTARIF] = BoTyp.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: Tarifinfo

Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen.

Hint

Regionaltarif JSON Schema

berechnungsparameter: Tarifberechnungsparameter | None: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen

preisgarantien: list[RegionalePreisgarantie] | None: Festlegung von Garantien für bestimmte Preisanteile

preisstand: AwareDatetime | None: Gibt an, wann der Preis zuletzt angepasst wurde

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.

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

bo4e.bo.standorteigenschaften module

Contains Standorteigenschaften class

class bo4e.bo.standorteigenschaften.Standorteigenschaften(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.STANDORTEIGENSCHAFTEN] = BoTyp.STANDORTEIGENSCHAFTEN, eigenschaftenStrom: list[StandorteigenschaftenStrom] | None = None, eigenschaftenGas: StandorteigenschaftenGas | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Modelliert die regionalen und spartenspezifischen Eigenschaften einer gegebenen Adresse.

Hint

Standorteigenschaften JSON Schema

eigenschaften_gas: StandorteigenschaftenGas | None: Eigenschaften zur Sparte Gas

eigenschaften_strom: list[StandorteigenschaftenStrom] | None: Eigenschaften zur Sparte Strom

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

bo4e.bo.steuerbareressource module

Contains steuerbare Ressource class

class bo4e.bo.steuerbareressource.SteuerbareRessource(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.STEUERBARERESSOURCE] = BoTyp.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: Geschaeftsobjekt

Object containing information about a steuerbare Ressource

Hint

SteuerbareRessource JSON Schema

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

steuerbare_ressource_id: str | None: Id der steuerbaren Ressource

steuerkanal_leistungsbeschreibung: SteuerkanalLeistungsbeschreibung | None: Leistungsbeschreibung des Steuerkanals

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

zugeordnete_msb_codenummer: str | None: Angabe des Messstellenbetreibers, der der Steuerbaren Ressource zugeordnet ist.

bo4e.bo.tarif module

Contains Tarif class

class bo4e.bo.tarif.Tarif(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.TARIF] = BoTyp.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: Tarifinfo

Abbildung eines Tarifs mit regionaler Zuordnung von Preisen und Auf- und Abschlägen

Hint

Tarif JSON Schema

berechnungsparameter: Tarifberechnungsparameter | None: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen

preisgarantie: Preisgarantie | None: Preisgarantie für diesen Tarif

preisstand: AwareDatetime | None: Gibt an, wann der Preis zuletzt angepasst wurde

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.

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

bo4e.bo.tarifinfo module

Contains Tarifinfo class

class bo4e.bo.tarifinfo.Tarifinfo(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.TARIFINFO] = BoTyp.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: Geschaeftsobjekt

Das BO Tarifinfo liefert die Merkmale, die einen Endkundentarif identifizierbar machen. Dieses BO dient als Basis für weitere BOs mit erweiterten Anwendungsmöglichkeiten.

Hint

Tarifinfo JSON Schema

anbieter: Marktteilnehmer | None: Der Marktteilnehmer (Lieferant), der diesen Tarif anbietet

anbietername: str | None: Der Name des Marktpartners, der den 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”

bemerkung: str | None: Freitext

bezeichnung: str | None: Name des Tarifs

energiemix: Energiemix | None: Der Energiemix, der für diesen Tarif gilt

kundentypen: list[Kundentyp] | None: Kundentypen für den der Tarif gilt, z.B. Privatkunden

registeranzahl: Registeranzahl | None: Die Art des Tarifes, z.B. Eintarif oder Mehrtarif

sparte: Sparte | None: Strom oder Gas, etc.

tarifmerkmale: list[Tarifmerkmal] | None: Weitere Merkmale des Tarifs, z.B. Festpreis oder Vorkasse

tariftyp: Tariftyp | None: Hinweis auf den Tariftyp, z.B. Grundversorgung oder Sondertarif

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

vertragskonditionen: Vertragskonditionen | None: Mindestlaufzeiten und Kündigungsfristen zusammengefasst

website: str | None: Internetseite auf dem der Tarif zu finden ist

zeitliche_gueltigkeit: Zeitraum | None: Angabe, in welchem Zeitraum der Tarif gültig ist

bo4e.bo.tarifkosten module

Contains Tarifkosten class

class bo4e.bo.tarifkosten.Tarifkosten(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.TARIFKOSTEN] = BoTyp.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: Tarifinfo

Objekt zur Kommunikation von Kosten, die im Rahmen der Tarifanwendung entstehen

Hint

Tarifkosten JSON Schema

kosten: Kosten | None: Referenz (Link) zu einem Kostenobjekt, in dem die Kosten für die Anwendung des Tarifs auf eine Abnahmesituation berechnet wurden

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

bo4e.bo.tarifpreisblatt module

Contains Tarifpreisblatt class

class bo4e.bo.tarifpreisblatt.Tarifpreisblatt(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.TARIFPREISBLATT] = BoTyp.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: Tarifinfo

Tarifinformation mit Preisen, Aufschlägen und Berechnungssystematik

Hint

Tarifpreisblatt JSON Schema

berechnungsparameter: Tarifberechnungsparameter | None: Für die Berechnung der Kosten sind die hier abgebildeten Parameter heranzuziehen

preisgarantie: Preisgarantie | None: Festlegung von Garantien für bestimmte Preisanteile

preisstand: AwareDatetime | None: Gibt an, wann der Preis zuletzt angepasst wurde

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.

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

bo4e.bo.technischeressource module

Contains technische Ressource class

class bo4e.bo.technischeressource.TechnischeRessource(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.TECHNISCHERESSOURCE] = BoTyp.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: Geschaeftsobjekt

Object containing information about a technische Ressource

Hint

TechnischeRessource JSON Schema

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

nennleistungabgabe: Menge | None: Nennleistung (Abgabe)

nennleistungaufnahme: Menge | None: Nennleistung (Aufnahme)

speicherart: Speicherart | None: Art des Speichers

speicherkapazitaet: Menge | None: Speicherkapazität

technische_ressource_id: str | None: Identifikationsnummer einer technischen Ressource

technische_ressource_nutzung: TechnischeRessourceNutzung | None: Art und Nutzung der technischen Ressource

technische_ressource_verbrauchsart: TechnischeRessourceVerbrauchsart | None: Verbrauchsart der technischen Ressource

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

vorgelagerte_messlokation_id: str | None: Vorgelagerte Messlokation ID

waermenutzung: Waermenutzung | None: Wärmenutzung

zugeordnete_marktlokation_id: str | None: Referenz auf die der technischen Ressource zugeordneten Marktlokation

zugeordnete_steuerbare_ressource_id: str | None: Referenz auf die der technischen Ressource zugeordneten Steuerbaren Ressource

bo4e.bo.vertrag module

Contains Vertrag class

class bo4e.bo.vertrag.Vertrag(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.VERTRAG] = BoTyp.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: Geschaeftsobjekt

Modell für die Abbildung von Vertragsbeziehungen; Das Objekt dient dazu, alle Arten von Verträgen, die in der Energiewirtschaft Verwendung finden, abzubilden.

Hint

Vertrag JSON Schema

beschreibung: str | None: Beschreibung zum Vertrag

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

typ: Annotated[Literal[BoTyp.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.

vertragsbeginn: AwareDatetime | None: Gibt an, wann der Vertrag beginnt (inklusiv)

vertragsende: AwareDatetime | None: Gibt an, wann der Vertrag (voraussichtlich) endet oder beendet wurde (exklusiv)

vertragskonditionen: Vertragskonditionen | None: Festlegungen zu Laufzeiten und Kündigungsfristen

vertragsnummer: str | None: Eine im Verwendungskontext eindeutige Nummer für den Vertrag

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

class bo4e.bo.zaehler.Zaehler(*, _version: str | None = '202401.7.1.dev1+gcbc02070', zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.ZAEHLER] = BoTyp.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: Geschaeftsobjekt

Object containing information about a meter/”Zaehler”.

Hint

Zaehler JSON Schema

befestigungsart: Befestigungsart | None: Befestigungsart

eichung_bis: AwareDatetime | None: Bis zu diesem Datum (exklusiv) ist der Zähler geeicht.

geraete: list[Geraet] | None: Liste der Geräte, die zu diesem Zähler gehören, bspw. Smartmeter-Gateway

ist_fernschaltbar: bool | None: Fernschaltung

letzte_eichung: AwareDatetime | None: Zu diesem Datum fand die letzte Eichprüfung des Zählers statt.

messwerterfassung: Messwerterfassung | None: Messwerterfassung des Zählers

registeranzahl: Registeranzahl | None: Spezifikation bezüglich unterstützter Tarif

sparte: Sparte | None: Strom oder Gas

typ: Annotated[Literal[BoTyp.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

zaehlerkonstante: Decimal | None: Zählerkonstante auf dem Zähler

zaehlernummer: str | None: Nummerierung des Zählers,vergeben durch den Messstellenbetreiber

zaehlertyp: Zaehlertyp | None: Typisierung des Zählers

zaehlertypSpezifikation: ZaehlertypSpezifikation | None: Besondere Spezifikation des Zählers

zaehlwerke: list[Zaehlwerk] | None

bo4e.bo.zeitreihe module

Contains Zeitreihe class

class bo4e.bo.zeitreihe.Zeitreihe(*, version: str | None = None, zusatzAttribute: list[ZusatzAttribut] | None = None, _id: str | None = None, _typ: Literal[BoTyp.ZEITREIHE] = BoTyp.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: Messwertstatus | None = None, **extra_data: Any)[source]

Bases: Geschaeftsobjekt

Abbildung einer allgemeinen Zeitreihe mit einem Wertvektor. Die Werte können mit wahlfreier zeitlicher Distanz im Vektor abgelegt sein.

Hint

Zeitreihe JSON Schema

beschreibung: str | None: Beschreibt die Verwendung der Zeitreihe

bezeichnung: str | None: Bezeichnung für die Zeitreihe

einheit: Mengeneinheit | None: Alle Werte in der Tabelle haben die Einheit, die hier angegeben ist

medium: Medium | None: Medium, das gemessen wurde (z.B. Wasser, Dampf, Strom, Gas)

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)

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

version: str | None: Version der Zeitreihe

werte: list[Zeitreihenwert] | None: Hier liegen jeweils die Werte

wertherkunft: Messwertstatus | None: Kennzeichnung, wie die Werte entstanden sind, z.B. ABGELESEN oder PROGNOSEWERT

bo4e.bo package

Submodules

bo4e.bo.angebot module

bo4e.bo.ausschreibung module

bo4e.bo.bilanzierung module

bo4e.bo.buendelvertrag module

bo4e.bo.energiemenge module

bo4e.bo.fremdkosten module

bo4e.bo.geraet module

bo4e.bo.geschaeftsobjekt module

bo4e.bo.geschaeftspartner module

bo4e.bo.kosten module

bo4e.bo.lastgang module

bo4e.bo.lokationszuordnung module

bo4e.bo.marktlokation module

bo4e.bo.marktteilnehmer module

bo4e.bo.messlokation module

bo4e.bo.netzlokation module

bo4e.bo.person module

bo4e.bo.preisblatt module

bo4e.bo.preisblattdienstleistung module

bo4e.bo.preisblatthardware module

bo4e.bo.preisblattkonzessionsabgabe module

bo4e.bo.preisblattmessung module

bo4e.bo.preisblattnetznutzung module

bo4e.bo.rechnung module

bo4e.bo.region module

bo4e.bo.regionaltarif module

bo4e.bo.standorteigenschaften module

bo4e.bo.steuerbareressource module

bo4e.bo.tarif module

bo4e.bo.tarifinfo module

bo4e.bo.tarifkosten module

bo4e.bo.tarifpreisblatt module

bo4e.bo.technischeressource module

bo4e.bo.vertrag module

bo4e.bo.zaehler module

bo4e.bo.zeitreihe module

Module contents