✨ add support for financial document v1.6 and invoice 4.6 (#233)

Author: ianardee

docs/extras/guide/financial_document_v1.md

@@ -215,6 +215,13 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Financial Document V1:
 
+## Billing Address
+**billing_address** ([StringField](#stringfield)): The customer's address used for billing.
+
+```py
+print(result.document.inference.prediction.billing_address.value)
+```
+
 ## Purchase Category
 **category** ([ClassificationField](#classificationfield)): The purchase category among predefined classes.
 
@@ -237,6 +244,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
     print(customer_company_registrations_elem.value)
 ```
 
+## Customer ID
+**customer_id** ([StringField](#stringfield)): The customer account number or identifier from the supplier.
+
+```py
+print(result.document.inference.prediction.customer_id.value)
+```
+
 ## Customer Name
 **customer_name** ([StringField](#stringfield)): The name of the customer.
 
@@ -295,6 +309,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
     print(reference_numbers_elem.value)
 ```
 
+## Shipping Address
+**shipping_address** ([StringField](#stringfield)): The customer's address used for shipping.
+
+```py
+print(result.document.inference.prediction.shipping_address.value)
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
 
@@ -317,6 +338,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
     print(supplier_company_registrations_elem.value)
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#stringfield)): The email of the supplier or merchant.
+
+```py
+print(result.document.inference.prediction.supplier_email.value)
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#stringfield)): The name of the supplier or merchant.
 
@@ -339,6 +367,13 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
 print(result.document.inference.prediction.supplier_phone_number.value)
 ```
 
+## Supplier Website
+**supplier_website** ([StringField](#stringfield)): The website URL of the supplier or merchant.
+
+```py
+print(result.document.inference.prediction.supplier_website.value)
+```
+
 ## Taxes
 **taxes** (List[[TaxField](#taxes)]): List of tax lines information.
 

docs/extras/guide/invoices_v4.md

@@ -231,6 +231,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
     print(customer_company_registrations_elem.value)
 ```
 
+## Customer ID
+**customer_id** ([StringField](#stringfield)): The customer account number or identifier from the supplier.
+
+```py
+print(result.document.inference.prediction.customer_id.value)
+```
+
 ## Customer Name
 **customer_name** ([StringField](#stringfield)): The name of the customer or client.
 
@@ -311,6 +318,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
     print(supplier_company_registrations_elem.value)
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#stringfield)): The email of the supplier or merchant.
+
+```py
+print(result.document.inference.prediction.supplier_email.value)
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#stringfield)): The name of the supplier or merchant.
 
@@ -326,6 +340,20 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
     print(supplier_payment_details_elem.value)
 ```
 
+## Supplier Phone Number
+**supplier_phone_number** ([StringField](#stringfield)): The phone number of the supplier or merchant.
+
+```py
+print(result.document.inference.prediction.supplier_phone_number.value)
+```
+
+## Supplier Website
+**supplier_website** ([StringField](#stringfield)): The website URL of the supplier or merchant.
+
+```py
+print(result.document.inference.prediction.supplier_website.value)
+```
+
 ## Taxes
 **taxes** (List[[TaxField](#taxes)]): List of tax line details.
 

mindee/product/financial_document/financial_document_v1_document.py

@@ -19,12 +19,16 @@
 class FinancialDocumentV1Document(Prediction):
     """Document data for Financial Document, API version 1."""
 
+    billing_address: StringField
+    """The customer's address used for billing."""
     category: ClassificationField
     """The purchase category among predefined classes."""
     customer_address: StringField
     """The address of the customer."""
     customer_company_registrations: List[CompanyRegistrationField]
     """List of company registrations associated to the customer."""
+    customer_id: StringField
+    """The customer account number or identifier from the supplier."""
     customer_name: StringField
     """The name of the customer."""
     date: DateField
@@ -41,18 +45,24 @@ class FinancialDocumentV1Document(Prediction):
     """The locale detected on the document."""
     reference_numbers: List[StringField]
     """List of Reference numbers, including PO number."""
+    shipping_address: StringField
+    """The customer's address used for shipping."""
     subcategory: ClassificationField
     """The purchase subcategory among predefined classes for transport and food."""
     supplier_address: StringField
     """The address of the supplier or merchant."""
     supplier_company_registrations: List[CompanyRegistrationField]
     """List of company registrations associated to the supplier."""
+    supplier_email: StringField
+    """The email of the supplier or merchant."""
     supplier_name: StringField
     """The name of the supplier or merchant."""
     supplier_payment_details: List[PaymentDetailsField]
     """List of payment details associated to the supplier."""
     supplier_phone_number: StringField
     """The phone number of the supplier or merchant."""
+    supplier_website: StringField
+    """The website URL of the supplier or merchant."""
     taxes: Taxes
     """List of tax lines information."""
     time: StringField
@@ -78,6 +88,10 @@ def __init__(
         :param page_id: Page number for multi pages pdf input
         """
         super().__init__(raw_prediction, page_id)
+        self.billing_address = StringField(
+            raw_prediction["billing_address"],
+            page_id=page_id,
+        )
         self.category = ClassificationField(
             raw_prediction["category"],
             page_id=page_id,
@@ -90,6 +104,10 @@ def __init__(
             CompanyRegistrationField(prediction, page_id=page_id)
             for prediction in raw_prediction["customer_company_registrations"]
         ]
+        self.customer_id = StringField(
+            raw_prediction["customer_id"],
+            page_id=page_id,
+        )
         self.customer_name = StringField(
             raw_prediction["customer_name"],
             page_id=page_id,
@@ -122,6 +140,10 @@ def __init__(
             StringField(prediction, page_id=page_id)
             for prediction in raw_prediction["reference_numbers"]
         ]
+        self.shipping_address = StringField(
+            raw_prediction["shipping_address"],
+            page_id=page_id,
+        )
         self.subcategory = ClassificationField(
             raw_prediction["subcategory"],
             page_id=page_id,
@@ -134,6 +156,10 @@ def __init__(
             CompanyRegistrationField(prediction, page_id=page_id)
             for prediction in raw_prediction["supplier_company_registrations"]
         ]
+        self.supplier_email = StringField(
+            raw_prediction["supplier_email"],
+            page_id=page_id,
+        )
         self.supplier_name = StringField(
             raw_prediction["supplier_name"],
             page_id=page_id,
@@ -146,6 +172,10 @@ def __init__(
             raw_prediction["supplier_phone_number"],
             page_id=page_id,
         )
+        self.supplier_website = StringField(
+            raw_prediction["supplier_website"],
+            page_id=page_id,
+        )
         self.taxes = Taxes(raw_prediction["taxes"], page_id=page_id)
         self.time = StringField(
             raw_prediction["time"],
@@ -230,10 +260,15 @@ def __str__(self) -> str:
         out_str += f":Supplier Address: {self.supplier_address}\n"
         out_str += f":Supplier Phone Number: {self.supplier_phone_number}\n"
         out_str += f":Customer Name: {self.customer_name}\n"
+        out_str += f":Supplier Website: {self.supplier_website}\n"
+        out_str += f":Supplier Email: {self.supplier_email}\n"
         out_str += (
             f":Customer Company Registrations: {customer_company_registrations}\n"
         )
         out_str += f":Customer Address: {self.customer_address}\n"
+        out_str += f":Customer ID: {self.customer_id}\n"
+        out_str += f":Shipping Address: {self.shipping_address}\n"
+        out_str += f":Billing Address: {self.billing_address}\n"
         out_str += f":Document Type: {self.document_type}\n"
         out_str += f":Purchase Subcategory: {self.subcategory}\n"
         out_str += f":Purchase Category: {self.category}\n"

mindee/product/invoice/invoice_v4.py

@@ -5,7 +5,7 @@
 
 
 class InvoiceV4(Inference):
-    """Inference prediction for Invoice, API version 4."""
+    """Invoice API version 4 inference prediction."""
 
     prediction: InvoiceV4Document
     """Document-level prediction."""

mindee/product/invoice/invoice_v4_document.py

@@ -15,14 +15,16 @@
 
 
 class InvoiceV4Document(Prediction):
-    """Document data for Invoice, API version 4."""
+    """Invoice API version 4.6 document data."""
 
     billing_address: StringField
     """The customer's address used for billing."""
     customer_address: StringField
     """The address of the customer."""
     customer_company_registrations: List[CompanyRegistrationField]
     """List of company registrations associated to the customer."""
+    customer_id: StringField
+    """The customer account number or identifier from the supplier."""
     customer_name: StringField
     """The name of the customer or client."""
     date: DateField
@@ -45,10 +47,16 @@ class InvoiceV4Document(Prediction):
     """The address of the supplier or merchant."""
     supplier_company_registrations: List[CompanyRegistrationField]
     """List of company registrations associated to the supplier."""
+    supplier_email: StringField
+    """The email of the supplier or merchant."""
     supplier_name: StringField
     """The name of the supplier or merchant."""
     supplier_payment_details: List[PaymentDetailsField]
     """List of payment details associated to the supplier."""
+    supplier_phone_number: StringField
+    """The phone number of the supplier or merchant."""
+    supplier_website: StringField
+    """The website URL of the supplier or merchant."""
     taxes: Taxes
     """List of tax line details."""
     total_amount: AmountField
@@ -82,6 +90,10 @@ def __init__(
             CompanyRegistrationField(prediction, page_id=page_id)
             for prediction in raw_prediction["customer_company_registrations"]
         ]
+        self.customer_id = StringField(
+            raw_prediction["customer_id"],
+            page_id=page_id,
+        )
         self.customer_name = StringField(
             raw_prediction["customer_name"],
             page_id=page_id,
@@ -126,6 +138,10 @@ def __init__(
             CompanyRegistrationField(prediction, page_id=page_id)
             for prediction in raw_prediction["supplier_company_registrations"]
         ]
+        self.supplier_email = StringField(
+            raw_prediction["supplier_email"],
+            page_id=page_id,
+        )
         self.supplier_name = StringField(
             raw_prediction["supplier_name"],
             page_id=page_id,
@@ -134,6 +150,14 @@ def __init__(
             PaymentDetailsField(prediction, page_id=page_id)
             for prediction in raw_prediction["supplier_payment_details"]
         ]
+        self.supplier_phone_number = StringField(
+            raw_prediction["supplier_phone_number"],
+            page_id=page_id,
+        )
+        self.supplier_website = StringField(
+            raw_prediction["supplier_website"],
+            page_id=page_id,
+        )
         self.taxes = Taxes(raw_prediction["taxes"], page_id=page_id)
         self.total_amount = AmountField(
             raw_prediction["total_amount"],
@@ -209,11 +233,15 @@ def __str__(self) -> str:
             f":Supplier Company Registrations: {supplier_company_registrations}\n"
         )
         out_str += f":Supplier Address: {self.supplier_address}\n"
+        out_str += f":Supplier Phone Number: {self.supplier_phone_number}\n"
+        out_str += f":Supplier Website: {self.supplier_website}\n"
+        out_str += f":Supplier Email: {self.supplier_email}\n"
         out_str += f":Customer Name: {self.customer_name}\n"
         out_str += (
             f":Customer Company Registrations: {customer_company_registrations}\n"
         )
         out_str += f":Customer Address: {self.customer_address}\n"
+        out_str += f":Customer ID: {self.customer_id}\n"
         out_str += f":Shipping Address: {self.shipping_address}\n"
         out_str += f":Billing Address: {self.billing_address}\n"
         out_str += f":Document Type: {self.document_type}\n"