⬆️ update invoice version to 4.4 (#21)

Author: sebastianMindee

docs/extras/guide/invoices_v4.md

@@ -30,12 +30,12 @@ echo strval($apiResponse->document);
 ########
 Document
 ########
-:Mindee ID: 16bd8752-8c4d-450f-8213-f33b2097504c
+:Mindee ID: 80f2328c-58a5-486a-9599-eb2d738680f0
 :Filename: default_sample.jpg
 
 Inference
 #########
-:Product: mindee/invoices v4.2
+:Product: mindee/invoices v4.4
 :Rotation applied: Yes
 
 Prediction
@@ -47,14 +47,15 @@ Prediction
 :Due Date: 2018-09-25
 :Total Net:
 :Total Amount: 2608.20
+:Total Tax: 193.20
 :Taxes:
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
   |               |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
-:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
 :Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
 :Customer Name: JIRO DOI
@@ -84,14 +85,15 @@ Page 0
 :Due Date: 2018-09-25
 :Total Net:
 :Total Amount: 2608.20
+:Total Tax: 193.20
 :Taxes:
   +---------------+--------+----------+---------------+
   | Base          | Code   | Rate (%) | Amount        |
   +===============+========+==========+===============+
   |               |        | 8.00     | 193.20        |
   +---------------+--------+----------+---------------+
 :Supplier Payment Details:
-:Supplier Name: TURNPIKE DESIGNS CO.
+:Supplier Name: TURNPIKE DESIGNS
 :Supplier Company Registrations:
 :Supplier Address: 156 University Ave, Toronto ON, Canada M5H 2H7
 :Customer Name: JIRO DOI
@@ -342,5 +344,12 @@ echo $result->document->inference->prediction->totalAmount->value;
 echo $result->document->inference->prediction->totalNet->value;
 ```
 
+## Total Tax
+**totalTax** : The total tax: includes all the taxes paid for this invoice.
+
+```php
+echo $result->document->inference->prediction->totalTax->value;
+```
+
 # Questions?
 [Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-1jv6nawjq-FDgFcF2T5CmMmRpl9LLptw)

src/Parsing/Standard/StringField.php

@@ -11,9 +11,13 @@ class StringField extends BaseField
     use FieldConfidenceMixin;
 
     /**
-     * @var string|null The value.
+     * @var string|null Value as string.
      */
     public $value;
+    /**
+     * @var string|null The value as it appears on the document.
+     */
+    public $rawValue;
 
 
     /**
@@ -30,5 +34,6 @@ public function __construct(
     ) {
         parent::__construct($rawPrediction, $pageId, $reconstructed, $valueKey);
         $this->setPosition($rawPrediction);
+        $this->rawValue = array_key_exists('raw_value', $rawPrediction) ? $rawPrediction['raw_value'] : null;
     }
 }

src/Product/Invoice/InvoiceV4Document.php

@@ -87,6 +87,10 @@ class InvoiceV4Document extends Prediction
     * @var AmountField The net amount paid: does not include taxes, fees, and discounts.
     */
     public AmountField $totalNet;
+    /**
+    * @var AmountField The total tax: includes all the taxes paid for this invoice.
+    */
+    public AmountField $totalTax;
     /**
      * @param array        $rawPrediction Raw prediction from HTTP response.
      * @param integer|null $pageId        Page number for multi pages document.
@@ -213,6 +217,13 @@ public function __construct(array $rawPrediction, ?int $pageId = null)
             $rawPrediction["total_net"],
             $pageId
         );
+        if (!isset($rawPrediction["total_tax"])) {
+            throw new MindeeUnsetException();
+        }
+        $this->totalTax = new AmountField(
+            $rawPrediction["total_tax"],
+            $pageId
+        );
     }
 
     /**
@@ -245,6 +256,7 @@ public function __toString(): string
 :Due Date: $this->dueDate
 :Total Net: $this->totalNet
 :Total Amount: $this->totalAmount
+:Total Tax: $this->totalTax
 :Taxes: $this->taxes
 :Supplier Payment Details: $supplierPaymentDetails
 :Supplier Name: $this->supplierName

tests/Parsing/Standard/StringFieldTest.php

@@ -36,4 +36,43 @@ public function testConstructorFail()
         $field = new StringField($fieldArray);
         $this->assertNull($field->value);
     }
+
+    public function testConstructorNoRawValue()
+    {
+        $fieldArray = [
+            "value" => "hello world",
+            "confidence" => 0.1,
+            "polygon" => [
+                [0.016, 0.707],
+                [0.414, 0.707],
+                [0.414, 0.831],
+                [0.016, 0.831],
+            ],
+        ];
+
+        $field = new StringField($fieldArray);
+
+        $this->assertEquals("hello world", $field->value);
+        $this->assertNull($field->rawValue);
+    }
+
+    public function testConstructorRawValue()
+    {
+        $fieldArray = [
+            "value" => "hello world",
+            "raw_value" => "HelLO wOrld",
+            "confidence" => 0.1,
+            "polygon" => [
+                [0.016, 0.707],
+                [0.414, 0.707],
+                [0.414, 0.831],
+                [0.016, 0.831],
+            ],
+        ];
+
+        $field = new StringField($fieldArray);
+
+        $this->assertEquals("hello world", $field->value);
+        $this->assertEquals("HelLO wOrld", $field->rawValue);
+    }
 }

tests/Product/Invoice/InvoiceV4Test.php

@@ -40,6 +40,7 @@ public function testEmptyDoc()
         $this->assertNull($prediction->dueDate->value);
         $this->assertNull($prediction->totalNet->value);
         $this->assertNull($prediction->totalAmount->value);
+        $this->assertNull($prediction->totalTax->value);
         $this->assertEquals(0, count($prediction->taxes));
         $this->assertEquals(0, count($prediction->supplierPaymentDetails));
         $this->assertNull($prediction->supplierName->value);