Replace wage overrides

Replaces the list of wage overrides for the jobs that are assigned to an employee. Include a JSON array of JobWageOverride objects in the message body. Include the new wage for the employee in the wage value. Specify the wage in U.S. dollars.

You must include all existing wage overrides in the message body. Any wage overrides that are not present in the array are removed from the employee record.

Securityoauth2
Request
path Parameters
employeeId
required
string

The Toast platform GUID of the employee record.

header Parameters
Content-Type
required
string <string>

The Internet Assigned Numbers Authority (IANA) media type of the message body data. The value must be application/json.

Toast-Restaurant-External-ID
required
string <string>

The Toast platform GUID of the restaurant that is the context for this operation.

Request Body schema: application/json

An array of JSON JobWageOverride objects.

string
Responses
200

The wage overrides for the employee are replaced. Returns the updated employee record.

put/employees/{employeeId}/wageOverrides
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "firstName": "string",
  • "chosenName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "phoneNumberCountryCode": "string",
  • "passcode": "string",
  • "externalEmployeeId": "string",
  • "deleted": true,
  • "jobReferences": [
    ],
  • "wageOverrides": [
    ],
  • "v2EmployeeGuid": "string"
}