---
title: "GetAllCheckMenuMixRecordsV1"
method: GET
path: "/checkmenumix/v1/getAllCheckMenuMix"
tags: ["Check Menu Mix Service"]
---

# GetAllCheckMenuMixRecordsV1

`GET /checkmenumix/v1/getAllCheckMenuMix`

Retrieve Menu Mix sales data stored at the Check/Recipe Item level of granularity. 
 Retrieve a single Menu Mix sales data record with details using `checkNumber` and `includeDetails`.

## Query parameters

- `businessDate` string, required
- `checkNumber` string
- `includeDetails` boolean
- `locationCode` string, required
- `includeNull` boolean
- `includeEmptyChecks` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- CheckMenuMixDetailsGet[]
  - `checkMenuMixDetails` CheckMenuMixHeaderDto — Check Menu Mix Header items.
    - `businessDate` string, required — Date the check was created.
    - `customerCode` string, required — The Customer "Code" or "Import Code" for a Customer linked to the Location, or the Location "Code" or "Import Code".
    - `locationCode` string, required — Company Code for site name.
  - `checkMenuMixGroupDetails` CheckMenuMixGroupDetails[]
    - `checkMenuMixCheckDetails` CheckMenuMixCheckDetailDto[] — List of check details.
      - `chargeTips` number — The tips charged to a credit card.
      - `checkCloseTime` string — Time the check was closed in format HH:mm (24hr format).
      - `checkNumber` string, required — The check number.
      - `checkOpenTime` string, required — Time the check was opened in format HH:mm (24hr format).
      - `excludeConsumptionFlag` string — Exclude the sales data from this check in Consumption calculations.
      - `guestCount` integer — The number of guests listed on the check.
      - `timeOfSale` string, required — Time sale time listed on the check in format HH:mm (24hr format).
    - `checkMenuMixItemDetails` CheckMenuMixItemDetailDto[] — List of items on the check.
      - `checkNumber` string, required — The check number.
      - `cost` number — The cost of the Recipe item.
      - `itemType` integer — Identification for Price Lookup type (recipe vs discount).
      - `parentLineNumber` integer — Parent Recipe item line number.
      - `pluNumber` integer, required — Price lookup number for Recipe item.
      - `posLineNumber` integer, required — The line number of the Recipe item on the check.
      - `posPrice` number, required — The sale price of the Recipe item.
      - `posQuantity` number, required — The quantity sold of the Recipe item.
      - `posValue` number, required — The sale value of the Recipe item.
      - `productNumber` string — The product number of the Recipe item.
      - `recipeName` string — Recipe Name to help identify the Price lookup number.
      - `revenueCenter` string — Sale item revenue center code.
      - `serverID` string — ID or code for server who sold the item.
      - `timeOfSale` string, required — Item sale time in format HH:mm (24hr clock).
    - `checkMenuMixMiscCheckDetails` CheckMenuMixMiscCheckDetailDto[] — List of miscellaneous check details.
      - `checkNumber` string, required — The check number.
      - `dataValue` string, required — Information linked to the miscellaneous id.
      - `miscId` integer, required — ID for miscellaneous information.
    - `checkMenuMixMiscItemDetails` CheckMenuMixMiscItemDetailDto[] — List of miscellaneous item details.
      - `checkNumber` string, required — The check number.
      - `dataValue` string, required — Information linked to the miscellaneous id.
      - `miscId` integer, required — ID for miscellaneous information
      - `pluNumber` integer, required — Price lookup number for Recipe item.
      - `posLineNumber` integer, required — The line number of the Recipe item on the check
    - `checkMenuMixTimeDetails` CheckMenuMixTimeDetailDto[] — List of time details on the check.
      - `checkNumber` string, required — The check number.
      - `posTimeId` integer, required — ID for time sensitive tasks.
      - `value` number, required — Duration of a task in seconds.
  - `checkMenuMixHeaderDetails` CheckMenuMixHeaderDto — Check Menu Mix Header items.
    - `businessDate` string, required — Date the check was created.
    - `customerCode` string, required — The Customer "Code" or "Import Code" for a Customer linked to the Location, or the Location "Code" or "Import Code".
    - `locationCode` string, required — Company Code for site name.

## Other responses

- `400` — Validation Error
- `401` — Authorization
- `404` — Check Menu Mix not found
- `429` — Too Many Requests
- `500` — Unexpected Error
- `503` — System under maintenance
- `504` — Timeout

---

[API](https://skmtc.net/crunchtime/apis/inventory-labor.md) · [All operations](https://skmtc.net/crunchtime/apis/inventory-labor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crunchtime/inventory-labor/revisions/0af8e380ff2c/schema)