Various changes

Author: lord-haffi

docs/restrictions.rst

@@ -17,7 +17,10 @@ such that it can be implemented in most programming languages.
 
 * In general, BOs won't be referenced by COMs but it's not prohibited. In fact, there are some cases in which a COM
   references a BO. Keep that in mind when designing a package structure e.g. to prevent circular import errors.
-* There are no circular references. This means, when drawing a reference graph of BO4E there will be no loops.
+* There are no circular references **except for** self references. A model can reference itself in the same class.
+  This means, when drawing a reference graph of BO4E there will be no loops except for "tiny" loops corresponding
+  to self references. E.g. `BO Rechnung` can have a field `teilrechnungen` of type `list[BO Rechnung]`.
+  But it cannot reference another model which references back to `BO Rechnung`.
 
   * As a result, we cannot directly support `n x m`-relationships as they would require a back-reference.
     If you're designing a database structure you have to manually add these relationship tables where needed.

src/bo4e/__init__.py

@@ -103,6 +103,7 @@
     "VerwendungszweckProMarktrolle",
     "Zaehlwerk",
     "Zaehlzeitregister",
+    "Zahlungsinformation",
     "Zeitraum",
     "Zeitreihenwert",
     "Zustaendigkeit",
@@ -202,7 +203,6 @@
     "ZaehlertypSpezifikation",
     "Zeitreihentyp",
     "ZusatzAttribut",
-    "Zahlungsinformationen",
     "__version__",
     "__gh_version__",
 ]
@@ -306,7 +306,7 @@
 from .com.verwendungszweckpromarktrolle import VerwendungszweckProMarktrolle
 from .com.zaehlwerk import Zaehlwerk
 from .com.zaehlzeitregister import Zaehlzeitregister
-from .com.zahlungsinformationen import Zahlungsinformationen
+from .com.zahlungsinformation import Zahlungsinformation
 from .com.zeitraum import Zeitraum
 from .com.zeitreihenwert import Zeitreihenwert
 from .com.zustaendigkeit import Zustaendigkeit

src/bo4e/bo/rechnung.py

@@ -15,7 +15,7 @@
     from ..com.betrag import Betrag
     from ..com.rechnungsposition import Rechnungsposition
     from ..com.steuerbetrag import Steuerbetrag
-    from ..com.zahlungsinformationen import Zahlungsinformationen
+    from ..com.zahlungsinformation import Zahlungsinformation
     from ..com.zeitraum import Zeitraum
     from ..enum.netznutzungrechnungsart import NetznutzungRechnungsart
     from ..enum.netznutzungrechnungstyp import NetznutzungRechnungstyp
@@ -29,6 +29,7 @@
     from .marktteilnehmer import Marktteilnehmer
     from .messlokation import Messlokation
     from .vertrag import Vertrag
+    from .zaehler import Zaehler
 
 # pylint: disable=too-few-public-methods, too-many-instance-attributes
 
@@ -48,11 +49,7 @@ class Rechnung(Geschaeftsobjekt):
     """
 
     typ: Annotated[Literal[BoTyp.RECHNUNG], Field(alias="_typ")] = BoTyp.RECHNUNG
-    ist_storno: Optional[bool] = None
-    """
-    Kennzeichnung, ob es sich um eine Stornorechnung handelt;
-    im Falle "true" findet sich im Attribut "originalrechnungsnummer" die Nummer der Originalrechnung.
-    """
+
     rechnungsnummer: Optional[str] = None
     """Eine im Verwendungskontext eindeutige Nummer für die Rechnung"""
     rechnungsdatum: Optional[pydantic.AwareDatetime] = None
@@ -64,9 +61,13 @@ class Rechnung(Geschaeftsobjekt):
     rechnungsperiode: Optional["Zeitraum"] = None
     """Der Zeitraum der zugrunde liegenden Lieferung zur Rechnung"""
     rechnungsersteller: Optional["Geschaeftspartner"] = None
-    """Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer"""
+    """
+    Der Aussteller der Rechnung. Die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer.
+    """
     rechnungsempfaenger: Optional["Geschaeftspartner"] = None
-    """Der Aussteller der Rechnung, die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer"""
+    """
+    Der Aussteller der Rechnung. Die Rollencodenummer kennt man über den im Geschäftspartner verlinkten Marktteilnehmer.
+    """
     gesamtnetto: Optional["Betrag"] = None
     """Die Summe der Nettobeträge der Rechnungsteile"""
     gesamtsteuer: Optional["Betrag"] = None
@@ -75,58 +76,68 @@ class Rechnung(Geschaeftsobjekt):
     """Die Summe aus Netto- und Steuerbetrag"""
     zu_zahlen: Optional["Betrag"] = None
     """Der zu zahlende Betrag, der sich aus (gesamtbrutto - vorausbezahlt - rabattBrutto) ergibt"""
+    zaehler: Optional[list["Zaehler"]] = None
+    zukuenftiger_abschlag: Optional["Betrag"] = None
+    kaeuferreferenz: Optional[str] = None
+    #!
+
     rechnungspositionen: Optional[list["Rechnungsposition"]] = None
     """Die Rechnungspositionen"""
-    rechnungstitel: Optional[str] = None
+    rechnungstitel: Optional[str] = None  #!
     """Bezeichnung für die vorliegende Rechnung"""
     rechnungsstatus: Optional["Rechnungsstatus"] = None
     """Status der Rechnung zur Kennzeichnung des Bearbeitungsstandes"""
     original_rechnungsnummer: Optional[str] = None
     """Im Falle einer Stornorechnung (storno = true) steht hier die Rechnungsnummer der stornierten Rechnung"""
-    vorausgezahlt: Optional["Betrag"] = None
+    vorausgezahlt: Optional["Betrag"] = None  #!
     """Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert"""
-    rabatt_brutto: Optional["Betrag"] = None
-    """Gesamtrabatt auf den Bruttobetrag"""
-    steuerbetraege: Optional[list["Steuerbetrag"]] = None
+    rabatt_netto: Optional["Betrag"] = None
+    """Gesamtrabatt auf den Nettobetrag"""
+    steuerbetraege: Optional[list["Steuerbetrag"]] = None  #!
     """
     Eine Liste mit Steuerbeträgen pro Steuerkennzeichen/Steuersatz;
     die Summe dieser Beträge ergibt den Wert für gesamtsteuer.
     """
-    sparte: Optional["Sparte"] = None
+    sparte: Optional["Sparte"] = None  #!
     """Sparte (Strom, Gas ...) für die die Rechnung ausgestellt ist"""
     netznutzungrechnungsart: Optional["NetznutzungRechnungsart"] = None
     """Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt"""
     netznutzungrechnungstyp: Optional["NetznutzungRechnungstyp"] = None
     """Aus der INVOIC entnommen, befüllt wenn es sich um eine Netznutzungsrechnung handelt"""
-    ist_original: Optional[bool] = None
+    ist_original: Optional[bool] = None  #!
     """Kennzeichen, ob es sich um ein Original (true) oder eine Kopie handelt (false)"""
-    ist_simuliert: Optional[bool] = None
+    ist_simuliert: Optional[bool] = None  #!
     """Kennzeichen, ob es sich um eine simulierte Rechnung, z.B. zur Rechnungsprüfung handelt"""
+    ist_storno: Optional[bool] = None  #!
+    """
+    Kennzeichnung, ob es sich um eine Stornorechnung handelt;
+    im Falle "true" findet sich im Attribut "originalrechnungsnummer" die Nummer der Originalrechnung.
+    """
     marktlokation: Optional["Marktlokation"] = None
     """Marktlokation, auf die sich die Rechnung bezieht"""
     messlokation: Optional["Messlokation"] = None
     """Messlokation, auf die sich die Rechnung bezieht"""
-    teilrechnungen: Optional[list["Rechnung"]]
+    teilrechnungen: Optional[list["Rechnung"]] = None
     """Rechnungen, die durch diese Rechnung zusammengefasst werden"""
-    zahlungsinformationen: Optional["Zahlungsinformationen"]
+    zahlungsinformationen: Optional[list["Zahlungsinformation"]] = None
     """Informationen wie eine Rechnung bezahlt werden soll"""
-    vertrag: Optional["Vertrag"]
+    vertrag: Optional["Vertrag"] = None
     """enthält Informationen über den der Rechnung zugrundeliegenden Vertrag für Rechnungen nach EnWG § 40"""
-    messstellenbetreiber: Optional["Marktteilnehmer"]
+    messstellenbetreiber: Optional["Marktteilnehmer"] = None
     """der Messtellenbetreiber an der Lieferstelle, relevant für Rechnungen gemäß EnWG § 40"""
-    netzbetreiber: Optional["Marktteilnehmer"]
+    netzbetreiber: Optional["Marktteilnehmer"] = None
     """der Netzbetreiber an der Lieferstelle, relevant für Rechnungen gemäß EnWG § 40"""
-    anfangszaehlerstand: Optional["Energiemenge"]
+    anfangszaehlerstand: Optional["Energiemenge"] = None
     """Für Verbrauchsbasierte Rechnungen der Zählerstand zur Beginn des abgerechneten Zeitraums, Pflicht für Rechnungen gemäß EnWG § 40"""
-    endzaehlerstand: Optional["Energiemenge"]
+    endzaehlerstand: Optional["Energiemenge"] = None
     """Für Verbrauchsbasierte Rechnungen der Zählerstand zum Ende des abgerechneten Zeitraums, Pflicht für Rechnungen gemäß EnWG § 40"""
-    aktuellerverbrauch: Optional["Energiemenge"]
+    aktueller_verbrauch: Optional["Energiemenge"] = None
     """Verbrauch des abgerechneten Zeitraums, Pflicht für Rechnungen gemäß EnWG § 40"""
-    jahresverbrauch: Optional["Energiemenge"]
+    jahresverbrauch: Optional["Energiemenge"] = None
     """ggf. auf einen Vergleichszeitraum hochgerechneter Verbrauch des abgerechneten Zeitraums zu Vergleichszwecken mit dem Vorjahr, gemäß EnWG § 40"""
-    vorjahresverbrauch: Optional["Energiemenge"]
+    vorjahresverbrauch: Optional["Energiemenge"] = None
     """ggf. auf einen Vergleichszeitraum hochgerechneter Verbrauch des vorherigen Jahres zu Vergleichszwecken mit dem aktuellen Jahr, gemäß EnWG § 40"""
-    fremdkosten: Optional["Fremdkosten"]
+    fremdkosten: Optional["Fremdkosten"] = None
     """Zur Ausweisung der in die Kalkulation eingeflossenen Preise gemäß EnWG § 40"""
-    referenzverbrauch: Optional[list["Energiemenge"]]
+    referenzverbraeuche: Optional[list["Energiemenge"]] = None
     """Verbräuche von Referenzkundengruppen gemäß EnWG § 40"""

src/bo4e/com/zahlungsinformation.py

@@ -0,0 +1,45 @@
+"""
+Contains Zahlungsinformation class
+"""
+
+from decimal import Decimal
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+from pydantic import Field
+
+from ..enum.comtyp import ComTyp
+from ..utils import postprocess_docstring
+from .com import COM
+
+if TYPE_CHECKING:
+    from ..enum.zahlungsart import Zahlungsart
+
+
+@postprocess_docstring
+class Zahlungsinformation(COM):
+    """
+    Mit dieser Komponente kann eine einzelne Zahlungsinformation dargestellt werden.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/com/Zahlungsinformation.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Zahlungsinformation JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Zahlungsinformation.json>`_
+
+    """
+
+    typ: Annotated[Literal[ComTyp.ZAHLUNGSINFORMATION], Field(alias="_typ")] = ComTyp.ZAHLUNGSINFORMATION
+
+    zahlungsart: Optional["Zahlungsart"] = None
+    """Die Zahlungsart dieser Zahlungsinformation"""
+    iban: Optional[str] = None
+    """Eine IBAN-Nummer"""
+    bic: Optional[str] = None
+    """Eine BIC-Nummer"""
+    kontoinhaber: Optional[str] = None
+    """Der Name des Kontoinhabers"""
+    betreff: Optional[str] = None
+    """Eine konstante Betreffzeile für Überweisungen"""
+    sepa_referenz: Optional[str] = None
+    """Eine SEPA-Referenz"""

src/bo4e/com/zahlungsinformationen.py

@@ -68,6 +68,7 @@ class ComTyp(StrEnum):
     VERWENDUNGSZWECKPROMARKTROLLE = "VERWENDUNGSZWECKPROMARKTROLLE"
     ZAEHLWERK = "ZAEHLWERK"
     ZAEHLZEITREGISTER = "ZAEHLZEITREGISTER"
+    ZAHLUNGSINFORMATION = "ZAHLUNGSINFORMATION"
     ZEITRAUM = "ZEITRAUM"
     ZEITREIHENWERT = "ZEITREIHENWERT"
     ZUSTAENDIGKEIT = "ZUSTAENDIGKEIT"

src/bo4e/enum/comtyp.py

@@ -0,0 +1,12 @@
+# pylint:disable=missing-module-docstring
+
+from bo4e.enum.strenum import StrEnum
+
+
+class Zahlungsart(StrEnum):
+    """
+    Gibt an, um was für eine Zahlungsart es sich handelt.
+    """
+
+    SEPA_LASTSCHRIFT = "SEPA_LASTSCHRIFT"
+    UEBERWEISUNG = "UEBERWEISUNG"