Transaction Headers
Get the all the restaurant transaction header data for a specific business day
Endpoint URL
GET
/api/Sales/transactionheader Authentication
This endpoint requires the X-Api-Key header for authentication.
Example: X-Api-Key 12345abcdef
Parameters
| Name | Type | Position | Description |
|---|---|---|---|
storeNumber |
integer (int32) | query | Restaurant number |
countryCode |
string | query | ISO Country code |
businessDay |
string (date) | query | Date with the “yyyy-MM-dd” format |
Responses
200 — OK
Media type: application/json
json
{
"success": true,
"message": "string",
"warnings": [
{
"title": "string",
"body": "string"
}
],
"storeNumber": 0,
"businessDay": "string",
"items": [
{
"orderKey": "string",
"major": 0,
"minor": 0,
"posNumber": 0,
"pod": "string",
"transactionStart": "string",
"transactionEnd": "string",
"saleType": "string",
"transactionType": "string",
"transactionKind": "string",
"totalNet": 0.0,
"totalTax": 0.0,
"productNet": 0.0,
"productTax": 0.0,
"nonProductNet": 0.0,
"nonProductTax": 0.0,
"orderPlacedLocation": "string",
"orderPaymentLocation": "string",
"orderPresentationLocation": "string",
"channelOrigin": "string",
"promotions": [
{
"promotionId": 0,
"offerId": 0,
"promotionName": "string"
}
],
"offers": [
{
"offerId": 0,
"offerName": "string",
"promotionId": 0,
"offerType": "string"
}
],
"tenders": [
{
"tenderKind": "string",
"tenderName": "string",
"tenderQuantity": 0,
"tenderAmount": 0.0,
"cardProviderId": "string",
"paymentChannel": "string"
}
],
"tax": [
{
"id": 0,
"rate": 0.0,
"baseAmount": 0.0,
"amount": 0.0
}
]
}
]
}