Package com.mindee.product.invoice
Class InvoiceV4Document
- java.lang.Object
-
- com.mindee.parsing.common.Prediction
-
- com.mindee.product.invoice.InvoiceV4Document
-
public class InvoiceV4Document extends Prediction
Invoice API version 4.9 document data.
-
-
Field Summary
Fields Modifier and Type Field Description protected StringField
billingAddress
The customer billing address.protected StringField
customerAddress
The address of the customer.protected List<CompanyRegistrationField>
customerCompanyRegistrations
List of company registration numbers associated to the customer.protected StringField
customerId
The customer account number or identifier from the supplier.protected StringField
customerName
The name of the customer or client.protected DateField
date
The date the purchase was made.protected ClassificationField
documentType
Document type: INVOICE or CREDIT NOTE.protected DateField
dueDate
The date on which the payment is due.protected StringField
invoiceNumber
The invoice number or identifier.protected List<InvoiceV4LineItem>
lineItems
List of all the line items present on the invoice.protected LocaleField
locale
The locale of the document.protected DateField
paymentDate
The date on which the payment is due / was full-filled.protected StringField
poNumber
The purchase order number.protected List<StringField>
referenceNumbers
List of all reference numbers on the invoice, including the purchase order number.protected StringField
shippingAddress
Customer's delivery address.protected StringField
supplierAddress
The address of the supplier or merchant.protected List<CompanyRegistrationField>
supplierCompanyRegistrations
List of company registration numbers associated to the supplier.protected StringField
supplierEmail
The email address of the supplier or merchant.protected StringField
supplierName
The name of the supplier or merchant.protected List<PaymentDetailsField>
supplierPaymentDetails
List of payment details associated to the supplier of the invoice.protected StringField
supplierPhoneNumber
The phone number of the supplier or merchant.protected StringField
supplierWebsite
The website URL of the supplier or merchant.protected Taxes
taxes
List of taxes.protected AmountField
totalAmount
The total amount of the invoice: includes taxes, tips, fees, and other charges.protected AmountField
totalNet
The net amount of the invoice: does not include taxes, fees, and discounts.protected AmountField
totalTax
The total tax: the sum of all the taxes for this invoice.
-
Constructor Summary
Constructors Constructor Description InvoiceV4Document()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
StringField
getBillingAddress()
The customer billing address.StringField
getCustomerAddress()
The address of the customer.List<CompanyRegistrationField>
getCustomerCompanyRegistrations()
List of company registration numbers associated to the customer.StringField
getCustomerId()
The customer account number or identifier from the supplier.StringField
getCustomerName()
The name of the customer or client.DateField
getDate()
The date the purchase was made.ClassificationField
getDocumentType()
Document type: INVOICE or CREDIT NOTE.DateField
getDueDate()
The date on which the payment is due.StringField
getInvoiceNumber()
The invoice number or identifier.List<InvoiceV4LineItem>
getLineItems()
List of all the line items present on the invoice.LocaleField
getLocale()
The locale of the document.DateField
getPaymentDate()
The date on which the payment is due / was full-filled.StringField
getPoNumber()
The purchase order number.List<StringField>
getReferenceNumbers()
List of all reference numbers on the invoice, including the purchase order number.StringField
getShippingAddress()
Customer's delivery address.StringField
getSupplierAddress()
The address of the supplier or merchant.List<CompanyRegistrationField>
getSupplierCompanyRegistrations()
List of company registration numbers associated to the supplier.StringField
getSupplierEmail()
The email address of the supplier or merchant.StringField
getSupplierName()
The name of the supplier or merchant.List<PaymentDetailsField>
getSupplierPaymentDetails()
List of payment details associated to the supplier of the invoice.StringField
getSupplierPhoneNumber()
The phone number of the supplier or merchant.StringField
getSupplierWebsite()
The website URL of the supplier or merchant.Taxes
getTaxes()
List of taxes.AmountField
getTotalAmount()
The total amount of the invoice: includes taxes, tips, fees, and other charges.AmountField
getTotalNet()
The net amount of the invoice: does not include taxes, fees, and discounts.AmountField
getTotalTax()
The total tax: the sum of all the taxes for this invoice.int
hashCode()
boolean
isEmpty()
Returnstrue
if there are no predictions values.String
toString()
-
-
-
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.
-
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.
-
-
Method Detail
-
isEmpty
public boolean isEmpty()
Description copied from class:Prediction
Returnstrue
if there are no predictions values. Accessing prediction values when this istrue
may result in aNullPointerException
- Specified by:
isEmpty
in classPrediction
-
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.
-
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)
-
-