✨ add support for financial document v1.14, US healthcare cards v1.3 & invoice v4.11 (#241)

Author: sebastianMindee

docs/energy_bill_fra_v1.md

@@ -60,58 +60,58 @@ public class SimpleMindeeClient {
 ########
 Document
 ########
-:Mindee ID: 17f0ccef-e3fe-4a28-838d-d704489d6ce7
+:Mindee ID: ff1f2ca8-4d29-44d8-a564-599a982a4ef7
 :Filename: default_sample.pdf
 
 Inference
 #########
-:Product: mindee/energy_bill_fra v1.0
-:Rotation applied: No
+:Product: mindee/energy_bill_fra v1.2
+:Rotation applied: Yes
 
 Prediction
 ==========
-:Invoice Number: 10123590373
-:Contract ID: 1234567890
+:Invoice Number: 1234567890
+:Contract ID: 9876543210
 :Delivery Point: 98765432109876
 :Invoice Date: 2021-01-29
 :Due Date: 2021-02-15
 :Total Before Taxes: 1241.03
 :Total Taxes: 238.82
 :Total Amount: 1479.85
 :Energy Supplier:
-  :Address: TSA 12345, 12345 DEMOCITY CEDEX, 75001 PARIS
+  :Address: TSA 12345, 12345 DEMOCITY CEDEX
   :Name: EDF
 :Energy Consumer:
-  :Address: 12 AVENUE DES RÊVES, RDC A 123 COUR FAUSSE A, 75000 PARIS
-  :Name: John Doe
+  :Address: 123 RUE DE L'IMAGINAIRE, 75001 PARIS
+  :Name: JOHN DOE
 :Subscription:
   +--------------------------------------+------------+------------+----------+-----------+------------+
   | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
   +======================================+============+============+==========+===========+============+
   | Abonnement électricité               | 2021-02-28 | 2021-01-01 | 5.50     | 59.00     | 29.50      |
   +--------------------------------------+------------+------------+----------+-----------+------------+
 :Energy Usage:
-  +--------------------------------------+------------+------------+----------+-----------+------------+
-  | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
-  +======================================+============+============+==========+===========+============+
-  | Consommation (HT)                    | 2021-01-27 | 2020-11-28 | 20.00    | 898.43    | 10.47      |
-  +--------------------------------------+------------+------------+----------+-----------+------------+
+  +-------------+--------------------------------------+------------+------------+----------+-----------+-----------------+------------+
+  | Consumption | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit of Measure | Unit Price |
+  +=============+======================================+============+============+==========+===========+=================+============+
+  | 8581.00     | Consommation électricité             | 2021-01-27 | 2020-11-28 | 20.00    | 898.43    | kWh             | 0.1047     |
+  +-------------+--------------------------------------+------------+------------+----------+-----------+-----------------+------------+
 :Taxes and Contributions:
   +--------------------------------------+------------+------------+----------+-----------+------------+
   | Description                          | End Date   | Start Date | Tax Rate | Total     | Unit Price |
   +======================================+============+============+==========+===========+============+
-  | Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00    | 193.07    | 2.25       |
+  | Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00    | 193.07    | 0.0225     |
   +--------------------------------------+------------+------------+----------+-----------+------------+
-  | Départementale sur la Conso Final... | 2020-12-31 | 2020-11-28 | 20.00    | 13.98     | 0.3315     |
+  | Taxe Départementale sur la Conso ... | 2021-01-27 | 2020-11-28 | 20.00    | 13.98     | 0.003315   |
   +--------------------------------------+------------+------------+----------+-----------+------------+
-  | Communale sur la Conso Finale Ele... | 2021-01-27 | 2021-01-01 | 20.00    | 28.56     | 0.6545     |
+  | Taxe Communale sur la Conso Final... | 2021-01-27 | 2020-11-28 | 20.00    | 28.56     | 0.006545   |
   +--------------------------------------+------------+------------+----------+-----------+------------+
-  | Contribution Tarifaire d'Achemine... | 2020-12-31 | 2020-11-28 | 20.00    | 27.96     | 0.663      |
+  | Taxe Communale sur la Conso Final... | 2021-01-27 | 2020-11-28 | 20.00    | 27.96     | 0.00663    |
   +--------------------------------------+------------+------------+----------+-----------+------------+
 :Meter Details:
   :Meter Number: 620
   :Meter Type: electricity
-  :Unit of Measure: kWh
+  :Unit of Power: 36kVA
 ```
 
 # Field Types

docs/expense_receipts_v5.md

@@ -279,6 +279,9 @@ The following fields are extracted for Receipt V5:
  - 'gasoline'
  - 'telecom'
  - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
@@ -335,6 +338,15 @@ System.out.println(result.getDocument().getInference().getPrediction().getReceip
  - 'train'
  - 'restaurant'
  - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
  - null
 
 ```java

docs/financial_document_v1.md

@@ -107,12 +107,12 @@ public class SimpleMindeeClient {
 ########
 Document
 ########
-:Mindee ID: a80ac0ee-26f6-4e2e-988a-960b240d5ba7
+:Mindee ID: f52333ab-811e-4647-993e-ad79e072afa3
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/financial_document v1.11
+:Product: mindee/financial_document v1.12
 :Rotation applied: Yes
 
 Prediction
@@ -148,6 +148,7 @@ Prediction
 :Shipping Address: 2019 Redbud Drive New York, NY 10011
 :Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
+:Document Type Extended: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
 :Total Tax: 9.75
@@ -200,6 +201,7 @@ Page 0
 :Shipping Address: 2019 Redbud Drive New York, NY 10011
 :Billing Address: 4312 Wood Road New York, NY 10031
 :Document Type: INVOICE
+:Document Type Extended: INVOICE
 :Purchase Subcategory:
 :Purchase Category: miscellaneous
 :Total Tax: 9.75
@@ -315,7 +317,7 @@ System.out.println(result.getDocument().getInference().getPrediction().getBillin
 ```
 
 ## Purchase Category
-**category**: The purchase category, only for receipts.
+**category**: The purchase category.
 
 #### Possible values include:
  - 'toll'
@@ -326,6 +328,9 @@ System.out.println(result.getDocument().getInference().getPrediction().getBillin
  - 'gasoline'
  - 'telecom'
  - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
 
 ```java
 System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
@@ -477,14 +482,23 @@ System.out.println(result.getDocument().getInference().getPrediction().getShippi
 ```
 
 ## Purchase Subcategory
-**subcategory**: The purchase subcategory for transport and food, only for receipts.
+**subcategory**: The purchase subcategory for transport, food and shooping.
 
 #### Possible values include:
  - 'plane'
  - 'taxi'
  - 'train'
  - 'restaurant'
  - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
  - null
 
 ```java

docs/ind_passport_v1.md

@@ -65,7 +65,7 @@ Document
 
 Inference
 #########
-:Product: mindee/ind_passport v1.0
+:Product: mindee/ind_passport v1.2
 :Rotation applied: Yes
 
 Prediction
@@ -88,10 +88,10 @@ Prediction
 :Name of Mother:
 :Old Passport Date of Issue:
 :Old Passport Number:
+:Old Passport Place of Issue:
 :Address Line 1:
 :Address Line 2:
 :Address Line 3:
-:Old Passport Place of Issue:
 :File Number:
 ```
 

docs/invoices_v4.md

@@ -107,12 +107,12 @@ public class SimpleMindeeClient {
 ########
 Document
 ########
-:Mindee ID: b55db8f9-ae3b-4f05-b2f1-ec0ced5e5b70
+:Mindee ID: 3e524d26-f7dc-4852-9bbf-833a127a9570
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.9
+:Product: mindee/invoices v4.10
 :Rotation applied: Yes
 
 Prediction
@@ -147,6 +147,7 @@ Prediction
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
+:Document Type Extended: INVOICE
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
   | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -193,6 +194,7 @@ Page 0
 :Shipping Address:
 :Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
 :Document Type: INVOICE
+:Document Type Extended: INVOICE
 :Line Items:
   +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
   | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -302,6 +304,25 @@ The following fields are extracted for Invoice V4:
 System.out.println(result.getDocument().getInference().getPrediction().getBillingAddress().value);
 ```
 
+## Purchase Category
+**category**: The purchase category.
+
+#### Possible values include:
+ - 'toll'
+ - 'food'
+ - 'parking'
+ - 'transport'
+ - 'accommodation'
+ - 'telecom'
+ - 'miscellaneous'
+ - 'software'
+ - 'shopping'
+ - 'energy'
+
+```java
+System.out.println(result.getDocument().getInference().getPrediction().getCategory().value);
+```
+
 ## Customer Address
 **customerAddress**: The address of the customer.
 
@@ -431,6 +452,30 @@ for (referenceNumbersElem : result.getDocument().getInference().getPrediction().
 System.out.println(result.getDocument().getInference().getPrediction().getShippingAddress().value);
 ```
 
+## Purchase Subcategory
+**subcategory**: The purchase subcategory for transport, food and shopping.
+
+#### Possible values include:
+ - 'plane'
+ - 'taxi'
+ - 'train'
+ - 'restaurant'
+ - 'shopping'
+ - 'other'
+ - 'groceries'
+ - 'cultural'
+ - 'electronics'
+ - 'office_supplies'
+ - 'micromobility'
+ - 'car_rental'
+ - 'public'
+ - 'delivery'
+ - null
+
+```java
+System.out.println(result.getDocument().getInference().getPrediction().getSubcategory().value);
+```
+
 ## Supplier Address
 **supplierAddress**: The address of the supplier or merchant.
 

docs/us_healthcare_cards_v1.md

@@ -60,13 +60,13 @@ public class SimpleMindeeClient {
 ########
 Document
 ########
-:Mindee ID: 0ced9f49-00c0-4a1d-8221-4a1538813a95
+:Mindee ID: 1e71d5f0-dedb-4070-9d94-9207cd9570b5
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/us_healthcare_cards v1.0
-:Rotation applied: No
+:Product: mindee/us_healthcare_cards v1.2
+:Rotation applied: Yes
 
 Prediction
 ==========
@@ -81,21 +81,22 @@ Prediction
 :Group Number: 98765
 :Payer ID: 87726
 :RX BIN: 610279
+:RX ID:
 :RX GRP: UHEALTH
 :RX PCN: 9999
 :copays:
-  +--------------+--------------+
-  | Service Fees | Service Name |
-  +==============+==============+
-  | 20.00        | office visit |
-  +--------------+--------------+
-  | 300.00       | emergency    |
-  +--------------+--------------+
-  | 75.00        | urgent care  |
-  +--------------+--------------+
-  | 30.00        | specialist   |
-  +--------------+--------------+
-:Enrollment Date: 2023-09-13
+  +--------------+----------------------+
+  | Service Fees | Service Name         |
+  +==============+======================+
+  | 300.00       | emergency_room       |
+  +--------------+----------------------+
+  | 20.00        | office_visit         |
+  +--------------+----------------------+
+  | 75.00        | urgent_care          |
+  +--------------+----------------------+
+  | 30.00        | specialist           |
+  +--------------+----------------------+
+:Enrollment Date:
 ```
 
 # Field Types
@@ -129,13 +130,13 @@ The date field `DateField` extends `BaseField`, but also implements:
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
-### copays Field
-Is a fixed amount for a covered service.
+### Copays Field
+Copayments for covered services.
 
 A `HealthcareCardV1Copay` implements the following attributes:
 
-* **serviceFees** (`Double`): The price of service.
-* **serviceName** (`String`): The name of service of the copay.
+* **serviceFees** (`Double`): The price of the service.
+* **serviceName** (`String`): The name of the service.
 
 #### Possible values include:
  - primary_care
@@ -156,8 +157,8 @@ The following fields are extracted for Healthcare Card V1:
 System.out.println(result.getDocument().getInference().getPrediction().getCompanyName().value);
 ```
 
-## copays
-**copays**(List<[HealthcareCardV1Copay](#copays-field)>): Is a fixed amount for a covered service.
+## Copays
+**copays**(List<[HealthcareCardV1Copay](#copays-field)>): Copayments for covered services.
 
 ```java
 for (copaysElem : result.getDocument().getInference().getPrediction().getCopays())
@@ -218,6 +219,13 @@ System.out.println(result.getDocument().getInference().getPrediction().getMember
 System.out.println(result.getDocument().getInference().getPrediction().getPayerId().value);
 ```
 
+## Plan Name
+**planName**: The name of the healthcare plan.
+
+```java
+System.out.println(result.getDocument().getInference().getPrediction().getPlanName().value);
+```
+
 ## RX BIN
 **rxBin**: The BIN number for prescription drug coverage.