✨ Add Invoice V4 (clearer field names, line items) (#107)

Author: ianardee

mindee/__main__.py

@@ -24,7 +24,7 @@ class CommandConfig(Generic[TypeDoc]):
     ),
     "invoice": CommandConfig(
         help="Invoice",
-        doc_class=documents.TypeInvoiceV3,
+        doc_class=documents.TypeInvoiceV4,
     ),
     "receipt": CommandConfig(
         help="Expense Receipt",

mindee/client.py

@@ -6,6 +6,7 @@
     CustomV1,
     FinancialV1,
     InvoiceV3,
+    InvoiceV4,
     PassportV1,
     ReceiptV3,
     ReceiptV4,
@@ -199,6 +200,15 @@ def _init_default_endpoints(self) -> None:
                     )
                 ],
             ),
+            (OTS_OWNER, InvoiceV4.__name__): DocumentConfig(
+                document_type="invoice_v4",
+                document_class=InvoiceV4,
+                endpoints=[
+                    StandardEndpoint(
+                        url_name="invoices_beta", version="4", api_key=self.api_key
+                    )
+                ],
+            ),
             (OTS_OWNER, ReceiptV3.__name__): DocumentConfig(
                 document_type="receipt_v3",
                 document_class=ReceiptV3,
@@ -209,7 +219,7 @@ def _init_default_endpoints(self) -> None:
                 ],
             ),
             (OTS_OWNER, ReceiptV4.__name__): DocumentConfig(
-                document_type="receipt_v3",
+                document_type="receipt_v4",
                 document_class=ReceiptV4,
                 endpoints=[
                     StandardEndpoint(

mindee/documents/__init__.py

@@ -2,6 +2,6 @@
 from mindee.documents.cropper import CropperV1, TypeCropperV1
 from mindee.documents.custom import CustomV1, TypeCustomV1
 from mindee.documents.financial import FinancialV1, TypeFinancialV1
-from mindee.documents.invoice import InvoiceV3, TypeInvoiceV3
+from mindee.documents.invoice import InvoiceV3, InvoiceV4, TypeInvoiceV3, TypeInvoiceV4
 from mindee.documents.passport import PassportV1, TypePassportV1
 from mindee.documents.receipt import ReceiptV3, ReceiptV4, TypeReceiptV3, TypeReceiptV4

mindee/documents/invoice/__init__.py

@@ -1 +1,2 @@
 from .invoice_v3 import InvoiceV3, TypeInvoiceV3
+from .invoice_v4 import InvoiceV4, TypeInvoiceV4

mindee/documents/invoice/checks.py

@@ -0,0 +1,116 @@
+def taxes_match_total_incl(doc) -> bool:
+    """
+    Check invoice matching rule between taxes and total_incl.
+
+    :return: True if rule matches, False otherwise
+    """
+    # Ensure taxes and total_incl exist
+    if not doc.taxes or not doc.total_amount.value:
+        return False
+
+    # Reconstruct total_incl from taxes
+    total_vat = 0.0
+    reconstructed_total = 0.0
+    for tax in doc.taxes:
+        if tax.value is None or tax.rate is None or tax.rate == 0:
+            return False
+        total_vat += tax.value
+        reconstructed_total += tax.value + 100 * tax.value / tax.rate
+
+    # Sanity check
+    if total_vat <= 0:
+        return False
+
+    # Crate epsilon
+    eps = 1 / (100 * total_vat)
+    if (
+        doc.total_amount.value * (1 - eps) - 0.02
+        <= reconstructed_total
+        <= doc.total_amount.value * (1 + eps) + 0.02
+    ):
+        for tax in doc.taxes:
+            tax.confidence = 1
+        doc.total_tax.confidence = 1.0
+        doc.total_amount.confidence = 1.0
+        return True
+    return False
+
+
+def taxes_match_total_excl(doc) -> bool:
+    """
+    Check invoice matching rule between taxes and total_excl.
+
+    :return: True if rule matches, False otherwise
+    """
+    # Check taxes and total excl exist
+    if len(doc.taxes) == 0 or doc.total_net.value is None:
+        return False
+
+    # Reconstruct total excl from taxes
+    total_vat = 0.0
+    reconstructed_total = 0.0
+    for tax in doc.taxes:
+        if tax.value is None or tax.rate is None or tax.rate == 0:
+            return False
+        total_vat += tax.value
+        reconstructed_total += 100 * tax.value / tax.rate
+
+    # Sanity check
+    if total_vat <= 0:
+        return False
+
+    # Crate epsilon
+    eps = 1 / (100 * total_vat)
+    # Check that reconstructed total excl matches total excl
+    if (
+        doc.total_net.value * (1 - eps) - 0.02
+        <= reconstructed_total
+        <= doc.total_net.value * (1 + eps) + 0.02
+    ):
+        for tax in doc.taxes:
+            tax.confidence = 1
+        doc.total_tax.confidence = 1.0
+        doc.total_net.confidence = 1.0
+        return True
+    return False
+
+
+def taxes_plus_total_excl_match_total_incl(doc) -> bool:
+    """
+    Check invoice matching rule.
+
+    Rule is: sum(taxes) + total_excluding_taxes = total_including_taxes
+    :return: True if rule matches, False otherwise
+    """
+    # Check total_tax, total excl and total incl exist
+    if (
+        doc.total_net.value is None
+        or len(doc.taxes) == 0
+        or doc.total_amount.value is None
+    ):
+        return False
+
+    # Reconstruct total_incl
+    total_vat = 0.0
+    for tax in doc.taxes:
+        if tax.value is not None:
+            total_vat += tax.value
+    reconstructed_total = total_vat + doc.total_net.value
+
+    # Sanity check
+    if total_vat <= 0:
+        return False
+
+    # Check that reconstructed total incl matches total excl + taxes sum
+    if (
+        doc.total_amount.value - 0.01
+        <= reconstructed_total
+        <= doc.total_amount.value + 0.01
+    ):
+        for tax in doc.taxes:
+            tax.confidence = 1
+        doc.total_tax.confidence = 1.0
+        doc.total_net.confidence = 1.0
+        doc.total_amount.confidence = 1.0
+        return True
+    return False