Get list of payment bills

GET

https://api.storyous.com/bills/{sourceId}

Get payment bills for a sourceId (merchantId-placeId). Data are ordered by the billId by default. If modifiedSince parameter is present, results will be ordered by the _lastModifiedAt property ascending.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.storyous.com/bills/5a75b658f60a3c15009312f1-5a75b658f60a3c15009312f2?from=2016-06-19T10%3A32%3A01Z&till=2017-06-19T10%3A32%3A01Z&modifiedSince=2016-06-19T10%3A32%3A01Z&refunded=true&limit=20&lastBillId=BA2018000001&includeDeleted=true&hasLoyalty=true' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "data": [
        {
            "billId": "BA2018000001",
            "sessionCreated": "2018-08-03T14:59:46+02:00",
            "createdAt": "2018-08-03T14:59:48+02:00",
            "paidAt": "2018-08-03T14:59:47+02:00",
            "fiscalizedAt": null,
            "finalPrice": "150.4",
            "finalPriceWithoutTax": "8.26",
            "taxSummaries": {
                "15": "1.74"
            },
            "taxes": [
                {
                    "vat": "15",
                    "totalVat": "1.74",
                    "totalWithoutVat": "8.26"
                }
            ],
            "discount": "0.00",
            "rounding": "0.00",
            "tips": "0.00",
            "currencyCode": "CZK",
            "refunded": false,
            "deleted": false,
            "paymentMethod": "split",
            "payments": [
                {
                    "paymentMethod": "cash",
                    "priceWithVat": "100"
                },
                {
                    "paymentMethod": "card",
                    "priceWithVat": "50.4"
                }
            ],
            "createdBy": {
                "personId": 2187839,
                "fullName": "Person full name",
                "userName": "username"
            },
            "paidBy": {
                "personId": 2187839,
                "fullName": "Person full name",
                "userName": "username"
            },
            "personCount": 1,
            "deskId": null,
            "issuedAsVatPayer": false,
            "fiscalData": [],
            "invoiceData": [],
            "customerId": null,
            "loyaltyOfferId": null,
            "loyaltyProviderId": null,
            "keepLoyaltyBenefitsUsed": true,
            "orderProvider": {
                "code": "dj",
                "orderId": "5a75b658f60a3c15009312f1"
            },
            "_lastModifiedAt": "2018-08-03T14:59:47+02:00"
        }
    ],
    "nextPage": "/bills/5a75b658f60a3c15009312f1-5a75b658f60a3c15009312f2?lastBillId=BA2018000001"
}

Get Remaining amounts of time-based menu

Get detail of a payment bill