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

public class FinancialDocumentV1Document
extends Prediction

Financial Document API version 1.12 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, only for receipts.
`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.
`protected DateField`	`date`	The date the purchase was made.
`protected StringField`	`documentNumber`	The document number or identifier (invoice number or receipt number).
`protected ClassificationField`	`documentType`	The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
`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 only if document is an invoice.
`protected List<FinancialDocumentV1LineItem>`	`lineItems`	List of line item present on the document.
`protected LocaleField`	`locale`	The locale of the document.
`protected DateField`	`paymentDate`	The date on which the payment is due / fullfilled.
`protected StringField`	`poNumber`	The purchase order number, only if the document is an invoice.
`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, only if the document is an invoice.
`protected StringField`	`shippingAddress`	The customer's address used for shipping.
`protected ClassificationField`	`subcategory`	The purchase subcategory for transport and food, only for receipts.
`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 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 (only for invoices).
`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 all taxes on the document.
`protected StringField`	`time`	The time the purchase was made (only for receipts).
`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 sum of all taxes present on the document.

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, only for receipts.
`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.
`DateField`	`getDate()`	The date the purchase was made.
`StringField`	`getDocumentNumber()`	The document number or identifier (invoice number or receipt number).
`ClassificationField`	`getDocumentType()`	The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
`ClassificationField`	`getDocumentTypeExtended()`	Document type extended.
`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 present on the document.
`LocaleField`	`getLocale()`	The locale of the document.
`DateField`	`getPaymentDate()`	The date on which the payment is due / fullfilled.
`StringField`	`getPoNumber()`	The purchase order number, only if the document is an invoice.
`StringField`	`getReceiptNumber()`	The receipt number or identifier only if document is a receipt.
`List<StringField>`	`getReferenceNumbers()`	List of Reference numbers, including PO number, only if the document is an invoice.
`StringField`	`getShippingAddress()`	The customer's address used for shipping.
`ClassificationField`	`getSubcategory()`	The purchase subcategory for transport and food, only for receipts.
`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 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 (only for invoices).
`StringField`	`getSupplierPhoneNumber()`	The phone number of the supplier or merchant.
`StringField`	`getSupplierWebsite()`	The website URL of the supplier or merchant.
`Taxes`	`getTaxes()`	List of all taxes on the document.
`StringField`	`getTime()`	The time the purchase was made (only for receipts).
`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 sum of all taxes present on the document.
`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, only for receipts.
  - 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.
  - date
```
protected DateField date
```
    The date the purchase was made.
  - documentNumber
```
protected StringField documentNumber
```
    The document number or identifier (invoice number or receipt number).
  - documentType
```
protected ClassificationField documentType
```
    The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
  - 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 only if document is an invoice.
  - lineItems
```
protected List<FinancialDocumentV1LineItem> lineItems
```
    List of line item present on the document.
  - locale
```
protected LocaleField locale
```
    The locale of the document.
  - paymentDate
```
protected DateField paymentDate
```
    The date on which the payment is due / fullfilled.
  - poNumber
```
protected StringField poNumber
```
    The purchase order number, only if the document is an invoice.
  - 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, only if the document is an invoice.
  - shippingAddress
```
protected StringField shippingAddress
```
    The customer's address used for shipping.
  - subcategory
```
protected ClassificationField subcategory
```
    The purchase subcategory for transport and food, only for receipts.
  - 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 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 (only for invoices).
  - 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 all taxes on the document.
  - time
```
protected StringField time
```
    The time the purchase was made (only for receipts).
  - 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 sum of all taxes present on the document.
- 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, only for receipts.
  - 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.
  - getDate
```
public DateField getDate()
```
    The date the purchase was made.
  - getDocumentNumber
```
public StringField getDocumentNumber()
```
    The document number or identifier (invoice number or receipt number).
  - getDocumentType
```
public ClassificationField getDocumentType()
```
    The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
  - 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 only if document is an invoice.
  - getLineItems
```
public List<FinancialDocumentV1LineItem> getLineItems()
```
    List of line item present on the document.
  - getLocale
```
public LocaleField getLocale()
```
    The locale of the document.
  - getPaymentDate
```
public DateField getPaymentDate()
```
    The date on which the payment is due / fullfilled.
  - getPoNumber
```
public StringField getPoNumber()
```
    The purchase order number, only if the document is an invoice.
  - 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, only if the document is an invoice.
  - getShippingAddress
```
public StringField getShippingAddress()
```
    The customer's address used for shipping.
  - getSubcategory
```
public ClassificationField getSubcategory()
```
    The purchase subcategory for transport and food, only for receipts.
  - 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 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 (only for invoices).
  - 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 all taxes on the document.
  - getTime
```
public StringField getTime()
```
    The time the purchase was made (only for receipts).
  - 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 sum of all taxes present on the document.
  - 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

documentTypeExtended

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

getDocumentTypeExtended

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