✨ update invoice to 4.6 & financial document to 1.6 (#269)

Author: sebastianMindee

docs/financial_document_v1.md

@@ -36,20 +36,20 @@ apiResponse.then((resp) => {
 ########
 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
@@ -65,8 +65,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
@@ -81,18 +86,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
@@ -108,8 +113,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
@@ -124,7 +134,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      |
   +--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
 ```
 
@@ -219,6 +229,13 @@ A `FinancialDocumentV1LineItem` implements the following attributes:
 # Attributes
 The following fields are extracted for Financial Document V1:
 
+## Billing Address
+**billingAddress** ([StringField](#string-field)): The customer's address used for billing.
+
+```js
+console.log(result.document.inference.prediction.billingAddress.value);
+```
+
 ## Purchase Category
 **category** ([ClassificationField](#classification-field)): The purchase category among predefined classes.
 
@@ -242,6 +259,13 @@ for (const customerCompanyRegistrationsElem of result.document.inference.predict
 }
 ```
 
+## Customer ID
+**customerId** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```js
+console.log(result.document.inference.prediction.customerId.value);
+```
+
 ## Customer Name
 **customerName** ([StringField](#string-field)): The name of the customer.
 
@@ -302,6 +326,13 @@ for (const referenceNumbersElem of result.document.inference.prediction.referenc
 }
 ```
 
+## Shipping Address
+**shippingAddress** ([StringField](#string-field)): The customer's address used for shipping.
+
+```js
+console.log(result.document.inference.prediction.shippingAddress.value);
+```
+
 ## Purchase Subcategory
 **subcategory** ([ClassificationField](#classification-field)): The purchase subcategory among predefined classes for transport and food.
 
@@ -325,6 +356,13 @@ for (const supplierCompanyRegistrationsElem of result.document.inference.predict
 }
 ```
 
+## Supplier Email
+**supplierEmail** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```js
+console.log(result.document.inference.prediction.supplierEmail.value);
+```
+
 ## Supplier Name
 **supplierName** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -351,6 +389,13 @@ for (const supplierPaymentDetailsElem of result.document.inference.prediction.su
 console.log(result.document.inference.prediction.supplierPhoneNumber.value);
 ```
 
+## Supplier Website
+**supplierWebsite** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```js
+console.log(result.document.inference.prediction.supplierWebsite.value);
+```
+
 ## Taxes
 **taxes** ([TaxField](#taxes-field)[]): List of tax lines information.
 

docs/invoices_v4.md

@@ -36,12 +36,12 @@ apiResponse.then((resp) => {
 ########
 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
@@ -50,7 +50,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
@@ -63,10 +63,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: [email protected]
 :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
@@ -90,7 +94,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
@@ -103,10 +107,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: [email protected]
 :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
@@ -236,6 +244,13 @@ for (const customerCompanyRegistrationsElem of result.document.inference.predict
 }
 ```
 
+## Customer ID
+**customerId** ([StringField](#string-field)): The customer account number or identifier from the supplier.
+
+```js
+console.log(result.document.inference.prediction.customerId.value);
+```
+
 ## Customer Name
 **customerName** ([StringField](#string-field)): The name of the customer or client.
 
@@ -319,6 +334,13 @@ for (const supplierCompanyRegistrationsElem of result.document.inference.predict
 }
 ```
 
+## Supplier Email
+**supplierEmail** ([StringField](#string-field)): The email of the supplier or merchant.
+
+```js
+console.log(result.document.inference.prediction.supplierEmail.value);
+```
+
 ## Supplier Name
 **supplierName** ([StringField](#string-field)): The name of the supplier or merchant.
 
@@ -338,6 +360,20 @@ for (const supplierPaymentDetailsElem of result.document.inference.prediction.su
 }
 ```
 
+## Supplier Phone Number
+**supplierPhoneNumber** ([StringField](#string-field)): The phone number of the supplier or merchant.
+
+```js
+console.log(result.document.inference.prediction.supplierPhoneNumber.value);
+```
+
+## Supplier Website
+**supplierWebsite** ([StringField](#string-field)): The website URL of the supplier or merchant.
+
+```js
+console.log(result.document.inference.prediction.supplierWebsite.value);
+```
+
 ## Taxes
 **taxes** ([TaxField](#taxes-field)[]): List of tax line details.
 

src/product/barcodeReader/barcodeReaderV1.ts

@@ -2,7 +2,7 @@ import { Inference, StringDict, Page } from "../../parsing/common";
 import { BarcodeReaderV1Document } from "./barcodeReaderV1Document";
 
 /**
- * Inference prediction for Barcode Reader, API version 1.
+ * Barcode Reader API version 1 inference prediction.
  */
 export class BarcodeReaderV1 extends Inference {
   /** The endpoint's name. */

src/product/barcodeReader/barcodeReaderV1Document.ts

@@ -6,7 +6,7 @@ import {
 import { StringField } from "../../parsing/standard";
 
 /**
- * Document data for Barcode Reader, API version 1.
+ * Barcode Reader API version 1.0 document data.
  */
 export class BarcodeReaderV1Document implements Prediction {
   /** List of decoded 1D barcodes. */

src/product/cropper/cropperV1.ts

@@ -3,7 +3,7 @@ import { CropperV1Document } from "./cropperV1Document";
 import { CropperV1Page } from "./cropperV1Page";
 
 /**
- * Inference prediction for Cropper, API version 1.
+ * Cropper API version 1 inference prediction.
  */
 export class CropperV1 extends Inference {
   /** The endpoint's name. */

src/product/cropper/cropperV1Document.ts

@@ -2,7 +2,7 @@ import { Prediction } from "../../parsing/common";
 
 
 /**
- * Document data for Cropper, API version 1.
+ * Cropper API version 1.1 document data.
  */
 export class CropperV1Document implements Prediction {
   /**

src/product/cropper/cropperV1Page.ts

@@ -4,7 +4,7 @@ import { PositionField } from "../../parsing/standard";
 import { CropperV1Document } from "./cropperV1Document";
 
 /**
- * Page data for Cropper, API version 1.
+ * Cropper API version 1.1 page data.
  */
 export class CropperV1Page extends CropperV1Document {
   /** List of documents found in the image. */

src/product/eu/driverLicense/driverLicenseV1.ts

@@ -3,7 +3,7 @@ import { DriverLicenseV1Document } from "./driverLicenseV1Document";
 import { DriverLicenseV1Page } from "./driverLicenseV1Page";
 
 /**
- * Inference prediction for Driver License, API version 1.
+ * Driver License API version 1 inference prediction.
  */
 export class DriverLicenseV1 extends Inference {
   /** The endpoint's name. */

src/product/eu/driverLicense/driverLicenseV1Document.ts

@@ -6,7 +6,7 @@ import {
 import { DateField, StringField } from "../../../parsing/standard";
 
 /**
- * Document data for Driver License, API version 1.
+ * Driver License API version 1.0 document data.
  */
 export class DriverLicenseV1Document implements Prediction {
   /** EU driver license holders address */

src/product/eu/driverLicense/driverLicenseV1Page.ts

@@ -4,7 +4,7 @@ import { PositionField } from "../../../parsing/standard";
 import { DriverLicenseV1Document } from "./driverLicenseV1Document";
 
 /**
- * Page data for Driver License, API version 1.
+ * Driver License API version 1.0 page data.
  */
 export class DriverLicenseV1Page extends DriverLicenseV1Document {
   /** Has a photo of the EU driver license holder */