---
title: "getSupplementalWagesByPage"
method: GET
path: "/supplementalwage/v1/getSupplementalWagesByPage"
tags: ["Supplemental Wage Service"]
---

# getSupplementalWagesByPage

`GET /supplementalwage/v1/getSupplementalWagesByPage`

## Request

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

Retrieve details of supplemental wages by page number.

## Query parameters

- `employeeNumber` string
- `laborDate` string, required
- `locationCode` string
- `pageNumber` integer
- `posCode` string
- `supplementalWageCode` string
- `pageSize` integer
- `includeNull` boolean

## Headers

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

## Response `200`

Success

- SupplementalWageBatchResponseDto: SupplementalWageBatchResponseDto description
  - `hasNext` boolean
  - `supplementalWageDetails` SupplementalWageDetails[]
    - `supplementalWageDetailDetails` SupplementalWageDetailDto[]
      - `dateTimeFormat` string
      - `employeeNumber` string, required: Employee number for the employee associated with the supplemental wage.
      - `hourlyFlag` string, required: Indicates (Y/N) whether the supplemental wage should be paid for a number of hours.
      - `hourlyValue` number: The number of hours for which the supplemental wage should be paid.
      - `laborDate` string, required: The date for which the supplemental wage should be paid.
      - `lumpSumFlag` string, required: Indicates (Y/N) whether the supplemental wage should be paid as a lump sum.
      - `lumpSumValue` number: The lump sum value of the supplemental wage to be paid.
      - `posCode` string: The POS ID number of the employee associated with the supplemental wage.
      - `supplementalWageCode` string, required: The Code number of the supplemental wage entry.
      - `dailyLumpSumFlag` string: Indicates (Y/N) whether the supplemental wage should be paid as a daily lump sum.
      - `dailyLumpSumValue` number: The daily lump sum value of the supplemental wage to be paid. The value must be a number between 0.00 and 99,999.99 (or between -99,999.99 and 99,999.99 if flagged as Tip Credit Eligible) and contain no more than 2 decimal places.
    - `supplementalWageHeaderDetails` SupplementalWageHeaderDto: SupplementalWageHeaderDto description
      - `dateTimeFormat` string
      - `locationCode` string, required: The Location Code for the location associated with the supplemental wage.
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: Supplemental Wage 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)