java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.invoice.InvoiceV4Document

public class InvoiceV4Document
extends Prediction

Invoice API version 4.11 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected AddressField`	`billingAddress`	The customer billing address.
`protected ClassificationField`	`category`	The purchase category.
`protected AddressField`	`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 ClassificationField`	`documentTypeExtended`	Document type extended.
`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 AddressField`	`shippingAddress`	Customer's delivery address.
`protected ClassificationField`	`subcategory`	The purchase subcategory for transport, food and shopping.
`protected AddressField`	`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)`
`AddressField`	`getBillingAddress()`	The customer billing address.
`ClassificationField`	`getCategory()`	The purchase category.
`AddressField`	`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.
`ClassificationField`	`getDocumentTypeExtended()`	Document type extended.
`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.
`AddressField`	`getShippingAddress()`	Customer's delivery address.
`ClassificationField`	`getSubcategory()`	The purchase subcategory for transport, food and shopping.
`AddressField`	`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()`	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 AddressField billingAddress
```
    The customer billing address.
  - category
```
protected ClassificationField category
```
    The purchase category.
  - customerAddress
```
protected AddressField 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 AddressField shippingAddress
```
    Customer's delivery address.
  - subcategory
```
protected ClassificationField subcategory
```
    The purchase subcategory for transport, food and shopping.
  - supplierAddress
```
protected AddressField 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBillingAddress
```
public AddressField getBillingAddress()
```
    The customer billing address.
  - getCategory
```
public ClassificationField getCategory()
```
    The purchase category.
  - getCustomerAddress
```
public AddressField 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 AddressField getShippingAddress()
```
    Customer's delivery address.
  - getSubcategory
```
public ClassificationField getSubcategory()
```
    The purchase subcategory for transport, food and shopping.
  - getSupplierAddress
```
public AddressField 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.
  - 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

category

customerAddress

customerCompanyRegistrations

customerId

customerName

date

documentType

documentTypeExtended

dueDate

invoiceNumber

lineItems

locale

paymentDate

poNumber

referenceNumbers

shippingAddress

subcategory

supplierAddress

supplierCompanyRegistrations

supplierEmail

supplierName

supplierPaymentDetails

supplierPhoneNumber

supplierWebsite

taxes

totalAmount

totalNet

totalTax

Constructor Detail

InvoiceV4Document

Method Detail

isEmpty

toString

getBillingAddress

getCategory

getCustomerAddress

getCustomerCompanyRegistrations

getCustomerId

getCustomerName

getDate

getDocumentType

getDocumentTypeExtended

getDueDate

getInvoiceNumber

getLineItems

getLocale

getPaymentDate

getPoNumber

getReferenceNumbers

getShippingAddress

getSubcategory

getSupplierAddress

getSupplierCompanyRegistrations

getSupplierEmail

getSupplierName

getSupplierPaymentDetails

getSupplierPhoneNumber

getSupplierWebsite

getTaxes

getTotalAmount

getTotalNet

getTotalTax

equals

canEqual

hashCode