Crunchtime Information Systems Supplemental Wage Service API

openapi: 3.2.0
info:
  description: Swagger documentation supporting mobile development of Crunchtime.
  version: '2.99'
  title: Inventory & Labor Supplemental Wage Service API
  termsOfService: http://springfox.io
  contact:
    name: Crunchtime Development Team
    url: http://www.crunchtime.com
    email: apiquestions@crunchtime.com
  license:
    name: Apache License Version 2.0
    url: https://github.com/springfox/springfox/blob/master/LICENSE
servers:
- url: //webservices-test.net-chef.com
tags:
- name: Supplemental Wage Service
  description: The Supplemental Wage Service allows you to get or post Lump Sum or Hourly values to individual employees/positions for various supplemental earnings, such as tip sharing, vacation pay, sick pay, jury duty, etc. The Supplemental Wage Codes referenced in the API must be preconfigured in Enterprise Manager. This service contains all of the data required to review and process these records in the NetChef Labor Summary screen or extract the data for Payroll purposes.
paths:
  /supplementalwage/v1/getAllSupplementalWages:
    get:
      tags:
      - Supplemental Wage Service
      summary: getAllSupplementalWagesV1
      description: Retrieve details of supplemental wages by location.
      operationId: getAllSupplementalWageRecordsV1UsingGET
      parameters:
      - name: authenticationtoken
        in: header
        description: Secure token for API authentication.
        required: true
        schema:
          type: string
      - name: employeeNumber
        in: query
        description: The employee number from the employee record.
        required: false
        schema:
          type: string
      - name: laborDate
        in: query
        description: The Labor Date to retrieve, in format dd-MMM-yy.
        required: true
        schema:
          type: string
      - name: locationCode
        in: query
        description: The Code that identifies the Location in Crunchtime.
        required: true
        schema:
          type: string
      - name: password
        in: header
        description: Password for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: posCode
        in: query
        description: The POS Code for the Position.
        required: false
        schema:
          type: string
      - name: sitename
        in: header
        description: Crunchtime site identifier. (test or production)
        required: true
        schema:
          type: string
      - name: The Code number for the Supplemental Wage.
        in: query
        description: Supplemental wage code to retrieve.
        required: false
        schema:
          type: string
      - name: userid
        in: header
        description: User ID for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: X-B3-TraceId
        in: header
        description: Optional trace identifier for troubleshooting.
        required: false
        schema:
          type: string
      - name: includeNull
        in: query
        description: Specify 'true' to output null data elements.
        required: false
        allowEmptyValue: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SupplementalWageDetails'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SupplementalWageDetails'
        '400':
          description: Validation Error
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
        '401':
          description: Authorization
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '404':
          description: Supplemental Wage not found
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected Error
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '503':
          description: System under maintenance
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
  /supplementalwage/v1/getSupplementalWagesByPage:
    get:
      tags:
      - Supplemental Wage Service
      summary: getSupplementalWagesByPage
      description: Retrieve details of supplemental wages by page number.
      operationId: getSupplementalWageRecordsByPageUsingGET
      parameters:
      - name: authenticationtoken
        in: header
        description: Secure token for API authentication.
        required: true
        schema:
          type: string
      - name: employeeNumber
        in: query
        description: The employee number from the employee record.
        required: false
        schema:
          type: string
      - name: laborDate
        in: query
        description: The Labor Date to retrieve, in format dd-MMM-yy.
        required: true
        schema:
          type: string
      - name: locationCode
        in: query
        description: The Code that identifies the Location in Crunchtime.
        required: false
        schema:
          type: string
      - name: pageNumber
        in: query
        description: "Retrieve one or more records by `pageNumber`. \n Use to retrieve data in smaller chunks. \n If left blank, the default is `1`."
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: password
        in: header
        description: Password for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: posCode
        in: query
        description: The POS Code for the Position.
        required: false
        schema:
          type: string
      - name: sitename
        in: header
        description: Crunchtime site identifier. (test or production)
        required: true
        schema:
          type: string
      - name: supplementalWageCode
        in: query
        description: The Code number for the Supplemental Wage.
        required: false
        schema:
          type: string
      - name: userid
        in: header
        description: User ID for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: X-B3-TraceId
        in: header
        description: Optional trace identifier for troubleshooting.
        required: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of items to display per page.
        required: false
        schema:
          type: integer
          format: int32
      - name: includeNull
        in: query
        description: Specify 'true' to output null data elements.
        required: false
        allowEmptyValue: true
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SupplementalWageBatchResponseDto'
            application/json:
              schema:
                $ref: '#/components/schemas/SupplementalWageBatchResponseDto'
        '400':
          description: Validation Error
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
        '401':
          description: Authorization
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '404':
          description: Supplemental Wage not found
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected Error
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '503':
          description: System under maintenance
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
  /supplementalwage/v1/saveSupplementalWages:
    post:
      tags:
      - Supplemental Wage Service
      summary: saveSupplementalWages
      description: Create a new supplemental wage entry for a specific location.
      operationId: saveSupplementalWageRecordsUsingPOST
      parameters:
      - name: authenticationtoken
        in: header
        description: Secure token for API authentication.
        required: true
        schema:
          type: string
      - name: password
        in: header
        description: Password for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: sitename
        in: header
        description: Crunchtime site identifier. (test or production)
        required: true
        schema:
          type: string
      - name: userid
        in: header
        description: User ID for the Crunchtime Application User.
        required: true
        schema:
          type: string
      - name: X-B3-TraceId
        in: header
        description: Optional trace identifier for troubleshooting.
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplementalWageDetailsList'
        description: supplementalWageDetails
        required: true
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: object
            application/json:
              schema:
                type: object
        '400':
          description: Validation Error
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ObjectError'
        '401':
          description: Authorization
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '500':
          description: Unexpected Error
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '503':
          description: System under maintenance
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
        '504':
          description: Timeout
          content:
            '*/*':
              schema:
                type: string
            application/json:
              schema:
                type: string
components:
  schemas:
    SupplementalWageDetailsList:
      type: object
      required:
      - locationCode
      properties:
        locationCode:
          type: string
          example: '000122'
          description: The Code that identifies the Location in Crunchtime.
        supplementalWageDetails:
          type: array
          items:
            $ref: '#/components/schemas/SupplementalWageDetails'
      title: SupplementalWageDetailsList
      description: SupplementalWageDetailsList description
    ObjectError:
      type: object
      properties:
        arguments:
          type: array
          items:
            type: object
        code:
          type: string
        codes:
          type: array
          items:
            type: string
        defaultMessage:
          type: string
        objectName:
          type: string
      title: ObjectError
    SupplementalWageDetailDto:
      type: object
      required:
      - employeeNumber
      - hourlyFlag
      - laborDate
      - lumpSumFlag
      - supplementalWageCode
      properties:
        dateTimeFormat:
          type: string
        employeeNumber:
          type: string
          example: 000-R01
          description: Employee number for the employee associated with the supplemental wage.
        hourlyFlag:
          type: string
          example: Y
          description: Indicates (Y/N) whether the supplemental wage should be paid for a number of hours.
        hourlyValue:
          type: number
          example: 9.1
          description: The number of hours for which the supplemental wage should be paid.
        laborDate:
          type: string
          example: MM/dd/yyyy
          description: The date for which the supplemental wage should be paid.
        lumpSumFlag:
          type: string
          example: Y
          description: Indicates (Y/N) whether the supplemental wage should be paid as a lump sum.
        lumpSumValue:
          type: number
          example: 10.2
          description: The lump sum value of the supplemental wage to be paid.
        posCode:
          type: string
          example: 000-R01
          description: The POS ID number of the employee associated with the supplemental wage.
        supplementalWageCode:
          type: string
          example: PTO1
          description: The Code number of the supplemental wage entry.
        dailyLumpSumFlag:
          type: string
          example: Y
          description: Indicates (Y/N) whether the supplemental wage should be paid as a daily lump sum.
        dailyLumpSumValue:
          type: number
          example: 1050.25
          description: 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.
      title: SupplementalWageDetailDto
      description: SupplementalWageDetailDto description
    SupplementalWageDetails:
      type: object
      properties:
        supplementalWageDetailDetails:
          type: array
          items:
            $ref: '#/components/schemas/SupplementalWageDetailDto'
        supplementalWageHeaderDetails:
          $ref: '#/components/schemas/SupplementalWageHeaderDto'
      title: SupplementalWageDetails
      description: SupplementalWageDetails description
    SupplementalWageHeaderDto:
      type: object
      required:
      - locationCode
      properties:
        dateTimeFormat:
          type: string
        locationCode:
          type: string
          example: 123456
          description: The Location Code for the location associated with the supplemental wage.
      title: SupplementalWageHeaderDto
      description: SupplementalWageHeaderDto description
    SupplementalWageBatchResponseDto:
      type: object
      properties:
        hasNext:
          type: boolean
        supplementalWageDetails:
          type: array
          items:
            $ref: '#/components/schemas/SupplementalWageDetails'
        totalPages:
          type: integer
          format: int32
      title: SupplementalWageBatchResponseDto
      description: SupplementalWageBatchResponseDto description
externalDocs:
  description: Crunchtime Developer Hub
  url: https://developer.crunchtime.com/
x-provenance:
  method: searched
  source: https://developer.crunchtime.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.crunchtime.com/reference/downloadscheduledexportsv1usingget.md
  - https://developer.crunchtime.com/reference/downloadscheduledexportsv2usingget.md
  - https://developer.crunchtime.com/reference/get15minutessalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/get15minutessalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/get_commissaryorder-v1-getcommissaryordersbypage.md
  - https://developer.crunchtime.com/reference/get_customerorderenhanced-v1-getcustomerorderenhancedbypage.md
  - https://developer.crunchtime.com/reference/getallapplicationusersv1usingget.md
  - https://developer.crunchtime.com/reference/getallbudgetv1usingget.md
  - https://developer.crunchtime.com/reference/getallcategoryv1usingget.md
  - https://developer.crunchtime.com/reference/getallcheckmenumixrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallcommissaryordersv1usingget.md
  - https://developer.crunchtime.com/reference/getallcompanyproductsenhancedv1usingget.md
  - https://developer.crunchtime.com/reference/getallconfirmreceiptstandardv1usingget.md
  - https://developer.crunchtime.com/reference/getallcurrencyratiov1usingget.md
  - https://developer.crunchtime.com/reference/getallcustomerorderenhancedv1usingget.md
  - https://developer.crunchtime.com/reference/getallcustomerrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getalldailyprepsv1usingget.md
  - https://developer.crunchtime.com/reference/getallgeneralledgersv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventoryadjustmentv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventorylocationtransfersv1usingget.md
  - https://developer.crunchtime.com/reference/getallinventoryvalueadjustmentv1usingget.md
  - https://developer.crunchtime.com/reference/getalllocationproductpricingv1usingget.md
  - https://developer.crunchtime.com/reference/getalllocationsv1usingget.md
  - https://developer.crunchtime.com/reference/getallnutritionv1usingget.md
  - https://developer.crunchtime.com/reference/getallpackagetypesv2usingget.md
  - https://developer.crunchtime.com/reference/getallpbisbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getallpbisv2usingget.md
  - https://developer.crunchtime.com/reference/getallphysicalinventorystandardusingget.md
  - https://developer.crunchtime.com/reference/getallprojectedconsumptionv1usingget.md
  - https://developer.crunchtime.com/reference/getallpurchaseordersv1usingget.md
  - https://developer.crunchtime.com/reference/getallrecipelocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallrecipesenhancedv2usingget.md
  - https://developer.crunchtime.com/reference/getallsalesmixrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallscheduledexportsv1usingget.md
  - https://developer.crunchtime.com/reference/getallstoragelocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallsupplementalwagerecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getalltimeclockenhancedrecordsv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorlocationv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorpaymentv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorproductpricingv1usingget.md
  - https://developer.crunchtime.com/reference/getallvendorsv1usingget.md
  - https://developer.crunchtime.com/reference/getapplicationusersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getattachmentsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getattachmentsbypagev2.md
  - https://developer.crunchtime.com/reference/getbudgetbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcategorybypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcheckmenumixrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcompanyproductsenhancedbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getconfirmreceiptstandardbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcurrencyratiobypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcurrentinventorybypagev1usingget.md
  - https://developer.crunchtime.com/reference/getcustomerrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailyprepsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailysalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getdailysalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/getemployeenumbersv1usingget.md
  - https://developer.crunchtime.com/reference/getemployeesbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getemployeev1usingget.md
  - https://developer.crunchtime.com/reference/gethierarchiesv2usingget.md
  - https://developer.crunchtime.com/reference/gethierarchydetailsv2usingget.md
  - https://developer.crunchtime.com/reference/gethourlysalesforecastbypagev1usingget.md
  - https://developer.crunchtime.com/reference/gethourlysalesforecastv1usingget.md
  - https://developer.crunchtime.com/reference/getinventoryadjustmentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getinventorylocationtransfersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getinventoryvalueadjustmentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getlocationproductpricingbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getlocationsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getnutritionbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getpackagetypesbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getphysicalinventorystandardbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getprojectedconsumptionbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getpurchaseordersbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getrecipelocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getrecipesenhancedbypagev2usingget.md
  - https://developer.crunchtime.com/reference/getsalesmixrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getschedulesv1usingget.md
  - https://developer.crunchtime.com/reference/getstoragelocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getsupplementalwagerecordsbypageusingget.md
  - https://developer.crunchtime.com/reference/gettimeclockenhancedrecordsbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getudalocationsusingget.md
  - https://developer.crunchtime.com/reference/getudavendorsusingget.md
  - https://developer.crunchtime.com/reference/getvendorlocationbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getvendorpaymentbypagev1usingget.md
  - https://developer.crunchtime.com/reference/getvendorproductpricingbypagev1usingget.md
  - https://developer.crunchtime.com/reference/markscheduledexportsv1usingput.md
  - https://developer.crunchtime.com/reference/save15minutessalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveapplicationusersv1usingpost.md
  - https://developer.crunchtime.com/reference/savebudgetusingpost.md
  - https://developer.crunchtime.com/reference/savecategoryusingpost.md
  - https://developer.crunchtime.com/reference/savecheckmenumixrecordsv1usingpost.md
  - https://developer.crunchtime.com/reference/savecompanyproductenhancedv1usingpost.md
  - https://developer.crunchtime.com/reference/saveconfirmreceiptstandardusingpost.md
  - https://developer.crunchtime.com/reference/savecurrencyratiousingpost.md
  - https://developer.crunchtime.com/reference/savecustomerorderenhancedusingpost.md
  - https://developer.crunchtime.com/reference/savecustomerrecordsusingpost.md
  - https://developer.crunchtime.com/reference/savedailyprepsusingpost.md
  - https://developer.crunchtime.com/reference/savedailysalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveelectronicinvoiceusingpost.md
  - https://developer.crunchtime.com/reference/saveemployeev1usingpost.md
  - https://developer.crunchtime.com/reference/savegeneralledgerv1usingpost.md
  - https://developer.crunchtime.com/reference/savehierarchyv2usingpost.md
  - https://developer.crunchtime.com/reference/savehourlysalesforecastusingpost.md
  - https://developer.crunchtime.com/reference/saveinventoryadjustmentusingpost.md
  - https://developer.crunchtime.com/reference/saveinventoryvalueadjustmentusingpost.md
  - https://developer.crunchtime.com/reference/savelocationproductpricingusingpost.md
  - https://developer.crunchtime.com/reference/savelocationv1usingpost.md
  - https://developer.crunchtime.com/reference/savenutritionusingpost.md
  - https://developer.crunchtime.com/reference/savepackagetypesv2usingpost.md
  - https://developer.crunchtime.com/reference/savepbiv2usingpost.md
  - https://developer.crunchtime.com/reference/savephysicalinventorystandardusingpost.md
  - https://developer.crunchtime.com/reference/saveprojectedconsumptionusingpost.md
  - https://developer.crunchtime.com/reference/savepurchaseordersusingpost.md
  - https://developer.crunchtime.com/reference/saverecipelocationusingpost.md
  - https://developer.crunchtime.com/reference/saverecipesv2usingpost.md
  - https://developer.crunchtime.com/reference/savesalesmixrecordusingpost.md
  - https://developer.crunchtime.com/reference/savestoragelocationusingpost.md
  - https://developer.crunchtime.com/reference/savesupplementalwagerecordsusingpost.md
  - https://developer.crunchtime.com/reference/savetimeclockenhancedrecordsusingpost.md
  - https://developer.crunchtime.com/reference/savevendorlocationv1usingpost.md
  - https://developer.crunchtime.com/reference/savevendorpaymentusingpost.md
  - https://developer.crunchtime.com/reference/savevendorv1usingpost.md
  - https://developer.crunchtime.com/reference/validateuserusingpost.md
  merge:
    pages: 122
    deduped: 334
    conflicts_kept_first: 0