Extract Receipt Data

Extracted Data Types

The following types will always be present in the API response. If a type parameter is not found in the input, its value will be null.

Parameter Name	Variable Type
`receipt_number`	string \| null
`receipt_vendor_name`	string \| null
`receipt_vendor_address`	string \| null
`receipt_vat_reg_tin`	string \| null
`receipt_vendor_contact_number`	string \| null
`receipt_date`	string \| null
`receipt_time`	string \| null
`receipt_item`	Array of Objects
`receipt_item[].item_quantity`	string \| null
`receipt_item[].item_description`	string \| null
`receipt_item[].item_per_unit_price`	string \| null
`receipt_item[].item_total_amount`	string \| null
`receipt_vatable_sales`	string \| null
`receipt_vat_exempt_sales`	string \| null
`receipt_vat_zero_rated_sales`	string \| null
`receipt_vat_rate`	string \| null
`receipt_vat_amount`	string \| null
`receipt_subtotal`	string \| null
`receipt_total_include_tax`	string \| null
`receipt_total_paid`	string \| null
`receipt_change`	string \| null

Notes

Each type parameter in the data array will always have the specified type, with the possibility of being null.

If a specific type parameter is not present in the input, its value in the response will be null.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "receipt_number",
            "value": "113067-2-0064216"
        },
        {
            "type": "receipt_vendor_name",
            "value": "JOLLIBEE FOODS CORPORATION"
        },
        {
            "type": "receipt_vendor_address",
            "value": "Jollibee North Harbour Marcos Highway corner Zaragoza St, Metro Manila"
        },
        {
            "type": "receipt_vat_reg_tin",
            "value": "000-388-771-463"
        },
        {
            "type": "receipt_vendor_contact_number",
            "value": null
        },
        {
            "type": "receipt_date",
            "value": "02/15/2020"
        },
        {
            "type": "receipt_time",
            "value": "5:46 AM"
        },
        {
            "type": "receipt_item",
            "value": [
                {
                    "item_quantity": "2",
                    "item_description": "VM YUM FP",
                    "item_per_unit_price": "79.00",
                    "item_total_amount": "158.00"
                },
                {
                    "item_quantity": "2",
                    "item_description": "COFFEE",
                    "item_per_unit_price": "14.00",
                    "item_total_amount": "28.00"
                }
            ]
        },
        {
            "type": "receipt_vatable_sales",
            "value": "166.07"
        },
        {
            "type": "receipt_vat_exempt_sales",
            "value": "0.00"
        },
        {
            "type": "receipt_vat_zero_rated_sales",
            "value": "0.00"
        },
        {
            "type": "receipt_vat_rate",
            "value": null
        },
        {
            "type": "receipt_vat_amount",
            "value": "19.93"
        },
        {
            "type": "receipt_subtotal",
            "value": "166.07"
        },
        {
            "type": "receipt_total_include_tax",
            "value": "186.00"
        },
        {
            "type": "receipt_total_paid",
            "value": "200.00"
        },
        {
            "type": "receipt_change",
            "value": "14.00"
        }
    ],
    "miscellaneous": {
        "processedTime": 102.456
    }
}

Extract Receipt Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes