ReceiptHero JSON

Please check HeroJSON Specification for implementation details!

{
    "merchant": {
        "name": "Global Receipt Delicatesse",
        "companyID": "123456-7",
        "branch": {
            "id": "45910",
            "name": "Receipt Restaurant",
            "subName": "FastFood",
            "posId": "003287",
            "email": "restaurant@example.com",
            "phone": "040-5086462",
            "websiteURL": "https://www.getreceipthero.com/",
            "address": {
                "streetAddress": "Finlaysoninkatu 7",
                "city": "Tampere",
                "zipCode": "733210",
                "country": "Finland"
            }
        }
    },
    "products": [
        {
            "name": "Ground Control",
            "EANCode": "42222130165",
            "quantity": "4",
            "productId": "1234",
            "quantityCode": "PCS",
            "unitPriceIncVAT": 5180,
            "unitPriceIncVATDecimal": "51,80",
            "totalAmountExcVAT": 18836,
            "totalAmountIncVAT": 20720,
            "vats": [
                {
                    "VATRate": "24",
                    "VATAmount": 1884,
                    "totalAmountExcVAT": 18836,
                    "totalAmountIncVAT": 20720
                }
            ],
            "discounts": [
                {
                    "amount": 2027,
                    "percentage": "10.00",
                    "description": "Loyalty discount"
                }
            ],
            "freeText": "Product instructions etc",
            "customAttributes": [
                {
                    "Warranty": "2 years"
                },
                {
                    "Valid until": "2024-01-14"
                }
            ]
        }
    ],
    "freeText": "Custom greetings etc",
    "vats": [
        {
            "VATRate": "24",
            "totalVATAmount": 1884,
            "totalAmountExcVAT": 18836,
            "totalAmountIncVAT": 20720,
            "VATCode": "A"
        }
    ],
    "payments": [
        {
            "type": "CARD",
            "amount": 13243,
            "attributes": {
                "cardType": "Debit Mastercard",
                "maskedPAN": "557760******3201",
                "timeStamp": "2022-09-01T06:02:23Z",
                "terminalId": "BS-4545F9",
                "referenceNumber": "220901015555",
                "authorizationCode": "HIU456",
                "authorizationMethodType": "00948",
                "transactionId": "05555",
                "transactionType": "PURCHASE",
                "transactionRawText": "CARD TRANSACTION\n\nCard: Debit Mastercard\n **** **** **** 3201 LN\nApplication: A0000000041010\nTr.Nr/Auth: 05555/HIU456\nPayee/business: 0029432413000/0001\n\nReference: 220901015555\n\nCredit/Charge 132,43 EUR\nPayPass Contactless \n\n"
            },
            "customAttributes": [
                {
                    "key": "value"
                },
                {
                    "key2": "value2"
                },
                {
                    "key3": "value3"
                }
            ]
        },
        {
            "type": "LOYALTY",
            "amount": 18243,
            "attributes": {
                "cardType": "Plussa",
                "maskedPAN": "1881"
            },
            "customAttributes": [
                {
                    "ExtraBonus": "234 points"
                },
                {
                    "key2": "value2"
                },
                {
                    "key3": "value3"
                }
            ]
        },
        {
            "type": "CASH",
            "amount": 5000,
            "attributes": {
                "handedAmount": 5000
            }
        }
    ],
    "customAttributes": [
        {
            "key": "value"
        },
        {
            "key2": "value2"
        },
        {
            "key3": "value3"
        }
    ],
    "receiptNumber": "89942344234",
    "receiptTimeStamp": "2022-09-01T06:02:20.715Z",
    "currencyISOCode": "EUR",
    "totalVATAmount": 1884,
    "totalPriceExcVAT": 16359,
    "totalPriceIncVAT": 18243,
    "attachments": [
        {
            "type": "QRCODE",
            "kind": "RETURN",
            "title": "Scan me at cash register",
            "description": "Show this code at cash register if you wish to return items from this purchase.",
            "data": "89942344234"
        }
    ]
}

Last updated