mikrowerk-edi-invoicing 0.5.0__tar.gz → 0.6.0__tar.gz

{mikrowerk_edi_invoicing-0.5.0/mikrowerk_edi_invoicing.egg-info → mikrowerk_edi_invoicing-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mikrowerk_edi_invoicing
-Version: 0.5.0
+Version: 0.6.0
 Summary: Parser for EDI invoices in CII or UBL format or plain pdf with LLM support
 Author: Mikrowerk a Gammadata Division
 Author-email: info@mikrowerk.com

mikrowerk_edi_invoicing-0.6.0/edi_invoice_parser/__init__.py

@@ -0,0 +1,19 @@
+from .cross_industry_invoice_mapper import parse_and_map_x_rechnung
+from .model.trade_document_types import TradeDocument, TradeParty, TradePartyAddress, TradeCurrency, TradePartyContact, \
+    TradeLine, TradePaymentMeans, AppliedTradeTax, BankAccount, FinancialCard, ubl_doc_codes
+
+__all__ = ["parse_and_map_x_rechnung",
+           "TradeDocument",
+           "TradeParty",
+           "TradePartyAddress",
+           "TradeCurrency",
+           "TradePartyContact",
+           "TradeLine",
+           "TradePaymentMeans",
+           "AppliedTradeTax",
+           "BankAccount",
+           "FinancialCard",
+           "ubl_doc_codes"
+           ]
+
+version = "0.5.0"

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/cii_dom_parser/xml_cii_dom_parser.py

@@ -4,46 +4,46 @@ This implements a mapper from a drafthorse parsed x-rechnung-xml to the internal
 from datetime import datetime
 
 from .models.document import Document
-
+from ..model.trade_document_types import (TradeDocument, TradeParty, TradeCurrency, TradeLine, TradePaymentMeans,
+                                          AppliedTradeTax, TradePartyAddress, TradePartyContact, BankAccount,
+                                          FinancialCard)
 from ..model.xml_abstract_x_rechnung_parser import XMLAbstractXRechnungParser
-from ..model.x_rechnung import (XRechnung, XRechnungCurrency, XRechnungTradeParty, XRechnungTradeAddress,
-                                XRechnungTradeContact, XRechnungPaymentMeans, XRechnungFinancialCard,
-                                XRechnungTradeLine, XRechnungAppliedTradeTax, XRechnungBankAccount)
 
 
 class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
 
     @classmethod
-    def parse_and_map_x_rechnung(cls, _xml: any) -> XRechnung:
+    def parse_and_map_x_rechnung(cls, _xml: any) -> TradeDocument:
         doc = Document.parse(_xml)
         return cls().map_to_x_rechnung(doc)
 
     @classmethod
-    def map_to_x_rechnung(cls, doc: any) -> XRechnung:
+    def map_to_x_rechnung(cls, doc: any) -> TradeDocument:
         """
         :param doc: Element, the parsed dom root element
         :return:
         """
 
-        return XRechnung(
+        return TradeDocument(
             name=f"{cls().TYPE_CODES.get(doc.header.type_code.get_string(), 'Unknown doc type ')} {doc.header.id.get_string()}",
+            doc_type_name=f"{cls().TYPE_CODES.get(doc.header.type_code.get_string(), 'Unknown doc type ')}",
             doc_id=doc.header.id.get_string(),
             doc_type_code=doc.header.type_code.get_string(),
             issued_date_time=doc.header.issue_date_time.get_value(),
             notes=doc.header.notes.get_string_elements("\n"),
             languages=doc.header.languages.get_string_elements(";"),
-            buyer_reference=doc.trade.agreement.buyer_reference.get_string(),
+            receiver_reference=doc.trade.agreement.buyer_reference.get_string(),
             order_reference=doc.trade.agreement.buyer_order.issuer_assigned_id.get_string(),
             currency_code=doc.trade.settlement.currency_code.get_string(),
             line_total_amount=doc.trade.settlement.monetary_summation.line_total.get_value(),
             charge_total_amount=doc.trade.settlement.monetary_summation.charge_total.get_value(),
             allowance_total_amount=doc.trade.settlement.monetary_summation.allowance_total.get_value(),
-            tax_basis_total_amount=XRechnungCurrency.from_currency_tuple(
+            tax_basis_total_amount=TradeCurrency.from_currency_tuple(
                 doc.trade.settlement.monetary_summation.tax_basis_total.get_currency()),
-            tax_total_amount=[XRechnungCurrency.from_currency_tuple(tpl) for tpl in
+            tax_total_amount=[TradeCurrency.from_currency_tuple(tpl) for tpl in
                               doc.trade.settlement.monetary_summation.tax_total_other_currency.get_currencies()],
             # list of currency
-            grand_total_amount=XRechnungCurrency.from_currency_tuple(
+            grand_total_amount=TradeCurrency.from_currency_tuple(
                 doc.trade.settlement.monetary_summation.grand_total.get_currency()),
             total_prepaid_amount=doc.trade.settlement.monetary_summation.prepaid_total.get_value(),
             due_payable_amount=doc.trade.settlement.monetary_summation.due_amount.get_value(),
@@ -51,11 +51,12 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
             payment_means=cls().map_payment_means(
                 doc.trade.settlement.payment_means) if doc.trade.settlement.payment_means else None,
             payment_terms=doc.trade.settlement.terms.get_string_elements("\n"),
-            seller=cls().map_trade_party(doc.trade.agreement.seller) if hasattr(doc.trade.agreement,
+            sender=cls().map_trade_party(doc.trade.agreement.seller) if hasattr(doc.trade.agreement,
                                                                                 "seller") else None,
             invoicee=cls().map_trade_party(doc.trade.agreement.invoicee) if hasattr(doc.trade.agreement,
                                                                                     "invoicee") else None,
-            buyer=cls().map_trade_party(doc.trade.agreement.buyer) if hasattr(doc.trade.agreement, "buyer") else None,
+            receiver=cls().map_trade_party(doc.trade.agreement.buyer) if hasattr(doc.trade.agreement,
+                                                                                 "buyer") else None,
             payee=cls().map_trade_party(doc.trade.agreement.payee) if hasattr(doc.trade.agreement, "payee") else None,
             trade_line_items=cls().map_trade_line_items(doc.trade.items) if hasattr(doc.trade, "items") else None,
             applicable_trade_taxes=cls().map_trade_taxes(doc.trade.settlement.trade_tax) if hasattr(
@@ -64,9 +65,9 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @classmethod
-    def map_trade_party(cls, trade_party: any) -> XRechnungTradeParty:
+    def map_trade_party(cls, trade_party: any) -> TradeParty:
         _global_id_schema, _global_id = cls().map_first_id(trade_party.global_id)
-        return XRechnungTradeParty(
+        return TradeParty(
             name=trade_party.name.get_string(),
             description=trade_party.description.get_string(),
             global_id=_global_id,
@@ -77,8 +78,8 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
                 trade_party, 'tax_registrations') else None,
             fiscal_registration_number=cls().map_tax_registration(trade_party.tax_registrations, 'FC') if hasattr(
                 trade_party, 'tax_registrations') else None,
-            postal_address=cls().map_trade_address(trade_party.address) if hasattr(trade_party, 'address') else None,
-            trade_contact=cls().map_trade_contact(trade_party.contact) if hasattr(trade_party, 'contact') else None,
+            address=cls().map_trade_address(trade_party.address) if hasattr(trade_party, 'address') else None,
+            contact=cls().map_trade_contact(trade_party.contact) if hasattr(trade_party, 'contact') else None,
             id=trade_party.id.get_string() if hasattr(trade_party, 'id') else None,
         )
 
@@ -111,8 +112,8 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         return None
 
     @staticmethod
-    def map_trade_address(trade_address: any) -> XRechnungTradeAddress:
-        return XRechnungTradeAddress(
+    def map_trade_address(trade_address: any) -> TradePartyAddress:
+        return TradePartyAddress(
             city_name=trade_address.city_name.get_string(),
             country_id=trade_address.country_id.get_string(),
             country_subdivision_id=trade_address.country_subdivision.get_string(),
@@ -123,8 +124,8 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @staticmethod
-    def map_trade_contact(trade_contact: any) -> XRechnungTradeContact:
-        return XRechnungTradeContact(
+    def map_trade_contact(trade_contact: any) -> TradePartyContact:
+        return TradePartyContact(
             name=trade_contact.person_name.get_string(),
             email=trade_contact.email.get_string(),
             telephone=trade_contact.telephone.get_string(),
@@ -133,8 +134,8 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @staticmethod
-    def map_bank_account(payment_means: any) -> XRechnungBankAccount:
-        return XRechnungBankAccount(
+    def map_bank_account(payment_means: any) -> BankAccount:
+        return BankAccount(
             iban="".join(payment_means.payee_account.iban.get_string().split()) if (hasattr(payment_means,
                                                                                             'payee_account')
                                                                                     and payment_means.payee_account.iban.get_string()) else None,
@@ -144,15 +145,15 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @staticmethod
-    def map_financial_card(financial_card: any) -> XRechnungFinancialCard:
-        return XRechnungFinancialCard(
+    def map_financial_card(financial_card: any) -> FinancialCard:
+        return FinancialCard(
             id=financial_card.id.get_string(),
             cardholder_name=financial_card.cardholder_name.get_string(),
         )
 
     @classmethod
-    def map_payment_means(cls, payment_means: any) -> XRechnungPaymentMeans:
-        return XRechnungPaymentMeans(
+    def map_payment_means(cls, payment_means: any) -> TradePaymentMeans:
+        return TradePaymentMeans(
             information=payment_means.information.get_string(),
             type_code=payment_means.type_code.get_string(),
             payee_account=cls().map_bank_account(payment_means) if hasattr(payment_means, 'payee_account') else None,
@@ -161,8 +162,8 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @staticmethod
-    def map_trade_tax(trade_tax: any) -> XRechnungAppliedTradeTax:
-        return XRechnungAppliedTradeTax(
+    def map_trade_tax(trade_tax: any) -> AppliedTradeTax:
+        return AppliedTradeTax(
             type_code=trade_tax.type_code.get_string(),
             name=f"{trade_tax.type_code.get_string()} {trade_tax.rate_applicable_percent.get_value()}",
             category_code=trade_tax.category_code.get_string(),
@@ -172,33 +173,33 @@ class XRechnungCIIXMLParser(XMLAbstractXRechnungParser):
         )
 
     @classmethod
-    def map_trade_taxes(cls, trade_taxes: any) -> [XRechnungTradeLine]:
+    def map_trade_taxes(cls, trade_taxes: any) -> [TradeLine]:
         res = []
         for child in trade_taxes.children:
             res.append(cls().map_trade_tax(child))
         return res
 
     @classmethod
-    def map_trade_line(cls, trade_line: any) -> XRechnungTradeLine:
-        return XRechnungTradeLine(
+    def map_trade_line(cls, trade_line: any) -> TradeLine:
+        return TradeLine(
             name=trade_line.product.name.get_string(),
             description=trade_line.product.description.get_string(),
             line_id=trade_line.document.line_id.get_string(),
-            price_unit=trade_line.agreement.net.amount.get_value(),
-            price_unit_gross=trade_line.agreement.gross.amount.get_value(),
-            quantity_billed=trade_line.delivery.billed_quantity.get_value(),
+            unit_price=trade_line.agreement.net.amount.get_value(),
+            unit_price_gross=trade_line.agreement.gross.amount.get_value(),
+            quantity=trade_line.delivery.billed_quantity.get_value(),
             global_product_id=trade_line.product.global_id.get_string(),
-            total_amount_net=trade_line.settlement.monetary_summation.total_amount.get_value(),
+            total_amount=trade_line.settlement.monetary_summation.total_amount.get_value(),
             total_allowance_charge=trade_line.settlement.monetary_summation.total_allowance_charge.get_value(),
             quantity_unit_code=trade_line.delivery.billed_quantity._unit_code,
             seller_assigned_id=trade_line.product.seller_assigned_id.get_string(),
             buyer_assigned_id=trade_line.product.buyer_assigned_id.get_string(),
             global_product_scheme_id=trade_line.product.global_id._scheme_id,
-            trade_tax=cls().map_trade_tax(trade_line.settlement.trade_tax)
+            tax=cls().map_trade_tax(trade_line.settlement.trade_tax)
         )
 
     @classmethod
-    def map_trade_line_items(cls, trade_line_items: any) -> [XRechnungTradeLine]:
+    def map_trade_line_items(cls, trade_line_items: any) -> [TradeLine]:
         res = []
         for child in trade_line_items.children:
             res.append(cls().map_trade_line(child))

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/cross_industry_invoice_mapper.py

@@ -3,12 +3,12 @@ This implements a mapper from a drafthorse parsed x-rechnung-xml to the internal
 """
 from lxml import etree
 
-from .model.x_rechnung import XRechnung
+from .model.trade_document_types import TradeDocument
 from .cii_dom_parser import XRechnungCIIXMLParser
 from .ubl_sax_parser.xml_ubl_sax_parser import XRechnungUblXMLParser
 
 
-def parse_and_map_x_rechnung(_xml: bytes) -> XRechnung:
+def parse_and_map_x_rechnung(_xml: bytes) -> TradeDocument:
     """
 
     Args:

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/model/__init__.py

@@ -1,17 +1,15 @@
-from .x_rechnung import XRechnung
 from .trade_document_types import TradeDocument, TradeParty, TradePartyAddress, TradeCurrency, TradePartyContact, \
-    TradeLine, PaymentMeans, AppliedTradeTax, BankAccount, FinancialCard, ubl_doc_codes
+    TradeLine, TradePaymentMeans, AppliedTradeTax, BankAccount, FinancialCard, ubl_doc_codes
 from .xml_abstract_x_rechnung_parser import XMLAbstractXRechnungParser
 
-__all__ = ["XRechnung",
-           "XMLAbstractXRechnungParser",
+__all__ = ["XMLAbstractXRechnungParser",
            "TradeDocument",
            "TradeParty",
            "TradePartyAddress",
            "TradeCurrency",
            "TradePartyContact",
            "TradeLine",
-           "PaymentMeans",
+           "TradePaymentMeans",
            "AppliedTradeTax",
            "BankAccount",
            "FinancialCard",

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/model/trade_document_types.py

@@ -1,5 +1,4 @@
 from dataclasses import dataclass
-from decimal import Decimal
 import datetime
 
 """
@@ -38,7 +37,7 @@ class TradePartyAddress:
 
 @dataclass
 class TradePartyContact:
-    name: str
+    name: str = None
     department_name: str = None
     telephone: str = None
     fax: str = None
@@ -47,47 +46,63 @@ class TradePartyContact:
 
 @dataclass
 class TradeParty:
-    name: str
-    vat_registration_number: str = None
-    fiscal_registration_number: str = None
-    legal_registration_number: str = None
-    address: TradePartyAddress = None
-    contact: TradePartyContact = None
+    name: str= None
+    description: str = None  # 'Description'
+    global_id: int = 0  # 'Global ID'
+    global_id_schema: str = None  # 'Global Schema'
+    id: str = None  # 'id'
+    address: TradePartyAddress | None = None
+    contact: TradePartyContact | None = None
+    email: str = None  # 'Email'
+    vat_registration_number: str | None = None
+    fiscal_registration_number: str | None = None
+    legal_registration_number: str | None = None
 
 
 @dataclass
 class AppliedTradeTax:
-    name: str
+    name: str = None
     type_code: str = None
     category_code: str = None
-    applicable_percent: Decimal = None
-    basis_amount: Decimal = None
-    calculated_amount: Decimal = None
+    applicable_percent: float = None
+    basis_amount: float = None
+    calculated_amount: float = None
 
 
 @dataclass
 class TradeLine:
-    pos_number: int
-    article_code: str = None
-    name: str = None
-    description: str = None
-    quantity: Decimal = None
-    unit_of_measure: str = None
-    unit_price: Decimal = None
-    total_net: Decimal = None
-    tax: AppliedTradeTax = None
-    total_amount: Decimal = None
+    line_id: int = 0
+    article_code: str | None = None
+    name: str | None = None
+    description: str | None = None
+    quantity: float = None
+    quantity_unit_code: str = None
+    unit_price: float = None
+    unit_price_gross: float = None
+    total_net: float = None
+    tax: AppliedTradeTax | None = None
+    total_amount_net: float = None
+    total_amount: float = None
+    total_allowance_charge: float = None
+    global_product_id: str = None  # 'Global Product ID')
+    global_product_scheme_id: str = None  # 'Global Product Scheme ID')
+    seller_assigned_id: str = None  # 'Seller Assigned ID')
+    buyer_assigned_id: str = None  # 'Buyer Assigned ID')
 
 
 @dataclass
 class TradeCurrency:
-    amount: Decimal
+    amount: float
     currency_code: str
 
+    @staticmethod
+    def from_currency_tuple(currency_tuple: tuple) -> 'TradeCurrency':
+        return TradeCurrency(*currency_tuple)
+
 
 @dataclass
 class BankAccount:
-    iban: str
+    iban: str | None = None
     bic: str = None
     name: str = None
 
@@ -99,7 +114,7 @@ class FinancialCard:
 
 
 @dataclass
-class PaymentMeans:
+class TradePaymentMeans:
     id: str = None
     type_code: str = None
     information: str = None
@@ -112,28 +127,34 @@ class TradeDocument:
     """
     Model of a Trade Document
     """
-    name: str
-    doc_type_code: tuple  # Document Type Code: ubl_doc_codes
+    name: str = None
+    doc_type_code: int = 0  # Document Type Code: ubl_doc_codes
+    doc_type_name: str = None
     doc_id: str = None
+    project: str = None
     issued_date_time: datetime = None  # 'Date'
+    delivered_date_time: datetime = None  # 'Delivered Date'
     languages: str = None  # 'Languages'
     notes: str = None  # 'Notes'
     sender_reference: str = None  # 'Buyer Reference'
-    receiver_reference: str = None
-    dispatch_reference: str = None
-    sales_order_reference: str = None
+    receiver_reference: str | None = None
+    dispatch_reference: str | None = None
+    order_reference: str | None = None
     sender: TradeParty = None
     receiver: TradeParty = None
+    payee: TradeParty = None
+    invoicee: TradeParty = None
     currency_code: str = None  # 'Currency Code'
-    payment_means: PaymentMeans = None
-    payment_terms: str = None  # 'Payment Terms'
-    line_total_amount: Decimal = None  # 'Line Total Amount'
-    charge_total_amount: Decimal = None  # 'Charge Total Amount'
-    allowance_total_amount: Decimal = None  # 'Allowance Total Amount'
-    tax_basis_total_amount: Decimal = None
-    tax_total_amount: Decimal = None  # 'Tax Grand Total Amount'
-    grand_total_amount: Decimal = None  # 'Grand Total Amount'
-    total_prepaid_amount: Decimal = None  # 'Total Prepaid Amount'
-    due_payable_amount: Decimal = None  # 'Due Payable Amount'
+    payment_means: TradePaymentMeans = None
+    payment_terms: str | None = None  # 'Payment Terms'
+    due_date_time: datetime = None
+    line_total_amount: float = None  # 'Line Total Amount'
+    charge_total_amount: float = None  # 'Charge Total Amount'
+    allowance_total_amount: float = None  # 'Allowance Total Amount'
+    tax_basis_total_amount: TradeCurrency = None
+    tax_total_amount: [TradeCurrency] = None  # 'Tax Grand Total Amount'
+    grand_total_amount: TradeCurrency = None  # 'Grand Total Amount'
+    total_prepaid_amount: float = None  # 'Total Prepaid Amount'
+    due_payable_amount: float = None  # 'Due Payable Amount'
     trade_line_items: [TradeLine] = None
     applicable_trade_taxes: [AppliedTradeTax] = None

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/model/xml_abstract_x_rechnung_parser.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from ..model.x_rechnung import XRechnung
+from ..model.trade_document_types import TradeDocument
 
 
 class XMLAbstractXRechnungParser(ABC):
@@ -17,5 +17,5 @@ class XMLAbstractXRechnungParser(ABC):
 
     @staticmethod
     @abstractmethod
-    def parse_and_map_x_rechnung(_xml: any) -> XRechnung:
+    def parse_and_map_x_rechnung(_xml: any) -> TradeDocument:
         pass

mikrowerk_edi_invoicing-0.6.0/edi_invoice_parser/tests/__init__.py

@@ -0,0 +1,3 @@
+from ..util.file_helper import get_checked_file_path
+from ..model.trade_document_types import TradeDocument
+__all__ = ["get_checked_file_path", "TradeDocument"]

{mikrowerk_edi_invoicing-0.5.0 → mikrowerk_edi_invoicing-0.6.0}/edi_invoice_parser/tests/test_parse_x_rechnung.py

@@ -6,7 +6,7 @@ from facturx import get_facturx_xml_from_pdf
 
 from . import get_checked_file_path
 from edi_invoice_parser.cross_industry_invoice_mapper import parse_and_map_x_rechnung
-from . import XRechnung
+from . import TradeDocument
 
 
 class XRechnungEinfachTestCase(unittest.TestCase):
@@ -51,10 +51,10 @@ class XRechnungEinfachTestCase(unittest.TestCase):
         else:
             raise AssertionError(f'File type {file_type} not supported')
         assert _parsed is not None
-        res_dict = _parsed.map_to_dict()
-        print(jsonpickle.dumps(res_dict))
+        # res_dict = _parsed.map_to_dict()
+        print(jsonpickle.dumps(_parsed))
 
-    def _parse_xml(self, filepath) -> XRechnung:
+    def _parse_xml(self, filepath) -> TradeDocument:
         _file_path, _exists, _is_dir = get_checked_file_path(filepath, __file__)
         self.assertTrue(_exists)
         print(f"\n_parse_xml: file_path={_file_path}")
@@ -64,7 +64,7 @@ class XRechnungEinfachTestCase(unittest.TestCase):
             self.assertIsNotNone(res)
             return res
 
-    def _parse_pdf(self, filepath) -> XRechnung:
+    def _parse_pdf(self, filepath) -> TradeDocument:
         _file_path, _exists, _is_dir = get_checked_file_path(filepath, __file__)
         self.assertTrue(_exists)
         print(f"\n_parse_pdf: file_path={_file_path}")