---
title: "getSalesMixByPage"
method: GET
path: "/salesmix/v1/getSalesMixByPage"
tags: ["Sales Mix Service"]
---

# getSalesMixByPage

`GET /salesmix/v1/getSalesMixByPage`

## Request

- Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known)
- URL: `//webservices-test.net-chef.com/salesmix/v1/getSalesMixByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

Retrieve summarized sales mix data by GL by location by page number.

## Query parameters

- `includeDetails` boolean
- `locationCode` string, required
- `pageNumber` integer
- `posNumber` string
- `transactionDate` string, required
- `pageSize` integer
- `includeNull` boolean
- `type` string

## Headers

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

## Response `200`

Success

- SalesMixBatchResponseDto: SalesMixBatchResponseDto description
  - `hasNext` boolean
  - `salesMixDetails` SalesMixDetailsGet[]
    - `salesMixDetailDetails` SalesMixDetailsDto[]
      - `daypartCode` integer, required: "daypartCode" from salesmix. Required for "Sales" and "Sales Tax" rows only. (Not used for other record types.)
      - `glNumber` string, required: "glNumber" from salesmix. GL Number is not required (or) stored for Bank Deposits.
      - `glValue` number, required: "glValue" from salesmix
      - `memo` string: "memo" from salesmix
      - `type` integer, required: "type" from salesmix
    - `salesMixHeaderDetails` SalesMixHeaderDtoGet: SalesMixHeaderDtoGet description
      - `bankDeposits` number: "bankDeposits" from Sales Mix
      - `bookCash` number: "bookCash" from Sales Mix
      - `cateringAccounts` number: "cateringAccounts" from Sales Mix
      - `cateringSales` number: "cateringSales" from Sales Mix
      - `chargedTips` number: "chargedTips" from Sales Mix
      - `complimentary` number: "complimentary" from Sales Mix
      - `endingCount` integer: "endingCount" from Sales Mix
      - `grossSales` number: "grossSales" from Sales Mix
      - `middayCount` integer: "middayCount" from Sales Mix
      - `morningCount` integer: "morningCount" from Sales Mix
      - `numberOfVoids` integer: "numberOfVoids" from Sales Mix
      - `overShort` number: "overShort" from Sales Mix
      - `paidOuts` number: "paidOuts" from Sales Mix
      - `paymentMedia1` number: "paymentMedia1" from Sales Mix
      - `paymentMedia2` number: "paymentMedia2" from Sales Mix
      - `paymentMedia3` number: "paymentMedia3" from Sales Mix
      - `registerNumber` string, required: "registerNumber" from Sales Mix
      - `salesTax` number: "salesTax" from Sales Mix
      - `taxExemptAmount` number: "taxExemptAmount" from Sales Mix
      - `taxableSales` number: "taxableSales" from Sales Mix
      - `totalNetSales` number: "totalNetSales" from Sales Mix
      - `totalOverrings` number: "totalOverrings" from Sales Mix
      - `totalVoidedAmount` number: "totalVoidedAmount" from Sales Mix
      - `transactionDate` string, required: "transactionDate" from Sales Mix
      - `zReadingNumber` string: "zReadingNumber" from Sales Mix
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: sales mix not found
- `429`: Too Many Requests
- `500`: Unexpected Error
- `503`: System under maintenance
- `504`: Timeout

---

[API](https://skmtc.dev/crunchtime/apis/inventory-labor.md) - [All operations](https://skmtc.dev/crunchtime/apis/inventory-labor/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/inventory-labor/revisions/fff247a87cc9?raw)