---
updatedAt: 2026-06-12T14:08:37.000Z
agentTools:
  projectIndex: https://developer.crunchtime.com/llms.txt
---

# saveSupplementalWages

Create a new supplemental wage entry for a specific location.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger documentation supporting mobile development of Crunchtime.",
    "version": "2.99",
    "title": "Inventory & Labor",
    "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"
    }
  },
  "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/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"
                }
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "Crunchtime Developer Hub",
    "url": "https://developer.crunchtime.com/"
  },
  "servers": [
    {
      "url": "//webservices-test.net-chef.com"
    }
  ],
  "components": {
    "schemas": {
      "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"
      },
      "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"
      },
      "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"
      }
    }
  }
}
```