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

Author: sebastianMindee

src/main/java/com/mindee/product/financialdocument/FinancialDocumentV1Document.java

@@ -20,7 +20,7 @@
 import lombok.Getter;
 
 /**
- * Financial Document API version 1.6 document data.
+ * Financial Document API version 1.7 document data.
  */
 @Getter
 @EqualsAndHashCode(callSuper = false)
@@ -62,6 +62,11 @@ public class FinancialDocumentV1Document extends Prediction {
    */
   @JsonProperty("date")
   private DateField date;
+  /**
+   * The document number or identifier.
+   */
+  @JsonProperty("document_number")
+  private StringField documentNumber;
   /**
    * One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
    */
@@ -73,7 +78,7 @@ public class FinancialDocumentV1Document extends Prediction {
   @JsonProperty("due_date")
   private DateField dueDate;
   /**
-   * The invoice number or identifier.
+   * The invoice number or identifier only if document is an invoice.
    */
   @JsonProperty("invoice_number")
   private StringField invoiceNumber;
@@ -87,6 +92,11 @@ public class FinancialDocumentV1Document extends Prediction {
    */
   @JsonProperty("locale")
   private LocaleField locale;
+  /**
+   * The receipt number or identifier only if document is a receipt.
+   */
+  @JsonProperty("receipt_number")
+  private StringField receiptNumber;
   /**
    * List of Reference numbers, including PO number.
    */
@@ -174,6 +184,8 @@ public boolean isEmpty() {
     return (
       this.locale == null
       && this.invoiceNumber == null
+      && this.receiptNumber == null
+      && this.documentNumber == null
       && (this.referenceNumbers == null || this.referenceNumbers.isEmpty())
       && this.date == null
       && this.dueDate == null
@@ -212,6 +224,12 @@ public String toString() {
     outStr.append(
         String.format(":Invoice Number: %s%n", this.getInvoiceNumber())
     );
+    outStr.append(
+        String.format(":Receipt Number: %s%n", this.getReceiptNumber())
+    );
+    outStr.append(
+        String.format(":Document Number: %s%n", this.getDocumentNumber())
+    );
     String referenceNumbers = SummaryHelper.arrayToString(
         this.getReferenceNumbers(),
         "%n                    "

src/main/java/com/mindee/product/receipt/ReceiptV5.java

@@ -6,7 +6,7 @@
 import lombok.Getter;
 
 /**
- * The definition for Receipt, API version 5.
+ * Receipt API version 5 inference prediction.
  */
 @Getter
 @JsonIgnoreProperties(ignoreUnknown = true)

src/main/java/com/mindee/product/receipt/ReceiptV5Document.java

@@ -19,7 +19,7 @@
 import lombok.Getter;
 
 /**
- * Document data for Receipt, API version 5.
+ * Receipt API version 5.2 document data.
  */
 @Getter
 @EqualsAndHashCode(callSuper = false)
@@ -51,6 +51,11 @@ public class ReceiptV5Document extends Prediction {
    */
   @JsonProperty("locale")
   private LocaleField locale;
+  /**
+   * The receipt number or identifier.
+   */
+  @JsonProperty("receipt_number")
+  private StringField receiptNumber;
   /**
    * The purchase subcategory among predefined classes for transport and food.
    */
@@ -126,6 +131,7 @@ public boolean isEmpty() {
       && (this.supplierCompanyRegistrations == null || this.supplierCompanyRegistrations.isEmpty())
       && this.supplierAddress == null
       && this.supplierPhoneNumber == null
+      && this.receiptNumber == null
       && (this.lineItems == null || this.lineItems.isEmpty())
       );
   }
@@ -182,6 +188,9 @@ public String toString() {
     outStr.append(
         String.format(":Supplier Phone Number: %s%n", this.getSupplierPhoneNumber())
     );
+    outStr.append(
+        String.format(":Receipt Number: %s%n", this.getReceiptNumber())
+    );
     String lineItemsSummary = "";
     if (!this.getLineItems().isEmpty()) {
       int[] lineItemsColSizes = new int[]{38, 10, 14, 12};

src/test/java/com/mindee/product/receipt/ReceiptV5Test.java

@@ -49,6 +49,7 @@ void whenEmptyDeserialized_mustHaveValidProperties() throws IOException {
     Assertions.assertTrue(docPrediction.getSupplierCompanyRegistrations().isEmpty());
     Assertions.assertNull(docPrediction.getSupplierAddress().getValue());
     Assertions.assertNull(docPrediction.getSupplierPhoneNumber().getValue());
+    Assertions.assertNull(docPrediction.getReceiptNumber().getValue());
     Assertions.assertTrue(docPrediction.getLineItems().isEmpty());
   }