✨ update Invoice to v4.5 (#153)

Author: ianardee

docs/code_samples/invoices_v4.txt

@@ -15,7 +15,7 @@ public class SimpleMindeeClient {
     MindeeClient mindeeClient = new MindeeClient(apiKey);
 
     // Load a file from disk
-    LocalInputSource inputSource = new LocalInputSource(new File(filePath));
+    LocalInputSource inputSource = new LocalInputSource(filePath);
 
     // Parse the file
     PredictResponse<InvoiceV4> response = mindeeClient.parse(

src/main/java/com/mindee/product/invoice/InvoiceV4Document.java

@@ -12,8 +12,9 @@
 import com.mindee.parsing.standard.LocaleField;
 import com.mindee.parsing.standard.PaymentDetailsField;
 import com.mindee.parsing.standard.StringField;
-import com.mindee.parsing.standard.TaxField;
+import com.mindee.parsing.standard.Taxes;
 import com.mindee.parsing.standard.TaxesDeserializer;
+import java.util.ArrayList;
 import java.util.List;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -27,83 +28,98 @@
 public class InvoiceV4Document extends Prediction {
 
   /**
-   * Locale information.
+   * The customer's address used for billing.
    */
-  @JsonProperty("locale")
-  private LocaleField localeField;
+  @JsonProperty("billing_address")
+  private StringField billingAddress;
   /**
-   * The type of the parsed document (see official documentation for the list).
+   * The address of the customer.
    */
-  @JsonProperty("document_type")
-  private ClassificationField documentType;
+  @JsonProperty("customer_address")
+  private StringField customerAddress;
   /**
-   * The creation date of the invoice.
+   * List of company registrations associated to the customer.
    */
-  @JsonProperty("date")
-  private DateField invoiceDateField;
+  @JsonProperty("customer_company_registrations")
+  private List<CompanyRegistrationField> customerCompanyRegistrations = new ArrayList<>();
   /**
-   * The invoice number.
+   * The name of the customer or client.
    */
-  @JsonProperty("invoice_number")
-  private StringField invoiceNumber;
+  @JsonProperty("customer_name")
+  private StringField customerName;
   /**
-   * List of Reference numbers including PO number.
+   * The date the purchase was made.
    */
-  @JsonProperty("reference_numbers")
-  private List<StringField> referenceNumbers;
+  @JsonProperty("date")
+  private DateField invoiceDateField;
+  /**
+   * One of: 'INVOICE', 'CREDIT NOTE'.
+   */
+  @JsonProperty("document_type")
+  private ClassificationField documentType;
   /**
-   * The due date of the invoice.
+   * The date on which the payment is due.
    */
   @JsonProperty("due_date")
   private DateField dueDateField;
   /**
-   * The supplier name.
+   * The invoice number or identifier.
    */
-  @JsonProperty("supplier_name")
-  private StringField supplierName;
+  @JsonProperty("invoice_number")
+  private StringField invoiceNumber;
   /**
-   * The supplier payment information's.
+   * List of line item details.
    */
-  @JsonProperty("supplier_payment_details")
-  private List<PaymentDetailsField> supplierPaymentDetails;
+  @JsonProperty("line_items")
+  private List<InvoiceV4LineItem> lineItems = new ArrayList<>();
   /**
-   * The supplier company regitration information.
+   * The locale detected on the document.
    */
-  @JsonProperty("supplier_company_registrations")
-  private List<CompanyRegistrationField> supplierCompanyRegistrations;
+  @JsonProperty("locale")
+  private LocaleField localeField;
   /**
-   * The supplier address.
+   * List of Reference numbers, including PO number.
+   */
+  @JsonProperty("reference_numbers")
+  private List<StringField> referenceNumbers = new ArrayList<>();
+  /**
+   * Customer's delivery address.
+   */
+  @JsonProperty("shipping_address")
+  private StringField shippingAddress;
+  /**
+   * The address of the supplier or merchant.
    */
   @JsonProperty("supplier_address")
   private StringField supplierAddress;
   /**
-   * The name of the customer.
+   * List of company registrations associated to the supplier.
    */
-  @JsonProperty("customer_name")
-  private StringField customerName;
+  @JsonProperty("supplier_company_registrations")
+  private List<CompanyRegistrationField> supplierCompanyRegistrations = new ArrayList<>();
   /**
-   * The company registration information for the customer.
+   * The name of the supplier or merchant.
    */
-  @JsonProperty("customer_company_registrations")
-  private List<CompanyRegistrationField> customerCompanyRegistrations;
+  @JsonProperty("supplier_name")
+  private StringField supplierName;
   /**
-   * The address of the customer.
+   * List of payment details associated to the supplier.
    */
-  @JsonProperty("customer_address")
-  private StringField customerAddress;
+  @JsonProperty("supplier_payment_details")
+  private List<PaymentDetailsField> supplierPaymentDetails = new ArrayList<>();
   /**
-   * The list of the taxes.
+   * List of tax line details.
    */
   @JsonProperty("taxes")
   @JsonDeserialize(using = TaxesDeserializer.class)
-  private List<TaxField> taxes;
+  private Taxes taxes;
   /**
-   * The total amount with tax included.
+   * The total amount paid: includes taxes, tips, fees, and other charges.
    */
   @JsonProperty("total_amount")
   private AmountField totalAmount;
   /**
-   * The total amount without the tax value.
+   * The net amount paid: does not include taxes, fees, and discounts.
    */
   @JsonProperty("total_net")
   private AmountField totalNet;
@@ -112,12 +128,8 @@ public class InvoiceV4Document extends Prediction {
    */
   @JsonProperty("total_tax")
   private AmountField totalTax;
-  /**
-   * Line items details.
-   */
-  @JsonProperty("line_items")
-  private List<InvoiceV4LineItem> lineItems;
 
+  @Override
   public boolean isEmpty() {
     return (
       this.localeField == null
@@ -136,6 +148,8 @@ public boolean isEmpty() {
       && this.customerName == null
       && (this.customerCompanyRegistrations == null || this.customerCompanyRegistrations.isEmpty())
       && this.customerAddress == null
+      && this.shippingAddress == null
+      && this.billingAddress == null
       && this.documentType == null
       && (this.lineItems == null || this.lineItems.isEmpty())
       );
@@ -208,6 +222,12 @@ public String toString() {
     outStr.append(
         String.format(":Customer Address: %s%n", this.getCustomerAddress())
     );
+    outStr.append(
+        String.format(":Shipping Address: %s%n", this.getShippingAddress())
+    );
+    outStr.append(
+        String.format(":Billing Address: %s%n", this.getBillingAddress())
+    );
     outStr.append(
         String.format(":Document Type: %s%n", this.getDocumentType())
     );

src/main/java/com/mindee/product/invoice/InvoiceV4LineItem.java

@@ -86,7 +86,7 @@ private Map<String, String> printableValues() {
       descriptionSummary = descriptionSummary.substring(0, 33) + "...";
     }
     printable.put("description", descriptionSummary);
-    printable.put("productCode", SummaryHelper.formatString(this.productCode));
+    printable.put("productCode", SummaryHelper.formatForDisplay(this.productCode, null));
     printable.put(
         "quantity",
         SummaryHelper.formatAmount(this.quantity)

src/test/java/com/mindee/product/invoice/InvoiceV4Test.java

@@ -4,13 +4,12 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.mindee.parsing.common.Document;
 import com.mindee.parsing.common.PredictResponse;
+import com.mindee.parsing.standard.ClassificationField;
+import com.mindee.product.ProductTestHelper;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import java.io.File;
 import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Paths;
-import java.util.List;
 
 /**
  * Unit tests for InvoiceV4.
@@ -42,30 +41,29 @@ void whenEmptyDeserialized_mustHaveValidProperties() throws IOException {
     Assertions.assertNull(docPrediction.getDueDateField().getValue());
     Assertions.assertNull(docPrediction.getTotalNet().getValue());
     Assertions.assertNull(docPrediction.getTotalAmount().getValue());
+    Assertions.assertNull(docPrediction.getTotalTax().getValue());
     Assertions.assertTrue(docPrediction.getTaxes().isEmpty());
     Assertions.assertTrue(docPrediction.getSupplierPaymentDetails().isEmpty());
     Assertions.assertNull(docPrediction.getSupplierName().getValue());
-    Assertions.assertNull(docPrediction.getTotalTax().getValue());
     Assertions.assertTrue(docPrediction.getSupplierCompanyRegistrations().isEmpty());
     Assertions.assertNull(docPrediction.getSupplierAddress().getValue());
     Assertions.assertNull(docPrediction.getCustomerName().getValue());
     Assertions.assertTrue(docPrediction.getCustomerCompanyRegistrations().isEmpty());
     Assertions.assertNull(docPrediction.getCustomerAddress().getValue());
-    Assertions.assertNotNull(docPrediction.getDocumentType().getValue());
+    Assertions.assertNull(docPrediction.getShippingAddress().getValue());
+    Assertions.assertNull(docPrediction.getBillingAddress().getValue());
+    Assertions.assertInstanceOf(ClassificationField.class, docPrediction.getDocumentType());
     Assertions.assertTrue(docPrediction.getLineItems().isEmpty());
   }
 
   @Test
   void whenCompleteDeserialized_mustHaveValidDocumentSummary() throws IOException {
     PredictResponse<InvoiceV4> response = getPrediction("complete");
     Document<InvoiceV4> doc = response.getDocument();
-    String[] actualLines = doc.toString().split(System.lineSeparator());
-    List<String> expectedLines = Files.readAllLines(
-      Paths.get("src/test/resources/products/invoices/response_v4/summary_full.rst")
+    ProductTestHelper.assertStringEqualsFile(
+        doc.toString(),
+        "src/test/resources/products/invoices/response_v4/summary_full.rst"
     );
-    String expectedSummary = String.join(String.format("%n"), expectedLines);
-    String actualSummary = String.join(String.format("%n"), actualLines);
-
-    Assertions.assertEquals(expectedSummary, actualSummary);
   }
+
 }