Receipt

The Java SDK supports the Mindee V1 Receipt API.

Product Specifications

Specification

Details

Endpoint Name

expense_receipts

Recommended Version

v5.5

Supports Polling/Webhooks

✔️ Yes

Support Synchronous HTTP Calls

✔️ Yes

Geography

🌐 Global

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.PredictResponse;
import com.mindee.product.receipt.ReceiptV5;
import java.io.File;
import java.io.IOException;

public class SimpleMindeeClient {

  public static void main(String[] args) throws IOException {
    String apiKey = "my-api-key";
    String filePath = "/path/to/the/file.ext";

    // Init a new client
    MindeeClient mindeeClient = new MindeeClient(apiKey);

    // Load a file from disk
    LocalInputSource inputSource = new LocalInputSource(filePath);

    // Parse the file
    PredictResponse<ReceiptV5> response = mindeeClient.parse(
        ReceiptV5.class,
        inputSource
    );

    // Print a summary of the response
    System.out.println(response.toString());

    // Print a summary of the predictions
//  System.out.println(response.getDocument().toString());

    // Print the document-level predictions
//    System.out.println(response.getDocument().getInference().getPrediction().toString());

    // Print the page-level predictions
//    response.getDocument().getInference().getPages().forEach(
//        page -> System.out.println(page.toString())
//    );
  }

}

You can also call this product asynchronously:

import com.mindee.MindeeClient;
import com.mindee.input.LocalInputSource;
import com.mindee.parsing.common.AsyncPredictResponse;
import com.mindee.product.receipt.ReceiptV5;
import java.io.File;
import java.io.IOException;

public class SimpleMindeeClient {

  public static void main(String[] args) throws IOException, InterruptedException {
    String apiKey = "my-api-key";
    String filePath = "/path/to/the/file.ext";

    // Init a new client
    MindeeClient mindeeClient = new MindeeClient(apiKey);

    // Load a file from disk
    LocalInputSource inputSource = new LocalInputSource(new File(filePath));

    // Parse the file asynchronously
    AsyncPredictResponse<ReceiptV5> response = mindeeClient.enqueueAndParse(
        ReceiptV5.class,
        inputSource
    );

    // Print a summary of the response
    System.out.println(response.toString());

    // Print a summary of the predictions
//  System.out.println(response.getDocumentObj().toString());

    // Print the document-level predictions
//    System.out.println(response.getDocumentObj().getInference().getPrediction().toString());

    // Print the page-level predictions
//    response.getDocumentObj().getInference().getPages().forEach(
//        page -> System.out.println(page.toString())
//    );
  }

}

Sample Output (rST)

########
Document
########
:Mindee ID: d96fb043-8fb8-4adc-820c-387aae83376d
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/expense_receipts v5.3
:Rotation applied: Yes

Prediction
==========
:Expense Locale: en-GB; en; GB; GBP;
:Purchase Category: food
:Purchase Subcategory: restaurant
:Document Type: EXPENSE RECEIPT
:Purchase Date: 2016-02-26
:Purchase Time: 15:20
:Total Amount: 10.20
:Total Net: 8.50
:Total Tax: 1.70
:Tip and Gratuity:
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 8.50          | VAT    | 20.00    | 1.70          |
  +---------------+--------+----------+---------------+
:Supplier Name: Clachan
:Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
                                 Type: VAT NUMBER, Value: 232153895
:Supplier Address: 34 Kingley Street W1B 50H
:Supplier Phone Number: 02074940834
:Receipt Number: 54/7500
:Line Items:
  +--------------------------------------+----------+--------------+------------+
  | Description                          | Quantity | Total Amount | Unit Price |
  +======================================+==========+==============+============+
  | Meantime Pale                        | 2.00     | 10.20        |            |
  +--------------------------------------+----------+--------------+------------+

Page Predictions
================

Page 0
------
:Expense Locale: en-GB; en; GB; GBP;
:Purchase Category: food
:Purchase Subcategory: restaurant
:Document Type: EXPENSE RECEIPT
:Purchase Date: 2016-02-26
:Purchase Time: 15:20
:Total Amount: 10.20
:Total Net: 8.50
:Total Tax: 1.70
:Tip and Gratuity:
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 8.50          | VAT    | 20.00    | 1.70          |
  +---------------+--------+----------+---------------+
:Supplier Name: Clachan
:Supplier Company Registrations: Type: VAT NUMBER, Value: 232153895
                                 Type: VAT NUMBER, Value: 232153895
:Supplier Address: 34 Kingley Street W1B 50H
:Supplier Phone Number: 02074940834
:Receipt Number: 54/7500
:Line Items:
  +--------------------------------------+----------+--------------+------------+
  | Description                          | Quantity | Total Amount | Unit Price |
  +======================================+==========+==============+============+
  | Meantime Pale                        | 2.00     | 10.20        |            |
  +--------------------------------------+----------+--------------+------------+

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

confidence (Double): the confidence score of the field prediction.
boundingBox (Polygon): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
polygon (Polygon): contains the relative vertices coordinates (polygon extends List<Point>) of a polygon containing the field in the image.
pageId (Integer): the ID of the page, always null when at document-level.

A Point simply refers to a List of Double.

Aside from the previous attributes, all basic fields have access to a custom toString method that can be used to print their value as a string.

AddressField

Aside from the basic BaseField attributes, the address field AddressField also implements the following:

streetNumber (String): String representation of the street number. Can be null.
streetName (String): Name of the street. Can be null.
poBox (String): String representation of the PO Box number. Can be null.
addressComplement (String): Address complement. Can be null.
city (String): City name. Can be null.
postalcode (String): String representation of the postal code. Can be null.
state (String): State name. Can be null.
country (String): Country name. Can be null.

The value field of an AddressField should be a concatenation of the rest of the values.

AmountField

An amount field AmountField extends BaseField, but also implements:

value (Double): corresponds to the field value. Can be null if no value was extracted.

ClassificationField

The classification field ClassificationField extends BaseField, but also implements:

value (strong): corresponds to the field value.
confidence (double): the confidence score of the field prediction.

A classification field's value is always a String.

CompanyRegistrationField

Aside from the basic BaseField attributes, the company registration field CompanyRegistrationField also implements the following:

type (String): the type of company.
value (String): corresponds to the field value.
toTableLine(): a method that formats the data to fit in a .rst display.

StringField

The text field StringField extends BaseField, but also implements:

value (String): corresponds to the field value.
rawValue (String): corresponds to the raw value as it appears on the document.

DateField

The date field DateField extends BaseField, but also implements:

value (LocalDate): an accessible representation of the value as a Java object. Can be null.

LocaleField

The locale field LocaleField extends BaseField, but also implements:

value (LocalDate): an accessible representation of the value as a Java object. Can be null.
language (String): ISO 639-1 language code (e.g.: en for English). Can be null.
country (String): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: GRB or GB for "Great Britain"). Can be null.
currency (String): ISO 4217 code for currencies (e.g.: USD for "US Dollars"). Can be null.

Taxes

TaxField

Aside from the basic BaseField attributes, the tax field TaxField also implements the following:

rate (Double): the tax rate applied to an item expressed as a percentage. Can be null.
code (String): tax code (or equivalent, depending on the origin of the document).
base (Double): base amount used for the tax. Can be null.
value (Double): the value of the tax. Can be null.

Currently TaxField is not used on its own, and is accessed through a parent Taxes object, a list-like structure.

Taxes (List)

The Taxes field represents a List of TaxField objects. As it is the representation of several objects, it has access to a custom toString method that can render a TaxField object as a table line.

Specific Fields

Fields which are specific to this product; they are not used in any other product.

Line Items Field

List of all line items on the receipt.

A ReceiptV5LineItem implements the following attributes:

description (String): The item description.
quantity (Double): The item quantity.
totalAmount (Double): The item total amount.
unitPrice (Double): The item unit price.

Attributes

The following fields are extracted for Receipt V5:

Purchase Category

category: The purchase category of the receipt.

Possible values include:

'toll'
'food'
'parking'
'transport'
'accommodation'
'gasoline'
'telecom'
'miscellaneous'
'software'
'shopping'
'energy'

System.out.println(
  result.getDocument().getInference().getPrediction().getCategory().value
);

Purchase Date

date: The date the purchase was made.

System.out.println(
  result.getDocument().getInference().getPrediction().getDate().value
);

Document Type

documentType: The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.

Possible values include:

'EXPENSE RECEIPT'
'CREDIT CARD RECEIPT'
'OTHER'

System.out.println(
  result.getDocument().getInference().getPrediction().getDocumentType().value
);

Line Items

lineItems(List<ReceiptV5LineItem>): List of all line items on the receipt.

for (lineItemsElem : result.getDocument().getInference().getPrediction().getLineItems())
{
    System.out.println(lineItemsElem.value);
}

Expense Locale

locale: The locale of the document.

System.out.println(
  result.getDocument().getInference().getPrediction().getLocale().value
);

Receipt Number

receiptNumber: The receipt number or identifier.

System.out.println(
  result.getDocument().getInference().getPrediction().getReceiptNumber().value
);

Purchase Subcategory

subcategory: The purchase subcategory of the receipt for transport and food.

Possible values include:

'plane'
'taxi'
'train'
'restaurant'
'shopping'
'other'
'groceries'
'cultural'
'electronics'
'office_supplies'
'micromobility'
'car_rental'
'public'
'delivery'
null

System.out.println(
  result.getDocument().getInference().getPrediction().getSubcategory().value
);

Supplier Address

supplierAddress: The address of the supplier or merchant.

System.out.println(
  result.getDocument().getInference().getPrediction().getSupplierAddress().value
);

Supplier Company Registrations

supplierCompanyRegistrations: List of company registration numbers associated to the supplier.

for (supplierCompanyRegistrationsElem : result.getDocument().getInference().getPrediction().getSupplierCompanyRegistrations())
{
    System.out.println(supplierCompanyRegistrationsElem.value);
}

Supplier Name

supplierName: The name of the supplier or merchant.

System.out.println(
  result.getDocument().getInference().getPrediction().getSupplierName().value
);

Supplier Phone Number

supplierPhoneNumber: The phone number of the supplier or merchant.

System.out.println(
  result.getDocument().getInference().getPrediction().getSupplierPhoneNumber().value
);

Taxes

taxes: The list of taxes present on the receipt.

for (taxesElem : result.getDocument().getInference().getPrediction().getTaxes())
{
    System.out.println(taxesElem.value);
}

Purchase Time

time: The time the purchase was made.

System.out.println(
  result.getDocument().getInference().getPrediction().getTime().value
);

Tip and Gratuity

tip: The total amount of tip and gratuity.

System.out.println(
  result.getDocument().getInference().getPrediction().getTip().value
);

Total Amount

totalAmount: The total amount paid: includes taxes, discounts, fees, tips, and gratuity.

System.out.println(
  result.getDocument().getInference().getPrediction().getTotalAmount().value
);

Total Net

totalNet: The net amount paid: does not include taxes, fees, and discounts.

System.out.println(
  result.getDocument().getInference().getPrediction().getTotalNet().value
);

Total Tax

totalTax: The sum of all taxes.

System.out.println(
  result.getDocument().getInference().getPrediction().getTotalTax().value
);

PreviousInvoice NextBusiness Card

Last updated 1 month ago

Was this helpful?

Good night

Receipt

Product Specifications

Quick-Start

Sample Code

Sample Output (rST)

Field Types

Standard Fields

BaseField

AddressField

AmountField

ClassificationField

CompanyRegistrationField

StringField

DateField

LocaleField

Taxes

Specific Fields

Line Items Field

Attributes

Purchase Category

Purchase Date

Document Type

Line Items

Expense Locale

Receipt Number

Purchase Subcategory

Supplier Address

Supplier Company Registrations

Supplier Name

Supplier Phone Number

Taxes

Purchase Time

Tip and Gratuity

Total Amount

Total Net

Total Tax