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's address used for billing.
`protected StringField`	`customerAddress`	The address of the customer.
`protected List<CompanyRegistrationField>`	`customerCompanyRegistrations`	List of company registrations 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`	One of: 'INVOICE', '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 line item details.
`protected LocaleField`	`locale`	The locale detected on 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 Reference numbers, including PO 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 registrations associated to the supplier.
`protected StringField`	`supplierEmail`	The email 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.
`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 tax line details.
`protected AmountField`	`totalAmount`	The total amount paid: includes taxes, tips, fees, and other charges.
`protected AmountField`	`totalNet`	The net amount paid: does not include taxes, fees, and discounts.
`protected AmountField`	`totalTax`	The total tax: includes all the taxes paid 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's address used for billing.
`StringField`	`getCustomerAddress()`	The address of the customer.
`List<CompanyRegistrationField>`	`getCustomerCompanyRegistrations()`	List of company registrations 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()`	One of: 'INVOICE', 'CREDIT NOTE'.
`DateField`	`getDueDate()`	The date on which the payment is due.
`StringField`	`getInvoiceNumber()`	The invoice number or identifier.
`List<InvoiceV4LineItem>`	`getLineItems()`	List of line item details.
`LocaleField`	`getLocale()`	The locale detected on 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 Reference numbers, including PO number.
`StringField`	`getShippingAddress()`	Customer's delivery address.
`StringField`	`getSupplierAddress()`	The address of the supplier or merchant.
`List<CompanyRegistrationField>`	`getSupplierCompanyRegistrations()`	List of company registrations associated to the supplier.
`StringField`	`getSupplierEmail()`	The email 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.
`StringField`	`getSupplierPhoneNumber()`	The phone number of the supplier or merchant.
`StringField`	`getSupplierWebsite()`	The website URL of the supplier or merchant.
`Taxes`	`getTaxes()`	List of tax line details.
`AmountField`	`getTotalAmount()`	The total amount paid: includes taxes, tips, fees, and other charges.
`AmountField`	`getTotalNet()`	The net amount paid: does not include taxes, fees, and discounts.
`AmountField`	`getTotalTax()`	The total tax: includes all the taxes paid for this invoice.
`int`	`hashCode()`
`boolean`	`isEmpty()`	Returns `true` if there are no predictions values.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - billingAddress
```
protected StringField billingAddress
```
    The customer's address used for billing.
  - customerAddress
```
protected StringField customerAddress
```
    The address of the customer.
  - customerCompanyRegistrations
```
protected List<CompanyRegistrationField> customerCompanyRegistrations
```
    List of company registrations 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
```
    One of: 'INVOICE', '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 line item details.
  - locale
```
protected LocaleField locale
```
    The locale detected on 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 Reference numbers, including PO 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 registrations associated to the supplier.
  - supplierEmail
```
protected StringField supplierEmail
```
    The email 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.
  - 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 tax line details.
  - totalAmount
```
protected AmountField totalAmount
```
    The total amount paid: includes taxes, tips, fees, and other charges.
  - totalNet
```
protected AmountField totalNet
```
    The net amount paid: does not include taxes, fees, and discounts.
  - totalTax
```
protected AmountField totalTax
```
    The total tax: includes all the taxes paid 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBillingAddress
```
public StringField getBillingAddress()
```
    The customer's address used for billing.
  - getCustomerAddress
```
public StringField getCustomerAddress()
```
    The address of the customer.
  - getCustomerCompanyRegistrations
```
public List<CompanyRegistrationField> getCustomerCompanyRegistrations()
```
    List of company registrations 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()
```
    One of: 'INVOICE', '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 line item details.
  - getLocale
```
public LocaleField getLocale()
```
    The locale detected on 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 Reference numbers, including PO 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 registrations associated to the supplier.
  - getSupplierEmail
```
public StringField getSupplierEmail()
```
    The email 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.
  - 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 tax line details.
  - getTotalAmount
```
public AmountField getTotalAmount()
```
    The total amount paid: includes taxes, tips, fees, and other charges.
  - getTotalNet
```
public AmountField getTotalNet()
```
    The net amount paid: does not include taxes, fees, and discounts.
  - getTotalTax
```
public AmountField getTotalTax()
```
    The total tax: includes all the taxes paid for this invoice.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class InvoiceV4Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

billingAddress

customerAddress

customerCompanyRegistrations

customerId

customerName

date

documentType

dueDate

invoiceNumber

lineItems

locale

paymentDate

poNumber

referenceNumbers

shippingAddress

supplierAddress

supplierCompanyRegistrations

supplierEmail

supplierName

supplierPaymentDetails

supplierPhoneNumber

supplierWebsite

taxes

totalAmount

totalNet

totalTax

Constructor Detail

InvoiceV4Document

Method Detail

isEmpty

toString

getBillingAddress

getCustomerAddress

getCustomerCompanyRegistrations

getCustomerId

getCustomerName

getDate

getDocumentType

getDueDate

getInvoiceNumber

getLineItems

getLocale

getPaymentDate

getPoNumber

getReferenceNumbers

getShippingAddress

getSupplierAddress

getSupplierCompanyRegistrations

getSupplierEmail

getSupplierName

getSupplierPaymentDetails

getSupplierPhoneNumber

getSupplierWebsite

getTaxes

getTotalAmount

getTotalNet

getTotalTax

equals

canEqual

hashCode