java.lang.Object
- com.mindee.parsing.common.Prediction
- - com.mindee.product.financialdocument.FinancialDocumentV1Document

public class FinancialDocumentV1Document
extends Prediction

Financial Document API version 1.11 document data.

Field Summary

Fields
Modifier and Type	Field	Description
`protected StringField`	`billingAddress`	The customer's address used for billing.
`protected ClassificationField`	`category`	The purchase category among predefined classes.
`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.
`protected DateField`	`date`	The date the purchase was made.
`protected StringField`	`documentNumber`	The document number or identifier.
`protected ClassificationField`	`documentType`	One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
`protected DateField`	`dueDate`	The date on which the payment is due.
`protected StringField`	`invoiceNumber`	The invoice number or identifier only if document is an invoice.
`protected List<FinancialDocumentV1LineItem>`	`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 / fullfilled.
`protected StringField`	`poNumber`	The purchase order number.
`protected StringField`	`receiptNumber`	The receipt number or identifier only if document is a receipt.
`protected List<StringField>`	`referenceNumbers`	List of Reference numbers, including PO number.
`protected StringField`	`shippingAddress`	The customer's address used for shipping.
`protected ClassificationField`	`subcategory`	The purchase subcategory among predefined classes for transport and food.
`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 lines information.
`protected StringField`	`time`	The time the purchase was made.
`protected AmountField`	`tip`	The total amount of tip and gratuity
`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 amount of taxes.

Constructor Summary

Constructors
Constructor Description

FinancialDocumentV1Document()

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.
`ClassificationField`	`getCategory()`	The purchase category among predefined classes.
`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.
`DateField`	`getDate()`	The date the purchase was made.
`StringField`	`getDocumentNumber()`	The document number or identifier.
`ClassificationField`	`getDocumentType()`	One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
`DateField`	`getDueDate()`	The date on which the payment is due.
`StringField`	`getInvoiceNumber()`	The invoice number or identifier only if document is an invoice.
`List<FinancialDocumentV1LineItem>`	`getLineItems()`	List of line item details.
`LocaleField`	`getLocale()`	The locale detected on the document.
`DateField`	`getPaymentDate()`	The date on which the payment is due / fullfilled.
`StringField`	`getPoNumber()`	The purchase order number.
`StringField`	`getReceiptNumber()`	The receipt number or identifier only if document is a receipt.
`List<StringField>`	`getReferenceNumbers()`	List of Reference numbers, including PO number.
`StringField`	`getShippingAddress()`	The customer's address used for shipping.
`ClassificationField`	`getSubcategory()`	The purchase subcategory among predefined classes for transport and food.
`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 lines information.
`StringField`	`getTime()`	The time the purchase was made.
`AmountField`	`getTip()`	The total amount of tip and gratuity
`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 amount of taxes.
`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.
  - category
```
protected ClassificationField category
```
    The purchase category among predefined classes.
  - 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.
  - date
```
protected DateField date
```
    The date the purchase was made.
  - documentNumber
```
protected StringField documentNumber
```
    The document number or identifier.
  - documentType
```
protected ClassificationField documentType
```
    One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
  - dueDate
```
protected DateField dueDate
```
    The date on which the payment is due.
  - invoiceNumber
```
protected StringField invoiceNumber
```
    The invoice number or identifier only if document is an invoice.
  - lineItems
```
protected List<FinancialDocumentV1LineItem> 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 / fullfilled.
  - poNumber
```
protected StringField poNumber
```
    The purchase order number.
  - receiptNumber
```
protected StringField receiptNumber
```
    The receipt number or identifier only if document is a receipt.
  - referenceNumbers
```
protected List<StringField> referenceNumbers
```
    List of Reference numbers, including PO number.
  - shippingAddress
```
protected StringField shippingAddress
```
    The customer's address used for shipping.
  - subcategory
```
protected ClassificationField subcategory
```
    The purchase subcategory among predefined classes for transport and food.
  - 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 lines information.
  - time
```
protected StringField time
```
    The time the purchase was made.
  - tip
```
protected AmountField tip
```
    The total amount of tip and gratuity
  - 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 amount of taxes.
- Constructor Detail
  - FinancialDocumentV1Document
```
public FinancialDocumentV1Document()
```
- 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.
  - getCategory
```
public ClassificationField getCategory()
```
    The purchase category among predefined classes.
  - 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.
  - getDate
```
public DateField getDate()
```
    The date the purchase was made.
  - getDocumentNumber
```
public StringField getDocumentNumber()
```
    The document number or identifier.
  - getDocumentType
```
public ClassificationField getDocumentType()
```
    One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
  - getDueDate
```
public DateField getDueDate()
```
    The date on which the payment is due.
  - getInvoiceNumber
```
public StringField getInvoiceNumber()
```
    The invoice number or identifier only if document is an invoice.
  - getLineItems
```
public List<FinancialDocumentV1LineItem> 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 / fullfilled.
  - getPoNumber
```
public StringField getPoNumber()
```
    The purchase order number.
  - getReceiptNumber
```
public StringField getReceiptNumber()
```
    The receipt number or identifier only if document is a receipt.
  - getReferenceNumbers
```
public List<StringField> getReferenceNumbers()
```
    List of Reference numbers, including PO number.
  - getShippingAddress
```
public StringField getShippingAddress()
```
    The customer's address used for shipping.
  - getSubcategory
```
public ClassificationField getSubcategory()
```
    The purchase subcategory among predefined classes for transport and food.
  - 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 lines information.
  - getTime
```
public StringField getTime()
```
    The time the purchase was made.
  - getTip
```
public AmountField getTip()
```
    The total amount of tip and gratuity
  - 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 amount of taxes.
  - 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 FinancialDocumentV1Document

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

billingAddress

category

customerAddress

customerCompanyRegistrations

customerId

customerName

date

documentNumber

documentType

dueDate

invoiceNumber

lineItems

locale

paymentDate

poNumber

receiptNumber

referenceNumbers

shippingAddress

subcategory

supplierAddress

supplierCompanyRegistrations

supplierEmail

supplierName

supplierPaymentDetails

supplierPhoneNumber

supplierWebsite

taxes

time

tip

totalAmount

totalNet

totalTax

Constructor Detail

FinancialDocumentV1Document

Method Detail

isEmpty

toString

getBillingAddress

getCategory

getCustomerAddress

getCustomerCompanyRegistrations

getCustomerId

getCustomerName

getDate

getDocumentNumber

getDocumentType

getDueDate

getInvoiceNumber

getLineItems

getLocale

getPaymentDate

getPoNumber

getReceiptNumber

getReferenceNumbers

getShippingAddress

getSubcategory

getSupplierAddress

getSupplierCompanyRegistrations

getSupplierEmail

getSupplierName

getSupplierPaymentDetails

getSupplierPhoneNumber

getSupplierWebsite

getTaxes

getTime

getTip

getTotalAmount

getTotalNet

getTotalTax

equals

canEqual

hashCode