Package com.mindee.product.receipt
Class ReceiptV5Document
- java.lang.Object
-
- com.mindee.parsing.common.Prediction
-
- com.mindee.product.receipt.ReceiptV5Document
-
public class ReceiptV5Document extends Prediction
Receipt API version 5.3 document data.
-
-
Field Summary
Fields Modifier and Type Field Description protected ClassificationField
category
The purchase category of the receipt.protected DateField
date
The date the purchase was made.protected ClassificationField
documentType
The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.protected List<ReceiptV5LineItem>
lineItems
List of all line items on the receipt.protected LocaleField
locale
The locale of the document.protected StringField
receiptNumber
The receipt number or identifier.protected ClassificationField
subcategory
The purchase subcategory of the receipt for transport and food.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
supplierName
The name of the supplier or merchant.protected StringField
supplierPhoneNumber
The phone number of the supplier or merchant.protected Taxes
taxes
The list of taxes present on the receipt.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, discounts, fees, tips, and gratuity.protected AmountField
totalNet
The net amount paid: does not include taxes, fees, and discounts.protected AmountField
totalTax
The sum of all taxes.
-
Constructor Summary
Constructors Constructor Description ReceiptV5Document()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
ClassificationField
getCategory()
The purchase category of the receipt.DateField
getDate()
The date the purchase was made.ClassificationField
getDocumentType()
The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.List<ReceiptV5LineItem>
getLineItems()
List of all line items on the receipt.LocaleField
getLocale()
The locale of the document.StringField
getReceiptNumber()
The receipt number or identifier.ClassificationField
getSubcategory()
The purchase subcategory of the receipt for transport and food.StringField
getSupplierAddress()
The address of the supplier or merchant.List<CompanyRegistrationField>
getSupplierCompanyRegistrations()
List of company registration numbers associated to the supplier.StringField
getSupplierName()
The name of the supplier or merchant.StringField
getSupplierPhoneNumber()
The phone number of the supplier or merchant.Taxes
getTaxes()
The list of taxes present on the receipt.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, discounts, fees, tips, and gratuity.AmountField
getTotalNet()
The net amount paid: does not include taxes, fees, and discounts.AmountField
getTotalTax()
The sum of all taxes.int
hashCode()
boolean
isEmpty()
Returnstrue
if there are no predictions values.String
toString()
-
-
-
Field Detail
-
category
protected ClassificationField category
The purchase category of the receipt.
-
date
protected DateField date
The date the purchase was made.
-
documentType
protected ClassificationField documentType
The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
-
lineItems
protected List<ReceiptV5LineItem> lineItems
List of all line items on the receipt.
-
locale
protected LocaleField locale
The locale of the document.
-
receiptNumber
protected StringField receiptNumber
The receipt number or identifier.
-
subcategory
protected ClassificationField subcategory
The purchase subcategory of the receipt for transport and food.
-
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.
-
supplierName
protected StringField supplierName
The name of the supplier or merchant.
-
supplierPhoneNumber
protected StringField supplierPhoneNumber
The phone number of the supplier or merchant.
-
taxes
protected Taxes taxes
The list of taxes present on the receipt.
-
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, discounts, fees, tips, and gratuity.
-
totalNet
protected AmountField totalNet
The net amount paid: does not include taxes, fees, and discounts.
-
totalTax
protected AmountField totalTax
The sum of all taxes.
-
-
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
-
getCategory
public ClassificationField getCategory()
The purchase category of the receipt.
-
getDate
public DateField getDate()
The date the purchase was made.
-
getDocumentType
public ClassificationField getDocumentType()
The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
-
getLineItems
public List<ReceiptV5LineItem> getLineItems()
List of all line items on the receipt.
-
getLocale
public LocaleField getLocale()
The locale of the document.
-
getReceiptNumber
public StringField getReceiptNumber()
The receipt number or identifier.
-
getSubcategory
public ClassificationField getSubcategory()
The purchase subcategory of the receipt for transport and food.
-
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.
-
getSupplierName
public StringField getSupplierName()
The name of the supplier or merchant.
-
getSupplierPhoneNumber
public StringField getSupplierPhoneNumber()
The phone number of the supplier or merchant.
-
getTaxes
public Taxes getTaxes()
The list of taxes present on the receipt.
-
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, discounts, fees, tips, and gratuity.
-
getTotalNet
public AmountField getTotalNet()
The net amount paid: does not include taxes, fees, and discounts.
-
getTotalTax
public AmountField getTotalTax()
The sum of all taxes.
-
canEqual
protected boolean canEqual(Object other)
-
-