✨ update Invoice to v4.5 (#225)

Author: ianardee

docs/extras/guide/invoices_v4.md

@@ -205,6 +205,13 @@ A `InvoiceV4LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Invoice V4:
 
+## Billing Address
+**billing_address** ([StringField](#stringfield)): The customer's address used for billing.
+
+```py
+print(result.document.inference.prediction.billing_address.value)
+```
+
 ## Customer Address
 **customer_address** ([StringField](#stringfield)): The address of the customer.
 
@@ -278,6 +285,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
     print(reference_numbers_elem.value)
 ```
 
+## Shipping Address
+**shipping_address** ([StringField](#stringfield)): Customer's delivery address.
+
+```py
+print(result.document.inference.prediction.shipping_address.value)
+```
+
 ## Supplier Address
 **supplier_address** ([StringField](#stringfield)): The address of the supplier or merchant.
 

mindee/product/invoice/invoice_v4_document.py

@@ -17,6 +17,8 @@
 class InvoiceV4Document(Prediction):
     """Document data for Invoice, API version 4."""
 
+    billing_address: StringField
+    """The customer's address used for billing."""
     customer_address: StringField
     """The address of the customer."""
     customer_company_registrations: List[CompanyRegistrationField]
@@ -37,6 +39,8 @@ class InvoiceV4Document(Prediction):
     """The locale detected on the document."""
     reference_numbers: List[StringField]
     """List of Reference numbers, including PO number."""
+    shipping_address: StringField
+    """Customer's delivery address."""
     supplier_address: StringField
     """The address of the supplier or merchant."""
     supplier_company_registrations: List[CompanyRegistrationField]
@@ -66,6 +70,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.customer_address = StringField(
             raw_prediction["customer_address"],
             page_id=page_id,
@@ -106,6 +114,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.supplier_address = StringField(
             raw_prediction["supplier_address"],
             page_id=page_id,
@@ -202,6 +214,8 @@ def __str__(self) -> str:
             f":Customer Company Registrations: {customer_company_registrations}\n"
         )
         out_str += f":Customer Address: {self.customer_address}\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":Line Items: {self._line_items_to_str()}\n"
         return clean_out_string(out_str)

tests/data

@@ -71,4 +71,6 @@ def test_empty_doc(empty_doc: Document[InvoiceV4Document, Page[InvoiceV4Document
     assert prediction.customer_name.value is None
     assert len(prediction.customer_company_registrations) == 0
     assert prediction.customer_address.value is None
+    assert prediction.shipping_address.value is None
+    assert prediction.billing_address.value is None
     assert len(prediction.line_items) == 0