mindee/src/product/invoice/invoiceV4Document.d.ts

Mindee Client Library for Node.js

import { Prediction, StringDict } from "../../parsing/common";
import { InvoiceV4LineItem } from "./invoiceV4LineItem";
import { AddressField, AmountField, ClassificationField, CompanyRegistrationField, DateField, LocaleField, PaymentDetailsField, StringField, Taxes } from "../../parsing/standard";
/**
 * 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;
}