---
# System prepended metadata

title: Data Enquiry APIs

---

# Data Enquiry APIs
[TOC]

Introduction
===
Everyware API Platform provides various APIs for vendors or clients which joined our API Service Plan to consume, in this document, API details and sample are being listed out for reference.
:::info
:information_source: Please consult your account manager for more information about API Service Plan.
:::

There's two type of API scopes, the store based and the brand based, with the tag marked next to each of the APIs.

###### API scope: `shop` `brand`

:::info
:information_source: **Shop based API:** This API is a store-based API, which means if you are running a restaurant group for more than 10 stores, you have to call the API on a per store basis (10 API calls).
:::

:::info
:information_source: **Brand based API:** This API is a brand-based API, which means if you are running a restaurant group for more than 10 stores, you can call the API one time to get the result for all stores.
:::

APIs
===

### Sales Header Enquiry API


###### API scope: `shop` 
:::success
 **GET** /api/shop/orders
:::

| Title           | Sales Header Enquiry                                      |
| --------------- | --------------------------------------------------------- |
| **Description** | Get all sales header of the shop in specific business day |
| **URL**         | /api/shop/orders                          |
| **Method**| GET |

| Headers      | Data Type | Sample                               |
| ------------ | --------- | ------------------------------------ |
| access_token | GUID      | 15ab5f6f-4052-4b65-a65f-76fc305ea467 |
| shop_token   | GUID      | 7a864c38-7c6b-4cdc-9390-1272faa7c8e1 |

| Params | Data Type | Sample                  |
| ------ | --------- | ----------------------- |
| date   | Date      | 2020-11-24 (YYYY-MM-DD) |

#### Curl sample
``` curl=
curl --location --request GET 'https://{{domain}}/api/shop/orders?date=2020-11-23' \
--header 'access_token: 15ab5f6f-4052-4b65-a65f-76fc305ea467' \
--header 'shop_token: 7a864c38-7c6b-4cdc-9390-1272faa7c8e1' \
```

:::spoiler **Response**
``` json=
[
    {
        "txSalesHeaderId": 504,
        "accountId": 10697,
        "shopId": 3456,
        "txCode": "504",
        "txDate": "2020-11-06T00:00:00",
        "receiptNo": "504",
        "isCurrentTx": false,
        "voided": false,
        "enabled": true,
        "tableId": 446166,
        "tableCode": "E1",
        "previousTableId": null,
        "previousTableCode": null,
        "sectionId": 1672,
        "sectionName": "室內",
        "checkinDatetime": "2020-11-06T14:53:51.643",
        "checkoutDatetime": "2020-11-06T14:53:51.38",
        "checkinUserId": 27291,
        "checkinUserName": "經理",
        "checkoutUserId": 27291,
        "checkoutUserName": "經理",
        "cashierUserId": 27291,
        "cashierUserName": "經理",
        "cashierDatetime": "2020-11-06T14:53:53.697",
        "amountPaid": 176.00,
        "amountChange": 0.00,
        "amountSubtotal": 160.00,
        "amountServiceCharge": 16.00,
        "amountDiscount": 0.00,
        "amountTotal": 176.00,
        "amountRounding": 0.00,
        "txCompleted": true,
        "txChecked": true,
        "createdDate": "2020-11-06T14:53:51.643",
        "createdBy": "經理",
        "modifiedDate": "2020-11-06T14:53:51.643",
        "modifiedBy": "經理",
        "isTakeAway": false,
        "takeAwayRunningIndex": null,
        "disabledReasonId": null,
        "disabledReasonDesc": null,
        "disabledByUserId": null,
        "disabledByUserName": null,
        "disabledDateTime": null,
        "workdayPeriodDetailId": 553,
        "workdayPeriodName": "下午茶時段",
        "discountId": null,
        "discountName": null,
        "cashDrawerCode": "3456D1",
        "receiptPrintCount": 0,
        "txRevokeCount": 0,
        "serviceChargeId": 1598,
        "serviceChargeName": "10% service charge",
        "amountTips": 0.00,
        "isTimeLimited": null,
        "timeLimitedMinutes": null,
        "cusCount": null,
        "discountByUserId": null,
        "discountByUserName": null,
        "amountPointTotal": null,
        "memberPointRemain": null,
        "taxationId": null,
        "taxationName": null,
        "amountTaxation": 0.00,
        "amountMinChargeOffset": null,
        "isMinChargeOffsetWaived": null,
        "isMinChargeTx": false,
        "isMinChargePerHead": null,
        "minChargeAmount": null,
        "minChargeMemberAmount": null,
        "isPrepaidRechargeTx": null,
        "isInvoicePrintPending": false,
        "invoiceNum": null,
        "orderNum": null,
        "isDepositTx": null,
        "totalDepositAmount": null,
        "depositRemark": null,
        "isDepositOutstanding": null,
        "isReturnTx": null,
        "hasReturned": null,
        "returnedDateTime": null,
        "returnedTxSalesHeaderId": null,
        "newTxSalesHeaderIdForReturn": null,
        "apiGatewayRefId": 0,
        "apiGatewayName": null,
        "apiGatewayRefRemark": null,
        "tableRemark": null,
        "txSalesHeaderRemark": null,
        "totalPaymentMethodSurchargeAmount": 0.00,
        "isNonSalesTx": false,
        "isNoOtherLoyaltyTx": false,
        "startWorkdayPeriodDetailId": 553,
        "startWorkdayPeriodName": "下午茶時段",
        "odoOrderToken": null,
        "isOdoTx": false,
        "amountOverpayment": 0.00,
        "txStatusId": 0,
        "overridedChecklistPrinterName": null,
        "orderSourceTypeId": 1,
        "orderSourceRefId": null,
        "orderChannelId": null,
        "orderChannelCode": null,
        "orderChannelName": null,
        "apiGatewayRefCode": null,
        "apiGatewayResponseCode": null,
        "discount": null,
        "reason": null,
        "serviceCharge": null,
        "shop": null,
        "shopWorkdayPeriodDetail": null,
        "tableMaster": null,
        "tableMasterNavigation": null,
        "tableSection": null,
        "user": null,
        "user1": null,
        "user2": null,
        "userNavigation": null,
        "memberTxLog": null,
        "txSalesHeaderAddress": null,
        "txPayments": [
            {
                "txPaymentId": 493,
                "accountId": 10697,
                "shopId": 3456,
                "txSalesHeaderId": 504,
                "paymentMethodId": 1,
                "paymentMethodName": "Cash",
                "totalAmount": 176.00,
                "paidAmount": 176.00,
                "enabled": true,
                "createdDate": "2020-11-06T14:53:51.643",
                "createdBy": "經理",
                "modifiedDate": "2020-11-06T14:53:51.643",
                "modifiedBy": "經理",
                "oclNum": null,
                "oclRemainValue": null,
                "oclDeviceNum": null,
                "refNum": null,
                "remark1": null,
                "remark2": null,
                "remark3": null,
                "remark4": null,
                "remark5": null,
                "remark6": null,
                "remark7": null,
                "remark8": null,
                "remark9": null,
                "remark10": null,
                "changeAmount": 0.00,
                "cashoutAmount": 0.00,
                "tipAmount": 0.00,
                "isDepositPayment": null,
                "depositReceivedByUserId": null,
                "depositReceivedByUserName": null,
                "depositReceivedDatetime": null,
                "depositWorkdayDetailId": null,
                "depositWorkdayPeriodDetailId": null,
                "depositWorkdayPeriodName": null,
                "paymentMethodSurchargeAmount": 0.00,
                "paymentMethodSurchargeRate": null,
                "isNonSalesTxPayment": false,
                "isPreprintedCouponTxPayment": null,
                "overpaymentAmount": 0.00,
                "paymentCurrency": null,
                "paymentPathway": null,
                "paymentRemark": null,
                "changeAmountFx": null,
                "isChangeAmountFx": false,
                "isFxPayment": false,
                "paidAmountFx": null,
                "paymentFxRate": null,
                "totalAmountFx": null,
                "isOdoTx": null,
                "isOnlinePayment": null,
                "paymentMethod": {
                    "paymentMethodId": 1,
                    "paymentMethodCode": "CASH",
                    "paymentMethodName": "Cash",
                    "displayIndex": 0,
                    "enabled": true,
                    "createdDate": "2015-01-26T14:12:25.133",
                    "createdBy": "admin",
                    "modifiedDate": "2020-01-20T03:47:40.977",
                    "modifiedBy": "everyware10697",
                    "accountId": 10697,
                    "isDrawerKick": true,
                    "linkedGateway": null,
                    "isSystemUse": false,
                    "isTipEnabled": false,
                    "paymentMethodSurchargeRate": null,
                    "isNonSalesPayment": false,
                    "isCashPayment": false,
                    "isFixedAmount": false,
                    "isOverPaymentEnabled": false,
                    "includedCategoryIdList": null,
                    "excludedCategoryIdList": null,
                    "includedItemIdList": null,
                    "excludedItemIdList": null,
                    "maxUseCount": null,
                    "fixedAmount": null,
                    "isFxPayment": false,
                    "isPaymentChangeInFx": null,
                    "isSpecificItemExist": null,
                    "isSpecificCategoryExist": null,
                    "txChargesRate": null,
                    "isAutoRemarkEnabled": null
                },
                "shop": null
            }
        ],
        "txReceiptReprintLog": [],
        "txSalesDeliveryDetail": [],
        "txSalesDetailTxSalesHeader": [],
        "txSalesDetails": [],
        "txSalesHeaderLog": [],
        "txSalesHeaderRevokeLog": [],
        "txSalesDeliveryService": []
    },
    {
        "txSalesHeaderId": 505,
        "accountId": 10697,
        "shopId": 3456,
        "txCode": "505",
        "txDate": "2020-11-06T00:00:00",
        "receiptNo": "505",
        "isCurrentTx": false,
        "voided": false,
        "enabled": true,
        "tableId": 446172,
        "tableCode": "E2",
        "previousTableId": null,
        "previousTableCode": null,
        "sectionId": 1672,
        "sectionName": "室內",
        "checkinDatetime": "2020-11-06T15:02:54.42",
        "checkoutDatetime": "2020-11-06T15:02:54.35",
        "checkinUserId": 27291,
        "checkinUserName": "經理",
        "checkoutUserId": 27291,
        "checkoutUserName": "經理",
        "cashierUserId": 27291,
        "cashierUserName": "經理",
        "cashierDatetime": "2020-11-06T15:02:55.373",
        "amountPaid": 62.00,
        "amountChange": 0.00,
        "amountSubtotal": 56.00,
        "amountServiceCharge": 5.60,
        "amountDiscount": 0.00,
        "amountTotal": 62.00,
        "amountRounding": 0.40,
        "txCompleted": true,
        "txChecked": true,
        "createdDate": "2020-11-06T15:02:54.42",
        "createdBy": "經理",
        "modifiedDate": "2020-11-06T15:02:54.42",
        "modifiedBy": "經理",
        "isTakeAway": false,
        "takeAwayRunningIndex": null,
        "disabledReasonId": null,
        "disabledReasonDesc": null,
        "disabledByUserId": null,
        "disabledByUserName": null,
        "disabledDateTime": null,
        "workdayPeriodDetailId": 553,
        "workdayPeriodName": "下午茶時段",
        "discountId": null,
        "discountName": null,
        "cashDrawerCode": "3456D1",
        "receiptPrintCount": 0,
        "txRevokeCount": 0,
        "serviceChargeId": 1598,
        "serviceChargeName": "10% service charge",
        "amountTips": 0.00,
        "isTimeLimited": null,
        "timeLimitedMinutes": null,
        "cusCount": null,
        "discountByUserId": null,
        "discountByUserName": null,
        "amountPointTotal": null,
        "memberPointRemain": null,
        "taxationId": null,
        "taxationName": null,
        "amountTaxation": 0.00,
        "amountMinChargeOffset": null,
        "isMinChargeOffsetWaived": null,
        "isMinChargeTx": false,
        "isMinChargePerHead": null,
        "minChargeAmount": null,
        "minChargeMemberAmount": null,
        "isPrepaidRechargeTx": null,
        "isInvoicePrintPending": false,
        "invoiceNum": null,
        "orderNum": null,
        "isDepositTx": null,
        "totalDepositAmount": null,
        "depositRemark": null,
        "isDepositOutstanding": null,
        "isReturnTx": null,
        "hasReturned": null,
        "returnedDateTime": null,
        "returnedTxSalesHeaderId": null,
        "newTxSalesHeaderIdForReturn": null,
        "apiGatewayRefId": 0,
        "apiGatewayName": null,
        "apiGatewayRefRemark": null,
        "tableRemark": null,
        "txSalesHeaderRemark": null,
        "totalPaymentMethodSurchargeAmount": 0.00,
        "isNonSalesTx": false,
        "isNoOtherLoyaltyTx": false,
        "startWorkdayPeriodDetailId": 553,
        "startWorkdayPeriodName": "下午茶時段",
        "odoOrderToken": null,
        "isOdoTx": false,
        "amountOverpayment": 0.00,
        "txStatusId": 0,
        "overridedChecklistPrinterName": null,
        "orderSourceTypeId": 1,
        "orderSourceRefId": null,
        "orderChannelId": null,
        "orderChannelCode": null,
        "orderChannelName": null,
        "apiGatewayRefCode": null,
        "apiGatewayResponseCode": null,
        "discount": null,
        "reason": null,
        "serviceCharge": null,
        "shop": null,
        "shopWorkdayPeriodDetail": null,
        "tableMaster": null,
        "tableMasterNavigation": null,
        "tableSection": null,
        "user": null,
        "user1": null,
        "user2": null,
        "userNavigation": null,
        "memberTxLog": null,
        "txSalesHeaderAddress": null,
        "txPayments": [
            {
                "txPaymentId": 494,
                "accountId": 10697,
                "shopId": 3456,
                "txSalesHeaderId": 505,
                "paymentMethodId": 1,
                "paymentMethodName": "Cash",
                "totalAmount": 62.00,
                "paidAmount": 62.00,
                "enabled": true,
                "createdDate": "2020-11-06T15:02:54.42",
                "createdBy": "經理",
                "modifiedDate": "2020-11-06T15:02:54.42",
                "modifiedBy": "經理",
                "oclNum": null,
                "oclRemainValue": null,
                "oclDeviceNum": null,
                "refNum": null,
                "remark1": null,
                "remark2": null,
                "remark3": null,
                "remark4": null,
                "remark5": null,
                "remark6": null,
                "remark7": null,
                "remark8": null,
                "remark9": null,
                "remark10": null,
                "changeAmount": 0.00,
                "cashoutAmount": 0.00,
                "tipAmount": 0.00,
                "isDepositPayment": null,
                "depositReceivedByUserId": null,
                "depositReceivedByUserName": null,
                "depositReceivedDatetime": null,
                "depositWorkdayDetailId": null,
                "depositWorkdayPeriodDetailId": null,
                "depositWorkdayPeriodName": null,
                "paymentMethodSurchargeAmount": 0.00,
                "paymentMethodSurchargeRate": null,
                "isNonSalesTxPayment": false,
                "isPreprintedCouponTxPayment": null,
                "overpaymentAmount": 0.00,
                "paymentCurrency": null,
                "paymentPathway": null,
                "paymentRemark": null,
                "changeAmountFx": null,
                "isChangeAmountFx": false,
                "isFxPayment": false,
                "paidAmountFx": null,
                "paymentFxRate": null,
                "totalAmountFx": null,
                "isOdoTx": null,
                "isOnlinePayment": null,
                "paymentMethod": {
                    "paymentMethodId": 1,
                    "paymentMethodCode": "CASH",
                    "paymentMethodName": "Cash",
                    "displayIndex": 0,
                    "enabled": true,
                    "createdDate": "2015-01-26T14:12:25.133",
                    "createdBy": "admin",
                    "modifiedDate": "2020-01-20T03:47:40.977",
                    "modifiedBy": "everyware10697",
                    "accountId": 10697,
                    "isDrawerKick": true,
                    "linkedGateway": null,
                    "isSystemUse": false,
                    "isTipEnabled": false,
                    "paymentMethodSurchargeRate": null,
                    "isNonSalesPayment": false,
                    "isCashPayment": false,
                    "isFixedAmount": false,
                    "isOverPaymentEnabled": false,
                    "includedCategoryIdList": null,
                    "excludedCategoryIdList": null,
                    "includedItemIdList": null,
                    "excludedItemIdList": null,
                    "maxUseCount": null,
                    "fixedAmount": null,
                    "isFxPayment": false,
                    "isPaymentChangeInFx": null,
                    "isSpecificItemExist": null,
                    "isSpecificCategoryExist": null,
                    "txChargesRate": null,
                    "isAutoRemarkEnabled": null
                },
                "shop": null
            }
        ],
        "txReceiptReprintLog": [],
        "txSalesDeliveryDetail": [],
        "txSalesDetailTxSalesHeader": [],
        "txSalesDetails": [],
        "txSalesHeaderLog": [],
        "txSalesHeaderRevokeLog": [],
        "txSalesDeliveryService": []
    }
]
```

:::
---
### Sales Detail Enquiry API

###### API scope: `shop` 

:::success
**GET** /api/shop/order
:::

|Title | Sales Detail Enquiry |
| -------- | -------- |
| **Description**     | Get the specific sales details     |
|**URL**|/api/shop/order|
|**Method**| GET|

|Headers| Data Type| Sample |
| -------- | -------- |-------- |
|access_token | GUID |15ab5f6f-4052-4b65-a65f-76fc305ea467 |
|shop_token | GUID |7a864c38-7c6b-4cdc-9390-1272faa7c8e1 |

|Params| Data Type| Sample |
| -------- | -------- |-------- |
|txsalesheaderid | int |504|

#### Curl sample
```curl=
curl --location --request GET 'https://{{domain}}/api/shop/order?txsalesheaderid=504' \
--header 'access_token: 15ab5f6f-4052-4b65-a65f-76fc305ea467' \
--header 'shop_token: 7a864c38-7c6b-4cdc-9390-1272faa7c8e1' \
```
:::spoiler ***Response***
``` json=
{
    "accountId": 10697,
    "txSalesHeaderId": 504,
    "shopId": 3456,
    "txCode": "504",
    "txDate": "2020-11-06T00:00:00",
    "receiptNo": "504",
    "isCurrentTx": false,
    "voided": false,
    "enabled": true,
    "tableId": 446166,
    "tableCode": "E1",
    "previousTableId": null,
    "previousTableCode": null,
    "sectionId": 1672,
    "sectionName": "室內",
    "cashierUserId": 27291,
    "cashierUserName": "經理",
    "amountPaid": 176.00,
    "amountChange": 0.00,
    "amountSubtotal": 160.00,
    "amountTotal": 176.00,
    "amountRounding": 0.00,
    "amountDiscount": 0.00,
    "amountServiceCharge": 16.00,
    "amountTips": 0.00,
    "txCompleted": true,
    "txChecked": true,
    "checkinUserId": 27291,
    "checkinUserName": "經理",
    "checkoutUserId": 27291,
    "checkoutUserName": "經理",
    "checkinDatetime": "2020-11-06T14:53:51.643",
    "checkoutDatetime": "2020-11-06T14:53:51.38",
    "cashierDatetime": "2020-11-06T14:53:53.697",
    "isTakeAway": false,
    "modifiedDate": "2020-11-06T14:53:51.643",
    "phoneNum": null,
    "cusName": null,
    "line1": null,
    "remark1": null,
    "remark2": null,
    "remark3": null,
    "remark4": null,
    "remark5": null,
    "takeAwayRunningIndex": 0,
    "disabledReasonId": null,
    "disabledReasonDesc": null,
    "disabledByUserId": null,
    "disabledByUserName": null,
    "disabledDateTime": null,
    "discountId": null,
    "discountName": null,
    "serviceChargeId": 1598,
    "serviceChargeName": "10% service charge",
    "cashDrawerCode": "3456D1",
    "workdayPeriodDetailId": 553,
    "workdayPeriodName": "下午茶時段",
    "isMemberTx": false,
    "memberTypeName": null,
    "memberDeductAmount": 0.0,
    "txPaymentDtoList": [
        {
            "txPaymentId": 493,
            "accountId": 10697,
            "shopId": 3456,
            "paymentMethodCode": null,
            "paymentMethodName": null,
            "txSalesHeaderId": 504,
            "paymentMethodId": 1,
            "totalAmount": 176.00,
            "paidAmount": 176.00,
            "oclNum": null,
            "oclRemainValue": null,
            "oclDeviceNum": null,
            "refNum": null,
            "remark1": null,
            "remark2": null,
            "remark3": null,
            "remark4": null,
            "remark5": null,
            "remark6": null,
            "remark7": null,
            "remark8": null,
            "remark9": null,
            "remark10": null,
            "changeAmount": 0.00,
            "cashoutAmount": 0.00,
            "tipAmount": 0.00,
            "linkedGateway": null,
            "enabled": true,
            "isDepositPayment": null,
            "depositReceivedByUserId": null,
            "depositReceivedByUserName": null,
            "depositReceivedDatetime": null,
            "depositWorkdayDetailId": null,
            "depositWorkdayPeriodDetailId": null,
            "depositWorkdayPeriodName": null,
            "cashierUserId": null,
            "cashierUserName": null,
            "paymentMethodDisplayIndex": 0,
            "receivedWorkdayPeriodDetailId": 0,
            "receivedWorkdayPeriodName": null,
            "receivedDateTime": "0001-01-01T00:00:00",
            "txCode": null,
            "paymentMethodSurchargeAmount": 0.00,
            "paymentMethodSurchargeRate": null,
            "cashDrawerCode": null,
            "cashDrawerName": null,
            "isNonSalesTxPayment": false,
            "isCashPayment": false,
            "overpaymentAmount": 0.00,
            "isPreprintedCouponTxPayment": null,
            "paymentCurrency": null,
            "paymentPathway": null,
            "paymentRemark": null,
            "totalAmountFx": null,
            "paidAmountFx": null,
            "changeAmountFx": null,
            "isFxPayment": false,
            "isChangeAmountFx": false,
            "paymentFxRate": null,
            "txChargesRate": null,
            "txTotalCharges": null,
            "txTipCharges": null,
            "txNetTotal": null,
            "txNetTip": null,
            "isOdoTx": null,
            "isOnlinePayment": null
        }
    ],
    "cusCount": null,
    "discountByUserName": null,
    "discountByUserId": null,
    "txSalesDetailDtoList": [
        {
            "txSalesDetailId": 2166,
            "txSalesHeaderId": 504,
            "previousTxSalesHeaderId": null,
            "seqNo": 1,
            "displayIndexString": null,
            "isSubItem": false,
            "parentTxSalesDetailId": null,
            "subItemLevel": 0,
            "itemPath": "",
            "itemSetRunningIndex": 1,
            "itemOrderRunningIndex": 1,
            "orderDateTime": "2020-11-06T14:53:22.157",
            "orderUserId": 27291,
            "orderUserName": "經理",
            "itemId": 543913,
            "categoryId": 49072,
            "categoryName": "下午茶",
            "itemCode": "T3",
            "itemName": "T3. 沙嗲金菇牛肉炒河",
            "itemNameAlt": "沙嗲金菇牛肉炒河",
            "itemNameAlt2": "T3.Golden Mushroom & Beef in Satay Sauce with Fried Rice Noodle",
            "itemNameAlt3": null,
            "itemNameAlt4": null,
            "qty": 1.000,
            "price": 48.00,
            "point": 0.00,
            "amount": 48.00,
            "isModifier": false,
            "enabled": true,
            "voided": false,
            "createdDate": "2020-11-06T14:53:22.15",
            "createdBy": "經理",
            "modifiedDate": "2020-11-06T14:53:22.157",
            "modifiedBy": "經理",
            "printedKitchen": true,
            "printedKitchenDateTime": "2020-11-06T14:53:57.653",
            "disabledReasonId": null,
            "disabledReasonDesc": null,
            "disabledByUserId": null,
            "disabledByUserName": null,
            "disabledDateTime": null,
            "isPromoComboItem": false,
            "isLocalChangedItem": false,
            "localPrinterName": null,
            "localPrinterName2": null,
            "localPrinterName3": null,
            "localPrinterName4": null,
            "localPrinterName5": null,
            "isPriceShow": false,
            "isItemShow": false,
            "isItemShowInKitchenChecklist": true,
            "isLimitedItem": false,
            "isModifierConcatToParent": false,
            "isNonDiscountItem": false,
            "isNonServiceChargeItem": false,
            "isPriceInPercentage": false,
            "departmentId": 1,
            "departmentName": "廚房",
            "deptRunningIndex": 0,
            "isPointPaidItem": false,
            "amountPoint": 0.00,
            "isNoPointEarnItem": false,
            "isNonTaxableItem": false,
            "isItemOnHold": null,
            "itemOnHoldDateTime": null,
            "itemOnHoldUserId": null,
            "itemOnHoldUserName": null,
            "isItemFired": null,
            "isItemFiredSuccessfully": false,
            "itemFiredDateTime": null,
            "itemFiredUserId": null,
            "itemFiredUserName": null,
            "takeawaySurcharge": 2.00,
            "isPrepaidRechargeItem": false,
            "apiGatewayName": null,
            "apiGatewayRefId": null,
            "apiGatewayRefRemark": null,
            "amountItemDiscount": 0.00,
            "amountItemTaxation": 0.00,
            "amountItemSurcharge": 4.80,
            "orderBatchTag": null,
            "linkedItemSetRunningIndex": null,
            "linkedItemOrderRunningIndex": null,
            "linkedItemId": null,
            "departmentRevenueAmount": null,
            "promoHeaderId": null,
            "promoDeductAmount": null,
            "promoQty": null,
            "promoRevenueOffset": null,
            "promoCode": null,
            "promoName": null,
            "isFollowSet": false,
            "isFollowSetDynamic": false,
            "isFollowSetStandard": false,
            "modifierGroupHeaderId": null,
            "hasWebImage": false,
            "webImageLink": null,
            "isTxOnHold": null,
            "subDepartmentId": null,
            "subDepartmentName": null,
            "groupHeaderId": null,
            "groupBatchName": null,
            "isVariance": null,
            "itemQty": null,
            "itemCount": null
        },
        {
            "txSalesDetailId": 2167,
            "txSalesHeaderId": 504,
            "previousTxSalesHeaderId": null,
            "seqNo": 2,
            "displayIndexString": null,
            "isSubItem": false,
            "parentTxSalesDetailId": null,
            "subItemLevel": 0,
            "itemPath": "",
            "itemSetRunningIndex": 2,
            "itemOrderRunningIndex": 2,
            "orderDateTime": "2020-11-06T14:53:34.953",
            "orderUserId": 27291,
            "orderUserName": "經理",
            "itemId": 543917,
            "categoryId": 49072,
            "categoryName": "下午茶",
            "itemCode": "T5",
            "itemName": "T5. 叉燒蔥花炒蛋飯",
            "itemNameAlt": "叉燒蔥花炒蛋飯",
            "itemNameAlt2": "T5. Barbecued Pork & Spring Onion Fried Egg with Rice",
            "itemNameAlt3": null,
            "itemNameAlt4": null,
            "qty": 1.000,
            "price": 48.00,
            "point": 0.00,
            "amount": 48.00,
            "isModifier": false,
            "enabled": true,
            "voided": false,
            "createdDate": "2020-11-06T14:53:34.953",
            "createdBy": "經理",
            "modifiedDate": "2020-11-06T14:53:34.953",
            "modifiedBy": "經理",
            "printedKitchen": true,
            "printedKitchenDateTime": "2020-11-06T14:53:57.653",
            "disabledReasonId": null,
            "disabledReasonDesc": null,
            "disabledByUserId": null,
            "disabledByUserName": null,
            "disabledDateTime": null,
            "isPromoComboItem": false,
            "isLocalChangedItem": false,
            "localPrinterName": null,
            "localPrinterName2": null,
            "localPrinterName3": null,
            "localPrinterName4": null,
            "localPrinterName5": null,
            "isPriceShow": false,
            "isItemShow": false,
            "isItemShowInKitchenChecklist": true,
            "isLimitedItem": false,
            "isModifierConcatToParent": false,
            "isNonDiscountItem": false,
            "isNonServiceChargeItem": false,
            "isPriceInPercentage": false,
            "departmentId": 1,
            "departmentName": "廚房",
            "deptRunningIndex": 0,
            "isPointPaidItem": false,
            "amountPoint": 0.00,
            "isNoPointEarnItem": false,
            "isNonTaxableItem": false,
            "isItemOnHold": null,
            "itemOnHoldDateTime": null,
            "itemOnHoldUserId": null,
            "itemOnHoldUserName": null,
            "isItemFired": null,
            "isItemFiredSuccessfully": false,
            "itemFiredDateTime": null,
            "itemFiredUserId": null,
            "itemFiredUserName": null,
            "takeawaySurcharge": 2.00,
            "isPrepaidRechargeItem": false,
            "apiGatewayName": null,
            "apiGatewayRefId": null,
            "apiGatewayRefRemark": null,
            "amountItemDiscount": 0.00,
            "amountItemTaxation": 0.00,
            "amountItemSurcharge": 4.80,
            "orderBatchTag": null,
            "linkedItemSetRunningIndex": null,
            "linkedItemOrderRunningIndex": null,
            "linkedItemId": null,
            "departmentRevenueAmount": null,
            "promoHeaderId": null,
            "promoDeductAmount": null,
            "promoQty": null,
            "promoRevenueOffset": null,
            "promoCode": null,
            "promoName": null,
            "isFollowSet": false,
            "isFollowSetDynamic": false,
            "isFollowSetStandard": false,
            "modifierGroupHeaderId": null,
            "hasWebImage": false,
            "webImageLink": null,
            "isTxOnHold": null,
            "subDepartmentId": null,
            "subDepartmentName": null,
            "groupHeaderId": null,
            "groupBatchName": null,
            "isVariance": null,
            "itemQty": null,
            "itemCount": null
        },
        {
            "txSalesDetailId": 2168,
            "txSalesHeaderId": 504,
            "previousTxSalesHeaderId": null,
            "seqNo": 3,
            "displayIndexString": null,
            "isSubItem": false,
            "parentTxSalesDetailId": null,
            "subItemLevel": 0,
            "itemPath": "",
            "itemSetRunningIndex": 3,
            "itemOrderRunningIndex": 3,
            "orderDateTime": "2020-11-06T14:53:38.507",
            "orderUserId": 27291,
            "orderUserName": "經理",
            "itemId": 543933,
            "categoryId": 49072,
            "categoryName": "下午茶",
            "itemCode": "T10",
            "itemName": "T10. 懷舊西多士",
            "itemNameAlt": "T10. 懷舊西多士",
            "itemNameAlt2": "T10. French Toast",
            "itemNameAlt3": null,
            "itemNameAlt4": null,
            "qty": 1.000,
            "price": 32.00,
            "point": 0.00,
            "amount": 32.00,
            "isModifier": false,
            "enabled": true,
            "voided": false,
            "createdDate": "2020-11-06T14:53:38.507",
            "createdBy": "經理",
            "modifiedDate": "2020-11-06T14:53:38.507",
            "modifiedBy": "經理",
            "printedKitchen": true,
            "printedKitchenDateTime": "2020-11-06T14:53:57.653",
            "disabledReasonId": null,
            "disabledReasonDesc": null,
            "disabledByUserId": null,
            "disabledByUserName": null,
            "disabledDateTime": null,
            "isPromoComboItem": false,
            "isLocalChangedItem": false,
            "localPrinterName": null,
            "localPrinterName2": null,
            "localPrinterName3": null,
            "localPrinterName4": null,
            "localPrinterName5": null,
            "isPriceShow": false,
            "isItemShow": false,
            "isItemShowInKitchenChecklist": true,
            "isLimitedItem": false,
            "isModifierConcatToParent": false,
            "isNonDiscountItem": false,
            "isNonServiceChargeItem": false,
            "isPriceInPercentage": false,
            "departmentId": 1,
            "departmentName": "廚房",
            "deptRunningIndex": 0,
            "isPointPaidItem": false,
            "amountPoint": 0.00,
            "isNoPointEarnItem": false,
            "isNonTaxableItem": false,
            "isItemOnHold": null,
            "itemOnHoldDateTime": null,
            "itemOnHoldUserId": null,
            "itemOnHoldUserName": null,
            "isItemFired": null,
            "isItemFiredSuccessfully": false,
            "itemFiredDateTime": null,
            "itemFiredUserId": null,
            "itemFiredUserName": null,
            "takeawaySurcharge": 2.00,
            "isPrepaidRechargeItem": false,
            "apiGatewayName": null,
            "apiGatewayRefId": null,
            "apiGatewayRefRemark": null,
            "amountItemDiscount": 0.00,
            "amountItemTaxation": 0.00,
            "amountItemSurcharge": 3.20,
            "orderBatchTag": null,
            "linkedItemSetRunningIndex": null,
            "linkedItemOrderRunningIndex": null,
            "linkedItemId": null,
            "departmentRevenueAmount": null,
            "promoHeaderId": null,
            "promoDeductAmount": null,
            "promoQty": null,
            "promoRevenueOffset": null,
            "promoCode": null,
            "promoName": null,
            "isFollowSet": false,
            "isFollowSetDynamic": false,
            "isFollowSetStandard": false,
            "modifierGroupHeaderId": null,
            "hasWebImage": false,
            "webImageLink": null,
            "isTxOnHold": null,
            "subDepartmentId": null,
            "subDepartmentName": null,
            "groupHeaderId": null,
            "groupBatchName": null,
            "isVariance": null,
            "itemQty": null,
            "itemCount": null
        },
        {
            "txSalesDetailId": 2169,
            "txSalesHeaderId": 504,
            "previousTxSalesHeaderId": null,
            "seqNo": 4,
            "displayIndexString": null,
            "isSubItem": false,
            "parentTxSalesDetailId": null,
            "subItemLevel": 0,
            "itemPath": "",
            "itemSetRunningIndex": 4,
            "itemOrderRunningIndex": 4,
            "orderDateTime": "2020-11-06T14:53:40.85",
            "orderUserId": 27291,
            "orderUserName": "經理",
            "itemId": 543933,
            "categoryId": 49072,
            "categoryName": "下午茶",
            "itemCode": "T10",
            "itemName": "T10. 懷舊西多士",
            "itemNameAlt": "T10. 懷舊西多士",
            "itemNameAlt2": "T10. French Toast",
            "itemNameAlt3": null,
            "itemNameAlt4": null,
            "qty": 1.000,
            "price": 32.00,
            "point": 0.00,
            "amount": 32.00,
            "isModifier": false,
            "enabled": true,
            "voided": false,
            "createdDate": "2020-11-06T14:53:40.85",
            "createdBy": "經理",
            "modifiedDate": "2020-11-06T14:53:40.85",
            "modifiedBy": "經理",
            "printedKitchen": true,
            "printedKitchenDateTime": "2020-11-06T14:53:57.653",
            "disabledReasonId": null,
            "disabledReasonDesc": null,
            "disabledByUserId": null,
            "disabledByUserName": null,
            "disabledDateTime": null,
            "isPromoComboItem": false,
            "isLocalChangedItem": false,
            "localPrinterName": null,
            "localPrinterName2": null,
            "localPrinterName3": null,
            "localPrinterName4": null,
            "localPrinterName5": null,
            "isPriceShow": false,
            "isItemShow": false,
            "isItemShowInKitchenChecklist": true,
            "isLimitedItem": false,
            "isModifierConcatToParent": false,
            "isNonDiscountItem": false,
            "isNonServiceChargeItem": false,
            "isPriceInPercentage": false,
            "departmentId": 1,
            "departmentName": "廚房",
            "deptRunningIndex": 0,
            "isPointPaidItem": false,
            "amountPoint": 0.00,
            "isNoPointEarnItem": false,
            "isNonTaxableItem": false,
            "isItemOnHold": null,
            "itemOnHoldDateTime": null,
            "itemOnHoldUserId": null,
            "itemOnHoldUserName": null,
            "isItemFired": null,
            "isItemFiredSuccessfully": false,
            "itemFiredDateTime": null,
            "itemFiredUserId": null,
            "itemFiredUserName": null,
            "takeawaySurcharge": 2.00,
            "isPrepaidRechargeItem": false,
            "apiGatewayName": null,
            "apiGatewayRefId": null,
            "apiGatewayRefRemark": null,
            "amountItemDiscount": 0.00,
            "amountItemTaxation": 0.00,
            "amountItemSurcharge": 3.20,
            "orderBatchTag": null,
            "linkedItemSetRunningIndex": null,
            "linkedItemOrderRunningIndex": null,
            "linkedItemId": null,
            "departmentRevenueAmount": null,
            "promoHeaderId": null,
            "promoDeductAmount": null,
            "promoQty": null,
            "promoRevenueOffset": null,
            "promoCode": null,
            "promoName": null,
            "isFollowSet": false,
            "isFollowSetDynamic": false,
            "isFollowSetStandard": false,
            "modifierGroupHeaderId": null,
            "hasWebImage": false,
            "webImageLink": null,
            "isTxOnHold": null,
            "subDepartmentId": null,
            "subDepartmentName": null,
            "groupHeaderId": null,
            "groupBatchName": null,
            "isVariance": null,
            "itemQty": null,
            "itemCount": null
        }
    ],
    "taxationId": null,
    "taxationName": null,
    "amountTaxation": 0.00,
    "isMinChargeTx": false,
    "amountMinChargeOffset": null,
    "isMinChargeOffsetWaived": null,
    "minChargeAmount": null,
    "isMinChargePerHead": null,
    "minChargeMemberAmount": null,
    "invoiceNum": null,
    "orderNum": null,
    "isDepositTx": null,
    "totalDepositAmount": null,
    "isDepositOutstanding": null,
    "depositRemark": null,
    "isReturnTx": null,
    "hasReturned": null,
    "returnedDateTime": null,
    "returnedTxSalesHeaderId": null,
    "newTxSalesHeaderIdForReturn": null,
    "isPrepaidRechargeTx": null,
    "tableRemark": null,
    "txSalesHeaderRemark": null,
    "apiGatewayRefId": 0,
    "apiGatewayName": null,
    "apiGatewayRefRemark": null,
    "totalPaymentMethodSurchargeAmount": 0.00,
    "isNonSalesTx": false,
    "isOdoTx": false,
    "odoOrderToken": null,
    "amountOverpayment": 0.00,
    "orderSourceTypeId": 1,
    "orderSourceRefId": null,
    "orderChannelId": null,
    "orderChannelCode": null,
    "orderChannelName": null,
    "discount": null,
    "memberDetail": null,
    "serviceCharge": null,
    "table": null,
    "memberTxLog": null,
    "originUrl": null,
    "originOdoOrderToken": null,
    "paymentMethodId": 0,
    "paymentMethodName": null,
    "paymentMethodCode": null,
    "paymentRemark": null,
    "deliveryServiceEnabled": false,
    "deliveryInfo": null,
    "deliveryDetail": null,
    "invoiceHeaders": null,
    "invoiceNumber": null,
    "invoiceRemark": null,
    "buyerIdentifier": null,
    "carrier": null,
    "npoban": null,
    "mainRemark": null,
    "noInvoice": false
}
```
:::

---

### Line Items Enquiry API
###### API scope: `brand` 
:::success 
**GET** /api/menu/brand/lineitem
:::

|Title | Line Items Enquiry |
| -------- | -------- |
| **Description**     | Get the line item details     |
|**URL**|/api/menu/brand/lineitem|
|**Method**| GET|

|Headers| Data Type| Sample |
| -------- | -------- |-------- |
|access_token | GUID |15ab5f6f-4052-4b65-a65f-76fc305ea467 |

| Params   | Data Type         | Sample                                       |
| -------- | ----------------- | -------------------------------------------- |
| date     | Date              | 2021-11-23 (YYYY-MM-DD)                      |
| shopCode | string `optional`|  null  `all stores`|
||| PMQ `single store` |
||| PMQ,FNK `multiple stores` |

#### Curl sample
``` curl=
curl --location --request GET 'https://{{domain}}/api/menu/brand/lineitem?date=2022-05-03&shopCode=PMQ,FNK' \
--header 'access_token: c95a326d-4ea3-4568-bb33-76fc305ea467' \
```

:::spoiler ***Response***
``` json=
[
    {
        "shopCode": "FTW",
        "cashierDateTime": "3/5/2022 07:25",
        "txSalesHeaderId": 121073,
        "departmentName": "Self Production",
        "categoryName": "御結",
        "itemName": "[御結]吞拿魚沙律",
        "itemCode": "00110020",
        "itemNameAlt4": "3OMU000002",
        "mealPeriod": 7,
        "price": 17.00,
        "qty": 1.00,
        "amount": 17.00,
        "promoDeductAmount": 0.00,
        "promoName": null,
        "discountPercentage": 0.0,
        "itemPercentOfRevenue": 1.0,
        "totalCollected": 17.00
    },
    {
        "shopCode": "FTW",
        "cashierDateTime": "3/5/2022 07:25",
        "txSalesHeaderId": 121073,
        "departmentName": "External Procured",
        "categoryName": "飲品",
        "itemName": "飛雪礦泉水",
        "itemCode": "4890008150519",
        "itemNameAlt4": "4DRK000025",
        "mealPeriod": 7,
        "price": 8.00,
        "qty": 1.00,
        "amount": 8.00,
        "promoDeductAmount": 0.00,
        "promoName": null,
        "discountPercentage": 0.0,
        "itemPercentOfRevenue": 1.0,
        "totalCollected": 8.00
    },
    {
        "shopCode": "FTW",
        "cashierDateTime": "3/5/2022 07:27",
        "txSalesHeaderId": 121074,
        "departmentName": "Self Production",
        "categoryName": "御結",
        "itemName": "[御結]濃香蛋汁牛壽喜燒",
        "itemCode": "00111621",
        "itemNameAlt4": "3OMU000219",
        "mealPeriod": 7,
        "price": 21.00,
        "qty": 1.00,
        "amount": 21.00,
        "promoDeductAmount": -5.00,
        "promoName": "Breakfast Set A (Old) #2",
        "discountPercentage": 0.2380952380952380952380952381,
        "itemPercentOfRevenue": 0.7619047619047619047619047619,
        "totalCollected": 16.00
    },
    {
        "shopCode": "FTW",
        "cashierDateTime": "3/5/2022 07:27",
        "txSalesHeaderId": 121074,
        "departmentName": "Self Production",
        "categoryName": "御結",
        "itemName": "[御結]金平炒牛蒡",
        "itemCode": "00110068",
        "itemNameAlt4": "3OMU000006",
        "mealPeriod": 7,
        "price": 17.00,
        "qty": 1.00,
        "amount": 17.00,
        "promoDeductAmount": -3.00,
        "promoName": "Breakfast Set (New) B #1",
        "discountPercentage": 0.1764705882352941176470588235,
        "itemPercentOfRevenue": 0.8235294117647058823529411765,
        "totalCollected": 14.00
    }
]
```
:::

---
### Payment Details Enquiry API
###### API scope: `brand` 
:::success
**GET** /api/menu/brand/payment
:::

|Title | Payment Details Enquiry |
| -------- | -------- |
| **Description**     | Get the payment details     |
|**URL**|/api/menu/brand/payment|
|**Method**| GET|

|Headers| Data Type| Sample |
| -------- | -------- |-------- |
|access_token | GUID |15ab5f6f-4052-4b65-a65f-76fc305ea467 |

| Params   | Data Type         | Sample                                       |
| -------- | ----------------- | -------------------------------------------- |
| date     | Date              | 2021-11-23 (YYYY-MM-DD)                      |
| shopCode | string `optional`|  null  `all stores`|
||| PMQ `single store` |
||| PMQ,FNK `multiple stores` |

#### Curl sample
``` curl=
curl --location --request GET 'https://{{domain}}/api/menu/brand/payment?date=2022-05-03&shopCode=PMQ' \
--header 'access_token: c95a326d-4ea3-4568-bb33-76fc305ea467' \
```

:::spoiler ***Response***
``` json=
[
    {
        "shopCode": "PSR",
        "createdDateTime": "3/5/2022 07:29",
        "txSalesHeaderId": 48707,
        "paymentMethodName": "八達通",
        "createdBy": "Staff",
        "oclNum": "67620306",
        "oclDeviceNum": "53427C",
        "cashDrawerCode": "4810D1",
        "totalAmount": 30.00
    },
    {
        "shopCode": "PSR",
        "createdDateTime": "3/5/2022 07:30",
        "txSalesHeaderId": 48708,
        "paymentMethodName": "八達通",
        "createdBy": "Staff",
        "oclNum": "68750995",
        "oclDeviceNum": "53427C",
        "cashDrawerCode": "4810D1",
        "totalAmount": 28.00
    },
    {
        "shopCode": "PSR",
        "createdDateTime": "3/5/2022 07:30",
        "txSalesHeaderId": 48709,
        "paymentMethodName": "八達通",
        "createdBy": "Staff",
        "oclNum": "78613930",
        "oclDeviceNum": "53427C",
        "cashDrawerCode": "4810D1",
        "totalAmount": 33.00
    },
    {
        "shopCode": "PSR",
        "createdDateTime": "3/5/2022 07:30",
        "txSalesHeaderId": 48710,
        "paymentMethodName": "八達通",
        "createdBy": "Staff",
        "oclNum": "75565782",
        "oclDeviceNum": "53427C",
        "cashDrawerCode": "4810D1",
        "totalAmount": 52.00
    },
    {
        "shopCode": "PSR",
        "createdDateTime": "3/5/2022 07:31",
        "txSalesHeaderId": 48711,
        "paymentMethodName": "Cash",
        "createdBy": "Staff",
        "oclNum": "",
        "oclDeviceNum": "",
        "cashDrawerCode": "4810D1",
        "totalAmount": 17.00
    }
]
```
:::


