Documentation

Including the Script

To use ReceiptScan in your web application, include the following script tag in your HTML file:

<script async src="https://app.receiptscan.co.uk/receiptscan.js?key=AAAAA11111111222222"></script>

Replace AAAAA11111111222222 with your actual API key.

Using ReceiptScan

The ReceiptScan function can be used in several ways:

1. With a File Object (Callback)

receiptScan(fileObject, fields, function(result, error) {
    if (error) {
        console.error(error);
    } else {
        console.log(result);
    }
});

2. With a URL (Callback)

receiptScan('https://example.com/receipt.jpg', fields, function(result, error) {
    if (error) {
        console.error(error);
    } else {
        console.log(result);
    }
});

Note: Be mindful of CORS

3. With a File Object (Async/Await)

async function scanReceipt(fileObject) {
    try {
        const results = await receiptScan(fileObject);
        console.log(results);
    } catch (error) {
        console.error(error);
    }
}
scanReceipt();

4. With a URL (Async/Await)

async function scanReceipt() {
    try {
        const results = await receiptScan('https://example.com/receipt.pdf');
        console.log(results);
    } catch (error) {
        console.error(error);
    }
}
scanReceipt();

Note: Be mindful of CORS

5. Using the File Input Listener

To add a listener to a file input element:

<input type="file" id="receiptInput">

<script>
receiptScanListener('receiptInput', fields);
</script>

The 'fields' Parameter

The fields parameter is an array of objects that specify which fields from the scanned document should be mapped to which HTML elements. For example:

const fields = [
    { Field: "Total", Element: "totalAmount" },
    { Field: "ReceiptDate", Element: "purchaseDate" },
    { Field: "ReceiptNumber", Element: "reference" }
];

receiptScan(fileObject, fields, function(result, error) {
// Handle result or error
});

In this example, the "Total" field from the scanned document will be placed into an HTML element with the id "totalAmount", and so on.

If you do not want the form to auto populate, provide a blank string '' to the fields parameter.

Response

The API returns a JSON object with the following properties:

Example Response

{
    "ReceiptDate": "01/08/2024",
    "NetValue": 6.12,
    "TaxValue": 1.23,
    "Total": 7.35,
    "TaxRate": "20%",
    "ReceiptNumber": "",
    "Summary": "Isopropanol Alcohol IPA 99.99% 1L\nShipping Charges: £0.00",
    "OrderNumber": "026-1936828-2277101",
    "VATNumber": "GB205462631",
    "Retailer": "Trade Chemicals Limited",
    "items": [
        {
            "Description": "Isopropanol Alcohol IPA 99.99% 1L",
            "Price": 6.12,
            "Qty": 1
        }
    ]
}

Notes

• ReceiptScan supports both image files and PDF documents.
• The API key is automatically included in requests, you don't need to handle it manually.
• Always handle potential errors in your code to ensure a smooth user experience.

Coming soon!