✨ update financial document to v1.6 & invoice to v4.6

Author: sebastianMindee

docs/financial_document_v1.md

@@ -34,20 +34,20 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: a6b54e2d-a7fa-4e08-8de6-6cd296f50f3d
+:Mindee ID: 503895c6-eced-42e2-a6fc-0292b7ccf680
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.2
+:Product: mindee/financial_document v1.6
 :Rotation applied: Yes
 
 Prediction
 ==========
-:Locale: en; en; USD;
+:Locale: en; USD;
 :Invoice Number: INT-001
 :Reference Numbers: 2412/2019
-:Purchase Date: 2019-02-11
+:Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
@@ -63,8 +63,13 @@ Prediction
 :Supplier Address: 4490 Oak Drive Albany, NY 12210
 :Supplier Phone Number:
 :Customer Name: JESSIE M HORNE
+:Supplier Website:
+:Supplier Email:
 :Customer Company Registrations:
 :Customer Address: 2019 Redbud Drive New York, NY 10011
+:Customer ID: 1234567890
+:Shipping Address: 2019 Redbud Drive New York, NY 10011
+:Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
@@ -79,18 +84,18 @@ Prediction
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
   | New set of pedal arms                |              | 2.00     |            |              | 50.00        | 25.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Labon 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
+  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 
 Page Predictions
 ================
 
 Page 0
 ------
-:Locale: en; en; USD;
+:Locale: en; USD;
 :Invoice Number: INT-001
 :Reference Numbers: 2412/2019
-:Purchase Date: 2019-02-11
+:Purchase Date: 2019-11-02
 :Due Date: 2019-02-26
 :Total Net: 195.00
 :Total Amount: 204.75
@@ -106,8 +111,13 @@ Page 0
 :Supplier Address: 4490 Oak Drive Albany, NY 12210
 :Supplier Phone Number:
 :Customer Name: JESSIE M HORNE
+:Supplier Website:
+:Supplier Email:
 :Customer Company Registrations:
 :Customer Address: 2019 Redbud Drive New York, NY 10011
+:Customer ID: 1234567890
+:Shipping Address: 2019 Redbud Drive New York, NY 10011
+:Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
@@ -122,7 +132,7 @@ Page 0
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
   | New set of pedal arms                |              | 2.00     |            |              | 50.00        | 25.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
-  | Labon 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
+  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        | 15.00      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 ```
 
@@ -215,6 +225,13 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Financial Document V1:
 
+## Billing Address
+**billing_address** ([StringField](#string-field)): The customer's address used for billing.
+
+```rb
+puts result.document.inference.prediction.billing_address.value
+```
+
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
@@ -238,6 +255,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Customer ID
+**customer_id** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```rb
+puts result.document.inference.prediction.customer_id.value
+```
+
 ## Customer Name
 **customer_name** ([StringField](#string-field)): The name of the customer.
 
@@ -298,6 +322,13 @@ for reference_numbers_elem in result.document.inference.prediction.reference_num
 end
 ```
 
+## Shipping Address
+**shipping_address** ([StringField](#string-field)): The customer's address used for shipping.
+
+```rb
+puts result.document.inference.prediction.shipping_address.value
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
@@ -321,6 +352,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_email.value
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -347,6 +385,13 @@ end
 puts result.document.inference.prediction.supplier_phone_number.value
 ```
 
+## Supplier Website
+**supplier_website** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_website.value
+```
+
 ## Taxes
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax lines information.
 

docs/invoices_v4.md

@@ -34,12 +34,12 @@ puts result.document
 ########
 Document
 ########
-:Mindee ID: a9062dd1-0d34-42ab-9505-0481a8545106
+:Mindee ID: 5c0371d0-1433-43a4-b8fb-a3b11aaf9a0e
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.5
+:Product: mindee/invoices v4.6
 :Rotation applied: Yes
 
 Prediction
@@ -48,7 +48,7 @@ Prediction
 :Invoice Number: 14
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2018-09-25
+:Due Date:
 :Total Net:
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -61,10 +61,14 @@ Prediction
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
-:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
+:Supplier Phone Number: 4165551212
+:Supplier Website:
+:Supplier Email: i_doi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Customer ID:
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
@@ -88,7 +92,7 @@ Page 0
 :Invoice Number: 14
 :Reference Numbers: AD29094
 :Purchase Date: 2018-09-25
-:Due Date: 2018-09-25
+:Due Date:
 :Total Net:
 :Total Amount: 2608.20
 :Total Tax: 193.20
@@ -101,10 +105,14 @@ Page 0
 :Supplier Payment Details:
 :Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
-:Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
+:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
+:Supplier Phone Number: 4165551212
+:Supplier Website:
+:Supplier Email: i_doi@example.com
 :Customer Name: JIRO DOI
 :Customer Company Registrations:
 :Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
+:Customer ID:
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
@@ -232,6 +240,13 @@ for customer_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Customer ID
+**customer_id** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```rb
+puts result.document.inference.prediction.customer_id.value
+```
+
 ## Customer Name
 **customer_name** ([StringField](#string-field)): The name of the customer or client.
 
@@ -315,6 +330,13 @@ for supplier_company_registrations_elem in result.document.inference.prediction.
 end
 ```
 
+## Supplier Email
+**supplier_email** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_email.value
+```
+
 ## Supplier Name
 **supplier_name** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -334,6 +356,20 @@ for supplier_payment_details_elem in result.document.inference.prediction.suppli
 end
 ```
 
+## Supplier Phone Number
+**supplier_phone_number** ([StringField](#string-field)): The phone number of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_phone_number.value
+```
+
+## Supplier Website
+**supplier_website** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```rb
+puts result.document.inference.prediction.supplier_website.value
+```
+
 ## Taxes
 **taxes** (Array<[TaxField](#taxes-field)>): List of tax line details.
 

lib/mindee/product/financial_document/financial_document_v1.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Financial Document module.
     module FinancialDocument
-      # Financial Document V1 prediction inference.
+      # Financial Document API version 1 inference prediction.
       class FinancialDocumentV1 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'financial_document'
         @endpoint_version = '1'

lib/mindee/product/financial_document/financial_document_v1_document.rb

@@ -6,9 +6,12 @@
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document V1 document prediction.
+      # Financial Document API version 1.6 document data.
       class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         include Mindee::Parsing::Standard
+        # The customer's address used for billing.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :billing_address
         # The purchase category among predefined classes.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :category
@@ -18,6 +21,9 @@ class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         # List of company registrations associated to the customer.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :customer_company_registrations
+        # The customer account number or identifier from the supplier.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :customer_id
         # The name of the customer.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :customer_name
@@ -42,6 +48,9 @@ class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         # List of Reference numbers, including PO number.
         # @return [Array<Mindee::Parsing::Standard::StringField>]
         attr_reader :reference_numbers
+        # The customer's address used for shipping.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :shipping_address
         # The purchase subcategory among predefined classes for transport and food.
         # @return [Mindee::Parsing::Standard::ClassificationField]
         attr_reader :subcategory
@@ -51,6 +60,9 @@ class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         # List of company registrations associated to the supplier.
         # @return [Array<Mindee::Parsing::Standard::CompanyRegistrationField>]
         attr_reader :supplier_company_registrations
+        # The email of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_email
         # The name of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_name
@@ -60,6 +72,9 @@ class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         # The phone number of the supplier or merchant.
         # @return [Mindee::Parsing::Standard::StringField]
         attr_reader :supplier_phone_number
+        # The website URL of the supplier or merchant.
+        # @return [Mindee::Parsing::Standard::StringField]
+        attr_reader :supplier_website
         # List of tax lines information.
         # @return [Mindee::Parsing::Standard::Taxes]
         attr_reader :taxes
@@ -83,12 +98,14 @@ class FinancialDocumentV1Document < Mindee::Parsing::Common::Prediction
         # @param page_id [Integer, nil]
         def initialize(prediction, page_id)
           super()
+          @billing_address = StringField.new(prediction['billing_address'], page_id)
           @category = ClassificationField.new(prediction['category'], page_id)
           @customer_address = StringField.new(prediction['customer_address'], page_id)
           @customer_company_registrations = []
           prediction['customer_company_registrations'].each do |item|
             @customer_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @customer_id = StringField.new(prediction['customer_id'], page_id)
           @customer_name = StringField.new(prediction['customer_name'], page_id)
           @date = DateField.new(prediction['date'], page_id)
           @document_type = ClassificationField.new(prediction['document_type'], page_id)
@@ -103,18 +120,21 @@ def initialize(prediction, page_id)
           prediction['reference_numbers'].each do |item|
             @reference_numbers.push(StringField.new(item, page_id))
           end
+          @shipping_address = StringField.new(prediction['shipping_address'], page_id)
           @subcategory = ClassificationField.new(prediction['subcategory'], page_id)
           @supplier_address = StringField.new(prediction['supplier_address'], page_id)
           @supplier_company_registrations = []
           prediction['supplier_company_registrations'].each do |item|
             @supplier_company_registrations.push(CompanyRegistrationField.new(item, page_id))
           end
+          @supplier_email = StringField.new(prediction['supplier_email'], page_id)
           @supplier_name = StringField.new(prediction['supplier_name'], page_id)
           @supplier_payment_details = []
           prediction['supplier_payment_details'].each do |item|
             @supplier_payment_details.push(PaymentDetailsField.new(item, page_id))
           end
           @supplier_phone_number = StringField.new(prediction['supplier_phone_number'], page_id)
+          @supplier_website = StringField.new(prediction['supplier_website'], page_id)
           @taxes = Taxes.new(prediction['taxes'], page_id)
           @time = StringField.new(prediction['time'], page_id)
           @tip = AmountField.new(prediction['tip'], page_id)
@@ -145,8 +165,13 @@ def to_s
           out_str << "\n:Supplier Address: #{@supplier_address}".rstrip
           out_str << "\n:Supplier Phone Number: #{@supplier_phone_number}".rstrip
           out_str << "\n:Customer Name: #{@customer_name}".rstrip
+          out_str << "\n:Supplier Website: #{@supplier_website}".rstrip
+          out_str << "\n:Supplier Email: #{@supplier_email}".rstrip
           out_str << "\n:Customer Company Registrations: #{customer_company_registrations}".rstrip
           out_str << "\n:Customer Address: #{@customer_address}".rstrip
+          out_str << "\n:Customer ID: #{@customer_id}".rstrip
+          out_str << "\n:Shipping Address: #{@shipping_address}".rstrip
+          out_str << "\n:Billing Address: #{@billing_address}".rstrip
           out_str << "\n:Document Type: #{@document_type}".rstrip
           out_str << "\n:Purchase Subcategory: #{@subcategory}".rstrip
           out_str << "\n:Purchase Category: #{@category}".rstrip

lib/mindee/product/financial_document/financial_document_v1_page.rb

@@ -6,7 +6,7 @@
 module Mindee
   module Product
     module FinancialDocument
-      # Financial Document V1 page.
+      # Financial Document API version 1.6 page data.
       class FinancialDocumentV1Page < Mindee::Parsing::Common::Page
         # @param prediction [Hash]
         def initialize(prediction)

lib/mindee/product/invoice/invoice_v4.rb

@@ -8,7 +8,7 @@ module Mindee
   module Product
     # Invoice module.
     module Invoice
-      # Invoice V4 prediction inference.
+      # Invoice API version 4 inference prediction.
       class InvoiceV4 < Mindee::Parsing::Common::Inference
         @endpoint_name = 'invoices'
         @endpoint_version = '4'