mindee 4.36.3 → 5.0.0-alpha2

package/src/v1/product/generated/generatedV1.d.ts

@@ -0,0 +1,17 @@
+import { Inference, Page, StringDict } from "../../../v1/parsing/common/index.js";
+import { GeneratedV1Document } from "./generatedV1Document.js";
+import { GeneratedV1Page } from "./generatedV1Page.js";
+/**
+ * Generated API V1 inference results.
+ */
+export declare class GeneratedV1 extends Inference {
+    /** The endpoint's name. Note: placeholder for custom APIs. */
+    endpointName: string;
+    /** The endpoint's version. Note: placeholder for custom APIs. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: GeneratedV1Document;
+    /** The document's pages. */
+    pages: Page<GeneratedV1Page>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/generated/generatedV1.js

@@ -0,0 +1,20 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { GeneratedV1Document } from "./generatedV1Document.js";
+import { GeneratedV1Page } from "./generatedV1Page.js";
+/**
+ * Generated API V1 inference results.
+ */
+export class GeneratedV1 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. Note: placeholder for custom APIs. */
+        this.endpointName = "custom";
+        /** The endpoint's version. Note: placeholder for custom APIs. */
+        this.endpointVersion = "1";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new GeneratedV1Document(rawPrediction["prediction"]);
+        this.pages = rawPrediction["pages"].length > 0 && Object.keys(rawPrediction["pages"][0]["prediction"]).length > 0 ?
+            rawPrediction["pages"].map((page) => new Page(GeneratedV1Page, page, page["id"])) : [];
+    }
+}

package/src/v1/product/generated/generatedV1Document.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 document prediction results.
+ */
+export declare class GeneratedV1Document extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/generated/generatedV1Document.js

@@ -0,0 +1,26 @@
+import { GeneratedListField, GeneratedObjectField, isGeneratedObject } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 document prediction results.
+ */
+export class GeneratedV1Document extends GeneratedV1Prediction {
+    constructor(rawPrediction) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedListField({ prediction: fieldValue }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && isGeneratedObject(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedObjectField({ prediction: fieldValue }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new StringField({ prediction: fieldValueStr }));
+            }
+        });
+    }
+}

package/src/v1/product/generated/generatedV1Page.d.ts

@@ -0,0 +1,8 @@
+import { StringDict } from "../../../parsing/stringDict.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 page prediction results.
+ */
+export declare class GeneratedV1Page extends GeneratedV1Prediction {
+    constructor(rawPrediction: StringDict, pageId?: number);
+}

package/src/v1/product/generated/generatedV1Page.js

@@ -0,0 +1,26 @@
+import { GeneratedListField, GeneratedObjectField, isGeneratedObject } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+import { GeneratedV1Prediction } from "./generatedV1Prediction.js";
+/**
+ * Generated V1 page prediction results.
+ */
+export class GeneratedV1Page extends GeneratedV1Prediction {
+    constructor(rawPrediction, pageId) {
+        super();
+        Object.entries(rawPrediction).forEach(([fieldName, fieldValue]) => {
+            if (Array.isArray(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedListField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else if (typeof fieldValue === "object" && fieldValue !== null && isGeneratedObject(fieldValue)) {
+                this.fields.set(fieldName, new GeneratedObjectField({ prediction: fieldValue, pageId: pageId }));
+            }
+            else {
+                const fieldValueStr = fieldValue;
+                if (Object.prototype.hasOwnProperty.call(fieldValueStr, "value") && fieldValueStr["value"] !== null) {
+                    fieldValueStr["value"] = fieldValueStr["value"].toString();
+                }
+                this.fields.set(fieldName, new StringField({ prediction: fieldValueStr, pageId: pageId }));
+            }
+        });
+    }
+}

package/src/v1/product/generated/generatedV1Prediction.d.ts

@@ -0,0 +1,25 @@
+import { Prediction } from "../../../v1/parsing/common/index.js";
+import { GeneratedListField } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+export declare class GeneratedV1Prediction implements Prediction {
+    /** Map of all fields in the document. */
+    fields: Map<string, any>;
+    constructor();
+    toString(): string;
+    /**
+     * Returns a dictionary of all fields that aren't a collection.
+     */
+    getSingleField(): Map<string, StringField>;
+    /**
+     * Returns a dictionary of all array-like fields.
+     */
+    getArrayFields(): Map<string, GeneratedListField>;
+    /**
+     * Returns a dictionary of all object-like fields.
+     */
+    getObjectFields(): Map<string, GeneratedListField>;
+    /**
+     * Lists names of all top-level field keys.
+     */
+    listFieldNames(): string[];
+}

package/src/v1/product/generated/generatedV1Prediction.js

@@ -0,0 +1,80 @@
+import { cleanOutString } from "../../../v1/parsing/common/index.js";
+import { GeneratedListField, GeneratedObjectField } from "../../../v1/parsing/generated/index.js";
+import { StringField } from "../../../v1/parsing/standard/index.js";
+export class GeneratedV1Prediction {
+    constructor() {
+        this.fields = new Map();
+    }
+    toString() {
+        let outStr = "";
+        const pattern = /^(\n*[  ]*)( {2}):/;
+        this.fields.forEach((fieldValue, fieldName) => {
+            let strValue = "";
+            if (fieldValue instanceof GeneratedListField &&
+                fieldValue.values.length > 0) {
+                if (fieldValue.values[0] instanceof GeneratedObjectField) {
+                    strValue += fieldValue.values[0].toStringLevel(1).replace(pattern, "$1* :");
+                }
+                else {
+                    strValue += fieldValue.values[0].toString().replace(pattern, "$1* :") + "\n";
+                }
+                for (const subValue of fieldValue.values.slice(1)) {
+                    if (subValue instanceof GeneratedObjectField) {
+                        strValue += subValue.toStringLevel(1).replace(pattern, "$1* :");
+                    }
+                    else {
+                        strValue += ` ${" ".repeat(fieldName.length + 2)}${subValue}\n`;
+                    }
+                }
+                strValue = strValue.trimEnd();
+            }
+            else {
+                strValue = fieldValue.toString();
+            }
+            outStr += `:${fieldName}: ${strValue}\n`;
+        });
+        return cleanOutString(outStr.trimEnd());
+    }
+    /**
+     * Returns a dictionary of all fields that aren't a collection.
+     */
+    getSingleField() {
+        const singleFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof StringField) {
+                singleFields.set(fieldName, fieldValue);
+            }
+        }
+        return singleFields;
+    }
+    /**
+     * Returns a dictionary of all array-like fields.
+     */
+    getArrayFields() {
+        const arrayFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof GeneratedListField) {
+                arrayFields.set(fieldName, fieldValue);
+            }
+        }
+        return arrayFields;
+    }
+    /**
+     * Returns a dictionary of all object-like fields.
+     */
+    getObjectFields() {
+        const objectFields = new Map();
+        for (const [fieldName, fieldValue] of Object.entries(this.fields)) {
+            if (fieldValue instanceof GeneratedObjectField) {
+                objectFields.set(fieldName, fieldValue);
+            }
+        }
+        return objectFields;
+    }
+    /**
+     * Lists names of all top-level field keys.
+     */
+    listFieldNames() {
+        return Object.keys(this.fields);
+    }
+}

package/src/v1/product/generated/index.d.ts

@@ -0,0 +1,4 @@
+export { GeneratedV1 } from "./generatedV1.js";
+export { GeneratedV1Document } from "./generatedV1Document.js";
+export { GeneratedV1Page } from "./generatedV1Page.js";
+export { GeneratedV1Prediction } from "./generatedV1Prediction.js";

package/src/v1/product/generated/index.js

@@ -0,0 +1,4 @@
+export { GeneratedV1 } from "./generatedV1.js";
+export { GeneratedV1Document } from "./generatedV1Document.js";
+export { GeneratedV1Page } from "./generatedV1Page.js";
+export { GeneratedV1Prediction } from "./generatedV1Prediction.js";

package/src/v1/product/index.d.ts

@@ -0,0 +1,26 @@
+export * as fr from "./fr/index.js";
+export * as us from "./us/index.js";
+export { BarcodeReaderV1 } from "./barcodeReader/index.js";
+export { CropperV1 } from "./cropper/index.js";
+export { DriverLicenseV1 } from "./driverLicense/index.js";
+export { FinancialDocumentV1 } from "./financialDocument/index.js";
+export { GeneratedV1 } from "./generated/index.js";
+export { InternationalIdV2 } from "./internationalId/index.js";
+export { InvoiceSplitterV1 } from "./invoiceSplitter/index.js";
+export { InvoiceV4 } from "./invoice/index.js";
+export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/index.js";
+export { PassportV1 } from "./passport/index.js";
+export { ReceiptV5 } from "./receipt/index.js";
+export { ResumeV1 } from "./resume/index.js";
+export * as barcodeReader from "./barcodeReader/index.js";
+export * as cropper from "./cropper/index.js";
+export * as driverLicense from "./driverLicense/index.js";
+export * as financialDocument from "./financialDocument/index.js";
+export * as generated from "./generated/index.js";
+export * as internationalId from "./internationalId/index.js";
+export * as invoice from "./invoice/index.js";
+export * as invoiceSplitter from "./invoiceSplitter/index.js";
+export * as multiReceiptsDetector from "./multiReceiptsDetector/index.js";
+export * as passport from "./passport/index.js";
+export * as receipt from "./receipt/index.js";
+export * as resume from "./resume/index.js";

package/src/v1/product/index.js

@@ -0,0 +1,27 @@
+export * as fr from "./fr/index.js";
+export * as us from "./us/index.js";
+export { BarcodeReaderV1 } from "./barcodeReader/index.js";
+export { CropperV1 } from "./cropper/index.js";
+export { DriverLicenseV1 } from "./driverLicense/index.js";
+export { FinancialDocumentV1 } from "./financialDocument/index.js";
+export { GeneratedV1 } from "./generated/index.js";
+export { InternationalIdV2 } from "./internationalId/index.js";
+export { InvoiceSplitterV1 } from "./invoiceSplitter/index.js";
+export { InvoiceV4 } from "./invoice/index.js";
+export { MultiReceiptsDetectorV1 } from "./multiReceiptsDetector/index.js";
+export { PassportV1 } from "./passport/index.js";
+export { ReceiptV5 } from "./receipt/index.js";
+export { ResumeV1 } from "./resume/index.js";
+// not sure if we want to export these -- advanced users can import them directly
+export * as barcodeReader from "./barcodeReader/index.js";
+export * as cropper from "./cropper/index.js";
+export * as driverLicense from "./driverLicense/index.js";
+export * as financialDocument from "./financialDocument/index.js";
+export * as generated from "./generated/index.js";
+export * as internationalId from "./internationalId/index.js";
+export * as invoice from "./invoice/index.js";
+export * as invoiceSplitter from "./invoiceSplitter/index.js";
+export * as multiReceiptsDetector from "./multiReceiptsDetector/index.js";
+export * as passport from "./passport/index.js";
+export * as receipt from "./receipt/index.js";
+export * as resume from "./resume/index.js";

package/src/v1/product/internationalId/index.d.ts

@@ -0,0 +1,2 @@
+export { InternationalIdV2 } from "./internationalIdV2.js";
+export { InternationalIdV2Document } from "./internationalIdV2Document.js";

package/src/v1/product/internationalId/index.js

@@ -0,0 +1,2 @@
+export { InternationalIdV2 } from "./internationalIdV2.js";
+export { InternationalIdV2Document } from "./internationalIdV2Document.js";

package/src/v1/product/internationalId/internationalIdV2.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { InternationalIdV2Document } from "./internationalIdV2Document.js";
+/**
+ * International ID API version 2 inference prediction.
+ */
+export declare class InternationalIdV2 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: InternationalIdV2Document;
+    /** The document's pages. */
+    pages: Page<InternationalIdV2Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/internationalId/internationalIdV2.js

@@ -0,0 +1,23 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { InternationalIdV2Document } from "./internationalIdV2Document.js";
+/**
+ * International ID API version 2 inference prediction.
+ */
+export class InternationalIdV2 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "international_id";
+        /** The endpoint's version. */
+        this.endpointVersion = "2";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new InternationalIdV2Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(InternationalIdV2Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

package/src/v1/product/internationalId/internationalIdV2Document.d.ts

@@ -0,0 +1,46 @@
+import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { ClassificationField, DateField, StringField } from "../../../v1/parsing/standard/index.js";
+/**
+ * International ID API version 2.2 document data.
+ */
+export declare class InternationalIdV2Document implements Prediction {
+    /** The physical address of the document holder. */
+    address: StringField;
+    /** The date of birth of the document holder. */
+    birthDate: DateField;
+    /** The place of birth of the document holder. */
+    birthPlace: StringField;
+    /** The country where the document was issued. */
+    countryOfIssue: StringField;
+    /** The unique identifier assigned to the document. */
+    documentNumber: StringField;
+    /** The type of personal identification document. */
+    documentType: ClassificationField;
+    /** The date when the document becomes invalid. */
+    expiryDate: DateField;
+    /** The list of the document holder's given names. */
+    givenNames: StringField[];
+    /** The date when the document was issued. */
+    issueDate: DateField;
+    /** The Machine Readable Zone, first line. */
+    mrzLine1: StringField;
+    /** The Machine Readable Zone, second line. */
+    mrzLine2: StringField;
+    /** The Machine Readable Zone, third line. */
+    mrzLine3: StringField;
+    /** The country of citizenship of the document holder. */
+    nationality: StringField;
+    /** The unique identifier assigned to the document holder. */
+    personalNumber: StringField;
+    /** The biological sex of the document holder. */
+    sex: StringField;
+    /** The state or territory where the document was issued. */
+    stateOfIssue: StringField;
+    /** The list of the document holder's family names. */
+    surnames: StringField[];
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}

package/src/v1/product/internationalId/internationalIdV2Document.js

@@ -0,0 +1,109 @@
+import { cleanOutString, } from "../../../v1/parsing/common/index.js";
+import { ClassificationField, DateField, StringField, } from "../../../v1/parsing/standard/index.js";
+/**
+ * International ID API version 2.2 document data.
+ */
+export class InternationalIdV2Document {
+    constructor(rawPrediction, pageId) {
+        /** The list of the document holder's given names. */
+        this.givenNames = [];
+        /** The list of the document holder's family names. */
+        this.surnames = [];
+        this.address = new StringField({
+            prediction: rawPrediction["address"],
+            pageId: pageId,
+        });
+        this.birthDate = new DateField({
+            prediction: rawPrediction["birth_date"],
+            pageId: pageId,
+        });
+        this.birthPlace = new StringField({
+            prediction: rawPrediction["birth_place"],
+            pageId: pageId,
+        });
+        this.countryOfIssue = new StringField({
+            prediction: rawPrediction["country_of_issue"],
+            pageId: pageId,
+        });
+        this.documentNumber = new StringField({
+            prediction: rawPrediction["document_number"],
+            pageId: pageId,
+        });
+        this.documentType = new ClassificationField({
+            prediction: rawPrediction["document_type"],
+        });
+        this.expiryDate = new DateField({
+            prediction: rawPrediction["expiry_date"],
+            pageId: pageId,
+        });
+        if (rawPrediction["given_names"]) {
+            rawPrediction["given_names"].map((itemPrediction) => this.givenNames.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+        this.issueDate = new DateField({
+            prediction: rawPrediction["issue_date"],
+            pageId: pageId,
+        });
+        this.mrzLine1 = new StringField({
+            prediction: rawPrediction["mrz_line1"],
+            pageId: pageId,
+        });
+        this.mrzLine2 = new StringField({
+            prediction: rawPrediction["mrz_line2"],
+            pageId: pageId,
+        });
+        this.mrzLine3 = new StringField({
+            prediction: rawPrediction["mrz_line3"],
+            pageId: pageId,
+        });
+        this.nationality = new StringField({
+            prediction: rawPrediction["nationality"],
+            pageId: pageId,
+        });
+        this.personalNumber = new StringField({
+            prediction: rawPrediction["personal_number"],
+            pageId: pageId,
+        });
+        this.sex = new StringField({
+            prediction: rawPrediction["sex"],
+            pageId: pageId,
+        });
+        this.stateOfIssue = new StringField({
+            prediction: rawPrediction["state_of_issue"],
+            pageId: pageId,
+        });
+        if (rawPrediction["surnames"]) {
+            rawPrediction["surnames"].map((itemPrediction) => this.surnames.push(new StringField({
+                prediction: itemPrediction,
+                pageId: pageId,
+            })));
+        }
+    }
+    /**
+     * Default string representation.
+     */
+    toString() {
+        const surnames = this.surnames.join("\n           ");
+        const givenNames = this.givenNames.join("\n              ");
+        const outStr = `:Document Type: ${this.documentType}
+:Document Number: ${this.documentNumber}
+:Surnames: ${surnames}
+:Given Names: ${givenNames}
+:Sex: ${this.sex}
+:Birth Date: ${this.birthDate}
+:Birth Place: ${this.birthPlace}
+:Nationality: ${this.nationality}
+:Personal Number: ${this.personalNumber}
+:Country of Issue: ${this.countryOfIssue}
+:State of Issue: ${this.stateOfIssue}
+:Issue Date: ${this.issueDate}
+:Expiration Date: ${this.expiryDate}
+:Address: ${this.address}
+:MRZ Line 1: ${this.mrzLine1}
+:MRZ Line 2: ${this.mrzLine2}
+:MRZ Line 3: ${this.mrzLine3}`.trimEnd();
+        return cleanOutString(outStr);
+    }
+}

package/src/v1/product/invoice/index.d.ts

@@ -0,0 +1,3 @@
+export { InvoiceV4 } from "./invoiceV4.js";
+export { InvoiceV4Document } from "./invoiceV4Document.js";
+export { InvoiceV4LineItem } from "./invoiceV4LineItem.js";

package/src/v1/product/invoice/index.js

@@ -0,0 +1,3 @@
+export { InvoiceV4 } from "./invoiceV4.js";
+export { InvoiceV4Document } from "./invoiceV4Document.js";
+export { InvoiceV4LineItem } from "./invoiceV4LineItem.js";

package/src/v1/product/invoice/invoiceV4.d.ts

@@ -0,0 +1,16 @@
+import { Inference, StringDict, Page } from "../../../v1/parsing/common/index.js";
+import { InvoiceV4Document } from "./invoiceV4Document.js";
+/**
+ * Invoice API version 4 inference prediction.
+ */
+export declare class InvoiceV4 extends Inference {
+    /** The endpoint's name. */
+    endpointName: string;
+    /** The endpoint's version. */
+    endpointVersion: string;
+    /** The document-level prediction. */
+    prediction: InvoiceV4Document;
+    /** The document's pages. */
+    pages: Page<InvoiceV4Document>[];
+    constructor(rawPrediction: StringDict);
+}

package/src/v1/product/invoice/invoiceV4.js

@@ -0,0 +1,23 @@
+import { Inference, Page } from "../../../v1/parsing/common/index.js";
+import { InvoiceV4Document } from "./invoiceV4Document.js";
+/**
+ * Invoice API version 4 inference prediction.
+ */
+export class InvoiceV4 extends Inference {
+    constructor(rawPrediction) {
+        super(rawPrediction);
+        /** The endpoint's name. */
+        this.endpointName = "invoices";
+        /** The endpoint's version. */
+        this.endpointVersion = "4";
+        /** The document's pages. */
+        this.pages = [];
+        this.prediction = new InvoiceV4Document(rawPrediction["prediction"]);
+        rawPrediction["pages"].forEach((page) => {
+            if (page.prediction !== undefined && page.prediction !== null &&
+                Object.keys(page.prediction).length > 0) {
+                this.pages.push(new Page(InvoiceV4Document, page, page["id"], page["orientation"]));
+            }
+        });
+    }
+}

package/src/v1/product/invoice/invoiceV4Document.d.ts

@@ -0,0 +1,71 @@
+import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { InvoiceV4LineItem } from "./invoiceV4LineItem.js";
+import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../../v1/parsing/standard/index.js";
+/**
+ * Invoice API version 4.11 document data.
+ */
+export declare class InvoiceV4Document implements Prediction {
+    /** The customer billing address. */
+    billingAddress: AddressField;
+    /** The purchase category. */
+    category: ClassificationField;
+    /** The address of the customer. */
+    customerAddress: AddressField;
+    /** List of company registration numbers associated to the customer. */
+    customerCompanyRegistrations: CompanyRegistrationField[];
+    /** The customer account number or identifier from the supplier. */
+    customerId: StringField;
+    /** The name of the customer or client. */
+    customerName: StringField;
+    /** The date the purchase was made. */
+    date: DateField;
+    /** Document type: INVOICE or CREDIT NOTE. */
+    documentType: ClassificationField;
+    /** Document type extended. */
+    documentTypeExtended: ClassificationField;
+    /** The date on which the payment is due. */
+    dueDate: DateField;
+    /** The invoice number or identifier. */
+    invoiceNumber: StringField;
+    /** List of all the line items present on the invoice. */
+    lineItems: InvoiceV4LineItem[];
+    /** The locale of the document. */
+    locale: LocaleField;
+    /** The date on which the payment is due / was full-filled. */
+    paymentDate: DateField;
+    /** The purchase order number. */
+    poNumber: StringField;
+    /** List of all reference numbers on the invoice, including the purchase order number. */
+    referenceNumbers: StringField[];
+    /** Customer's delivery address. */
+    shippingAddress: AddressField;
+    /** The purchase subcategory for transport, food and shopping. */
+    subcategory: ClassificationField;
+    /** The address of the supplier or merchant. */
+    supplierAddress: AddressField;
+    /** List of company registration numbers associated to the supplier. */
+    supplierCompanyRegistrations: CompanyRegistrationField[];
+    /** The email address of the supplier or merchant. */
+    supplierEmail: StringField;
+    /** The name of the supplier or merchant. */
+    supplierName: StringField;
+    /** List of payment details associated to the supplier of the invoice. */
+    supplierPaymentDetails: PaymentDetailsField[];
+    /** The phone number of the supplier or merchant. */
+    supplierPhoneNumber: StringField;
+    /** The website URL of the supplier or merchant. */
+    supplierWebsite: StringField;
+    /** List of taxes. Each item contains the detail of the tax. */
+    taxes: Taxes;
+    /** The total amount of the invoice: includes taxes, tips, fees, and other charges. */
+    totalAmount: AmountField;
+    /** The net amount of the invoice: does not include taxes, fees, and discounts. */
+    totalNet: AmountField;
+    /** The total tax: the sum of all the taxes for this invoice. */
+    totalTax: AmountField;
+    constructor(rawPrediction: StringDict, pageId?: number);
+    /**
+     * Default string representation.
+     */
+    toString(): string;
+}