✨ update financial document to 1.7 & receipt to 5.2 (#234)

Author: sebastianMindee

docs/extras/guide/expense_receipts_v5.md

@@ -220,6 +220,13 @@ for line_items_elem in result.document.inference.prediction.line_items:
 print(result.document.inference.prediction.locale.value)
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#stringfield)): The receipt number or identifier.
+
+```py
+print(result.document.inference.prediction.receipt_number.value)
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classificationfield)): The purchase subcategory among predefined classes for transport and food.
 

docs/extras/guide/financial_document_v1.md

@@ -275,6 +275,13 @@ print(result.document.inference.prediction.customer_name.value)
 print(result.document.inference.prediction.date.value)
 ```
 
+## Document Number
+**document_number** ([StringField](#stringfield)): The document number or identifier.
+
+```py
+print(result.document.inference.prediction.document_number.value)
+```
+
 ## Document Type
 **document_type** ([ClassificationField](#classificationfield)): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
 
@@ -290,7 +297,7 @@ print(result.document.inference.prediction.due_date.value)
 ```
 
 ## Invoice Number
-**invoice_number** ([StringField](#stringfield)): The invoice number or identifier.
+**invoice_number** ([StringField](#stringfield)): The invoice number or identifier only if document is an invoice.
 
 ```py
 print(result.document.inference.prediction.invoice_number.value)
@@ -311,6 +318,13 @@ for line_items_elem in result.document.inference.prediction.line_items:
 print(result.document.inference.prediction.locale.value)
 ```
 
+## Receipt Number
+**receipt_number** ([StringField](#stringfield)): The receipt number or identifier only if document is a receipt.
+
+```py
+print(result.document.inference.prediction.receipt_number.value)
+```
+
 ## Reference Numbers
 **reference_numbers** (List[[StringField](#stringfield)]): List of Reference numbers, including PO number.
 

mindee/product/financial_document/financial_document_v1_document.py

@@ -17,7 +17,7 @@
 
 
 class FinancialDocumentV1Document(Prediction):
-    """Financial Document API version 1.6 document data."""
+    """Financial Document API version 1.7 document data."""
 
     billing_address: StringField
     """The customer's address used for billing."""
@@ -33,16 +33,20 @@ class FinancialDocumentV1Document(Prediction):
     """The name of the customer."""
     date: DateField
     """The date the purchase was made."""
+    document_number: StringField
+    """The document number or identifier."""
     document_type: ClassificationField
     """One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'."""
     due_date: DateField
     """The date on which the payment is due."""
     invoice_number: StringField
-    """The invoice number or identifier."""
+    """The invoice number or identifier only if document is an invoice."""
     line_items: List[FinancialDocumentV1LineItem]
     """List of line item details."""
     locale: LocaleField
     """The locale detected on the document."""
+    receipt_number: StringField
+    """The receipt number or identifier only if document is a receipt."""
     reference_numbers: List[StringField]
     """List of Reference numbers, including PO number."""
     shipping_address: StringField
@@ -116,6 +120,10 @@ def __init__(
             raw_prediction["date"],
             page_id=page_id,
         )
+        self.document_number = StringField(
+            raw_prediction["document_number"],
+            page_id=page_id,
+        )
         self.document_type = ClassificationField(
             raw_prediction["document_type"],
             page_id=page_id,
@@ -136,6 +144,10 @@ def __init__(
             raw_prediction["locale"],
             page_id=page_id,
         )
+        self.receipt_number = StringField(
+            raw_prediction["receipt_number"],
+            page_id=page_id,
+        )
         self.reference_numbers = [
             StringField(prediction, page_id=page_id)
             for prediction in raw_prediction["reference_numbers"]
@@ -246,6 +258,8 @@ def __str__(self) -> str:
         )
         out_str: str = f":Locale: {self.locale}\n"
         out_str += f":Invoice Number: {self.invoice_number}\n"
+        out_str += f":Receipt Number: {self.receipt_number}\n"
+        out_str += f":Document Number: {self.document_number}\n"
         out_str += f":Reference Numbers: {reference_numbers}\n"
         out_str += f":Purchase Date: {self.date}\n"
         out_str += f":Due Date: {self.due_date}\n"

mindee/product/receipt/receipt_v5_document.py

@@ -14,7 +14,7 @@
 
 
 class ReceiptV5Document(Prediction):
-    """Receipt API version 5.1 document data."""
+    """Receipt API version 5.2 document data."""
 
     category: ClassificationField
     """The purchase category among predefined classes."""
@@ -26,6 +26,8 @@ class ReceiptV5Document(Prediction):
     """List of line item details."""
     locale: LocaleField
     """The locale detected on the document."""
+    receipt_number: StringField
+    """The receipt number or identifier."""
     subcategory: ClassificationField
     """The purchase subcategory among predefined classes for transport and food."""
     supplier_address: StringField
@@ -81,6 +83,10 @@ def __init__(
             raw_prediction["locale"],
             page_id=page_id,
         )
+        self.receipt_number = StringField(
+            raw_prediction["receipt_number"],
+            page_id=page_id,
+        )
         self.subcategory = ClassificationField(
             raw_prediction["subcategory"],
             page_id=page_id,
@@ -171,5 +177,6 @@ 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":Receipt Number: {self.receipt_number}\n"
         out_str += f":Line Items: {self._line_items_to_str()}\n"
         return clean_out_string(out_str)

tests/data

@@ -55,4 +55,5 @@ def test_empty_doc(empty_doc: ReceiptV5DocumentType):
     assert len(prediction.supplier_company_registrations) == 0
     assert prediction.supplier_address.value is None
     assert prediction.supplier_phone_number.value is None
+    assert prediction.receipt_number.value is None
     assert len(prediction.line_items) == 0