Add COM Vorauszahlung

Author: lord-haffi

src/bo4e/__init__.py

@@ -101,6 +101,7 @@
     "Vertragskonditionen",
     "Vertragsteil",
     "VerwendungszweckProMarktrolle",
+    "Vorauszahlung",
     "Zaehlwerk",
     "Zaehlzeitregister",
     "Zahlungsinformation",
@@ -304,6 +305,7 @@
 from .com.vertragskonditionen import Vertragskonditionen
 from .com.vertragsteil import Vertragsteil
 from .com.verwendungszweckpromarktrolle import VerwendungszweckProMarktrolle
+from .com.vorauszahlung import Vorauszahlung
 from .com.zaehlwerk import Zaehlwerk
 from .com.zaehlzeitregister import Zaehlzeitregister
 from .com.zahlungsinformation import Zahlungsinformation

src/bo4e/bo/rechnung.py

@@ -15,6 +15,7 @@
     from ..com.betrag import Betrag
     from ..com.rechnungsposition import Rechnungsposition
     from ..com.steuerbetrag import Steuerbetrag
+    from ..com.vorauszahlung import Vorauszahlung
     from ..com.zahlungsinformation import Zahlungsinformation
     from ..com.zeitraum import Zeitraum
     from ..enum.netznutzungrechnungsart import NetznutzungRechnungsart
@@ -79,36 +80,35 @@ class Rechnung(Geschaeftsobjekt):
     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  #!
+    vorauszahlungen: Optional[list["Vorauszahlung"]] = None
     """Die Summe evtl. vorausgezahlter Beträge, z.B. Abschläge. Angabe als Bruttowert"""
     rabatt_netto: Optional["Betrag"] = None
     """Gesamtrabatt auf den Nettobetrag"""
-    steuerbetraege: Optional[list["Steuerbetrag"]] = None  #!
+    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  #!
+    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.

src/bo4e/com/vorauszahlung.py

@@ -0,0 +1,38 @@
+"""
+Contains Vorauszahlung class
+"""
+
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+from pydantic import AwareDatetime, Field
+
+from ..enum.comtyp import ComTyp
+from ..utils import postprocess_docstring
+from .com import COM
+
+if TYPE_CHECKING:
+    from .betrag import Betrag
+
+
+# pylint: disable=too-few-public-methods
+
+
+@postprocess_docstring
+class Vorauszahlung(COM):
+    """
+    Dient zur Identifizierung des Verwendungszwecks der Marktrolle an der Marktlokation, der die Werte zu übermitteln sind.
+
+    .. raw:: html
+
+        <object data="../_static/images/bo4e/com/Vorauszahlung.svg" type="image/svg+xml"></object>
+
+    .. HINT::
+        `Vorauszahlung JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Vorauszahlung.json>`_
+
+    """
+
+    typ: Annotated[Literal[ComTyp.VORAUSZAHLUNG], Field(alias="_typ")] = ComTyp.VORAUSZAHLUNG
+
+    betrag: Optional["Betrag"] = None
+    datum: Optional[AwareDatetime] = None
+    referenz: Optional[str] = None

src/bo4e/enum/comtyp.py

@@ -66,6 +66,7 @@ class ComTyp(StrEnum):
     VERTRAGSKONDITIONEN = "VERTRAGSKONDITIONEN"
     VERTRAGSTEIL = "VERTRAGSTEIL"
     VERWENDUNGSZWECKPROMARKTROLLE = "VERWENDUNGSZWECKPROMARKTROLLE"
+    VORAUSZAHLUNG = "VORAUSZAHLUNG"
     ZAEHLWERK = "ZAEHLWERK"
     ZAEHLZEITREGISTER = "ZAEHLZEITREGISTER"
     ZAHLUNGSINFORMATION = "ZAHLUNGSINFORMATION"