Package com.mindee.product.invoice

Class InvoiceV4Document

  • public class InvoiceV4Document
extends Prediction
    Invoice API version 4.10 document data.

    • Field Detail

      • billingAddress

        protected StringField billingAddress
        The customer billing address.

      • customerAddress

        protected StringField customerAddress
        The address of the customer.

      • customerCompanyRegistrations

        protected List<CompanyRegistrationField> customerCompanyRegistrations
        List of company registration numbers associated to the customer.

      • customerId

        protected StringField customerId
        The customer account number or identifier from the supplier.

      • customerName

        protected StringField customerName
        The name of the customer or client.

      • date

        protected DateField date
        The date the purchase was made.

      • documentType

        protected ClassificationField documentType
        Document type: INVOICE or CREDIT NOTE.

      • documentTypeExtended

        protected ClassificationField documentTypeExtended
        Document type extended.

      • dueDate

        protected DateField dueDate
        The date on which the payment is due.

      • invoiceNumber

        protected StringField invoiceNumber
        The invoice number or identifier.

      • lineItems

        protected List<InvoiceV4LineItem> lineItems
        List of all the line items present on the invoice.

      • locale

        protected LocaleField locale
        The locale of the document.

      • paymentDate

        protected DateField paymentDate
        The date on which the payment is due / was full-filled.

      • poNumber

        protected StringField poNumber
        The purchase order number.

      • referenceNumbers

        protected List<StringField> referenceNumbers
        List of all reference numbers on the invoice, including the purchase order number.

      • shippingAddress

        protected StringField shippingAddress
        Customer's delivery address.

      • supplierAddress

        protected StringField supplierAddress
        The address of the supplier or merchant.

      • supplierCompanyRegistrations

        protected List<CompanyRegistrationField> supplierCompanyRegistrations
        List of company registration numbers associated to the supplier.

      • supplierEmail

        protected StringField supplierEmail
        The email address of the supplier or merchant.

      • supplierName

        protected StringField supplierName
        The name of the supplier or merchant.

      • supplierPaymentDetails

        protected List<PaymentDetailsField> supplierPaymentDetails
        List of payment details associated to the supplier of the invoice.

      • supplierPhoneNumber

        protected StringField supplierPhoneNumber
        The phone number of the supplier or merchant.

      • supplierWebsite

        protected StringField supplierWebsite
        The website URL of the supplier or merchant.

      • taxes

        protected Taxes taxes
        List of taxes. Each item contains the detail of the tax.

      • totalAmount

        protected AmountField totalAmount
        The total amount of the invoice: includes taxes, tips, fees, and other charges.

      • totalNet

        protected AmountField totalNet
        The net amount of the invoice: does not include taxes, fees, and discounts.

      • totalTax

        protected AmountField totalTax
        The total tax: the sum of all the taxes for this invoice.

    • Constructor Detail

      • InvoiceV4Document

        public InvoiceV4Document()

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Description copied from class: Prediction
        Returns true if there are no predictions values. Accessing prediction values when this is true may result in a NullPointerException
        Specified by:
        isEmpty in class Prediction

      • getBillingAddress

        public StringField getBillingAddress()
        The customer billing address.

      • getCustomerAddress

        public StringField getCustomerAddress()
        The address of the customer.

      • getCustomerCompanyRegistrations

        public List<CompanyRegistrationField> getCustomerCompanyRegistrations()
        List of company registration numbers associated to the customer.

      • getCustomerId

        public StringField getCustomerId()
        The customer account number or identifier from the supplier.

      • getCustomerName

        public StringField getCustomerName()
        The name of the customer or client.

      • getDate

        public DateField getDate()
        The date the purchase was made.

      • getDocumentType

        public ClassificationField getDocumentType()
        Document type: INVOICE or CREDIT NOTE.

      • getDocumentTypeExtended

        public ClassificationField getDocumentTypeExtended()
        Document type extended.

      • getDueDate

        public DateField getDueDate()
        The date on which the payment is due.

      • getInvoiceNumber

        public StringField getInvoiceNumber()
        The invoice number or identifier.

      • getLineItems

        public List<InvoiceV4LineItem> getLineItems()
        List of all the line items present on the invoice.

      • getLocale

        public LocaleField getLocale()
        The locale of the document.

      • getPaymentDate

        public DateField getPaymentDate()
        The date on which the payment is due / was full-filled.

      • getPoNumber

        public StringField getPoNumber()
        The purchase order number.

      • getReferenceNumbers

        public List<StringField> getReferenceNumbers()
        List of all reference numbers on the invoice, including the purchase order number.

      • getShippingAddress

        public StringField getShippingAddress()
        Customer's delivery address.

      • getSupplierAddress

        public StringField getSupplierAddress()
        The address of the supplier or merchant.

      • getSupplierCompanyRegistrations

        public List<CompanyRegistrationField> getSupplierCompanyRegistrations()
        List of company registration numbers associated to the supplier.

      • getSupplierEmail

        public StringField getSupplierEmail()
        The email address of the supplier or merchant.

      • getSupplierName

        public StringField getSupplierName()
        The name of the supplier or merchant.

      • getSupplierPaymentDetails

        public List<PaymentDetailsField> getSupplierPaymentDetails()
        List of payment details associated to the supplier of the invoice.

      • getSupplierPhoneNumber

        public StringField getSupplierPhoneNumber()
        The phone number of the supplier or merchant.

      • getSupplierWebsite

        public StringField getSupplierWebsite()
        The website URL of the supplier or merchant.

      • getTaxes

        public Taxes getTaxes()
        List of taxes. Each item contains the detail of the tax.

      • getTotalAmount

        public AmountField getTotalAmount()
        The total amount of the invoice: includes taxes, tips, fees, and other charges.

      • getTotalNet

        public AmountField getTotalNet()
        The net amount of the invoice: does not include taxes, fees, and discounts.

      • getTotalTax

        public AmountField getTotalTax()
        The total tax: the sum of all the taxes for this invoice.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object