{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/labor/operation/shiftsShiftIdPut/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/labor/operation/shiftsShiftIdPut/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.9.0\",\"title\":\"Toast Labor API\",\"description\":\"Toast labor API is a set of REST web services that you can use to \\nmanage the employees, jobs, and shifts for your restaurant. The \\nlabor API is intended for software engineers, managers, and \\ntechnical staff who are responsible for integrating third-party \\nsystems with the Toast platform.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Employees\"},{\"name\":\"Jobs\"},{\"name\":\"Shifts\"},{\"name\":\"Time entries\"}],\"paths\":{\"/employees\":{\"get\":{\"tags\":[\"Employees\"],\"summary\":\"Get employees\",\"description\":\"Returns an array of `Employee` objects containing information \\nabout restaurant employees.\\n\",\"operationId\":\"employeesGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeIds\",\"description\":\"An optional identifier that filters return values for a \\nspecific employee. The identifier can be a Toast platform \\nGUID or an external identifier. If present, the `employees` \\nresource will only return the employees you specify. You \\ncan include multiple `employeeIds` query parameters \\n(maximum 100). If not present, the resource returns each \\nemployee for the restaurant.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"JSON objects for all employees in the restaurant\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:read\"]}]},\"post\":{\"tags\":[\"Employees\"],\"summary\":\"Add an employee\",\"description\":\"Creates a restaurant employee record.\\n\",\"operationId\":\"employeesPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"entityType\":\"RestaurantUser\",\"email\":\"email\",\"firstName\":\"first name\",\"chosenName\":\"optional chosen name\",\"lastName\":\"last name\",\"externalId\":\"optional external ID\",\"externalEmployeeId\":\"optional external employee ID\",\"jobReferences\\\"\":[{\"guid\":\"f290a951-2042-4f3d-b861-d89e9e583876\",\"entityType\":\"RestaurantJob\"}],\"wageOverrides\":[{\"jobReference\":{\"guid\":\"f290a951-2042-4f3d-b861-d89e9e583876\",\"entityType\":\"RestaurantJob\"},\"wage\":10}]}}}},\"description\":\"An `Employee` object containing information about the \\nemployee, including the employee's name and email address.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the created employee.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"415\":{\"description\":\"The request did not have \\\"application/json\\\" in the \\nContent-Type header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a requestId \\nattached to this error that can be referenced by Toast \\nsupport.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}\":{\"get\":{\"tags\":[\"Employees\"],\"summary\":\"Get information about one employee\",\"description\":\"Returns an `Employee` object containing information about one \\nrestaurant employee.\\n\",\"operationId\":\"employeesEmployeeIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the\\nemployee to be returned.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the employee information.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"401\":{\"description\":\"Unauthorized - Missing or invalid authentication.\\n\\n**Cause:** No valid OAuth token provided in Authorization header.\\n\"},\"403\":{\"description\":\"Forbidden - Insufficient permissions.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any \\nemployees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:read\"]}]},\"delete\":{\"tags\":[\"Employees\"],\"summary\":\"Delete an employee\",\"description\":\"Deletes a restaurant employee record by marking the record as \\ndeleted. A deleted employee cannot log in at the restaurant or \\nopen new time entries.\\n\\nIf you `GET` an employee record that has been deleted, its \\n`deleted` value is `true` and its `deletedDate` value contains \\nthe date and time the record was deleted. \\n\\nIf you delete an employee that has already been deleted then \\nthe result is successful (200) and no change is made.\\n\\nThe deleted record appears in the list of deleted employees for \\nthe restaurant in Toast Web. From the \\nlist of deleted employees, you can enable a deleted record so \\nthat the employee can use it again. Information about deleted \\nemployees remains available in reports.\\n\\nYou cannot delete employees who have open time entries (time \\nentries that do not have an out date value).\\n\",\"operationId\":\"employeesEmployeeIdDelete\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the \\nemployee to be deleted.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"The employee has been deleted. Returns an `Employee` object \\ncontaining information about the deleted restaurant \\nemployee.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any\\nemployees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]},\"patch\":{\"tags\":[\"Employees\"],\"summary\":\"Update employee information\",\"description\":\"Updates the first name, chosen name, last name, external employee ID, and/or \\npasscode of a restaurant employee. The `PATCH` operation cannot \\nupdate any other employee information.\\n\",\"operationId\":\"employeesEmployeeIdPatch\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID or external identifier for the \\nemployee to be returned.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"firstName\":\"Mynewfirstname\",\"chosenName\":\"Mynewchosenname\",\"lastName\":\"Mynewlastname\",\"externalEmployeeId\":\"1234567890\",\"passcode\":\"1234\",\"currentPasscode\":\"1111\"}}}},\"description\":\"A JSON object containing the employee information that you \\nare updating. You can update an employee's:\\n\\n* `firstName` - First name.\\n\\n* `chosenName` - Chosen name.\\n\\n* `lastName` - Last name.\\n\\n* `externalEmployeeId` - External employee identifier.\\n\\n* `passcode` - The passcode for access to Toast POS devices.\\n\\nAll values are optional. You must include at least one \\nvalue. Each value that you include must contain information \\n(not null). If you include the `passcode` value to update \\nan employee's passcode you must include the employee's \\ncurrent passcode in the `currentPasscode` value.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated Toast platform employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed, or the body of the request was malformed.\\n\"},\"404\":{\"description\":\"The Toast platform GUID or external identifier does not \\nmatch any employees at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/externalId\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"Employees\"],\"summary\":\"Add an external identifier\",\"description\":\"Adds an external identifier for an existing employee. Include \\nthe string value of the new external identifier in the message \\nbody.\\n\\nYou cannot change an existing external identifier with another \\n`POST` request; use `PUT` instead. The Toast platform uses this \\nexternal identifier as one of the unique, persistent \\nidentifiers for an employee record.\\n\",\"operationId\":\"employeesEmployeeIdExternalIdPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/employeesEmployeeIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]},\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Add or replace an external identifier\",\"description\":\"Adds or replaces the external identifier for an\\nexisting employee. Include the string value of the new external\\nidentifier in the message body.\\n\\nThe Toast platform uses this external identifier as one of the \\nunique, persistent identifiers for an employee record. \\n_Changing the external identifier for an existing employee \\nmight affect reporting and other Toast platform functions that \\nselect employees using the `externalId` value._\\n\",\"operationId\":\"employeesEmployeeIdExternalIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/employeesEmployeeIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/unarchive\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Unarchive an employee\",\"description\":\"Unarchives an employee record that was previously archived.\\n\\n* Unarchived employees can sign into the Toast POS.\\n* Unarchived employees can sign in to Toast Web. \\n* When you unarchive an employee, the employee has all \\n  jobs that were previously assigned to them.\\n* If an employee had a swipe card for signing into the \\n  Toast POS, the swipe card _is not_ re-associated with \\n  the employee when you unarchive them.\\n\\nIf you unarchive an employee who will take a different \\nrole than the one they had when they were archived, you \\nmust update the employee's jobs list and verify that the \\nemployee should continue to sign into Toast Web.\\n\",\"operationId\":\"employeesEmployeeIdUnarchivePut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}},\"400\":{\"description\":\"Employee being unarchived is not currently archived.\\n\"}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/jobs\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Replace a jobs list\",\"description\":\"Replaces the list of jobs for an employee. Include a JSON  \\narray of job identifiers in the message body.\\n\\nIf a job is defined at the restaurant group or subgroup level, \\nthis operation adds or removes that job for the the employee at \\n_all restaurant locations_ in the group or subgroup.\\n\",\"operationId\":\"employeesEmployeeIdJobsPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":[{\"guid\":\"dd8cea7a-add5-4508-b8fe-ffd0b584e4da\"},{\"externalId\":\"MyToastNamingAuthority:9876543210\"}]}}},\"description\":\"An array of JSON objects containing identifiers for jobs. \\nThe identifiers can be either Toast platform GUIDs or \\nexternal identifiers.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/employees/{employeeId}/wageOverrides\":{\"parameters\":[{\"name\":\"employeeId\",\"description\":\"The Toast platform GUID of the employee record.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"put\":{\"tags\":[\"Employees\"],\"summary\":\"Replace wage overrides\",\"description\":\"Replaces the list of wage overrides for the jobs that are \\nassigned to an employee. Include a JSON  array of \\n`JobWageOverride` objects in the message body. Include the new \\nwage for the employee in the `wage` value. Specify the wage in \\nU.S. dollars.\\n\\nYou must include all existing wage overrides in the message \\nbody. Any wage overrides that are not present in the array are \\nremoved from the employee record.\\n\",\"operationId\":\"employeesEmployeeIdWageOverridesPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":[{\"jobReference\":{\"guid\":\"8d3bba92-10e4-4345-9ae6-ed94c09dc332\"},\"wage\":15.75}]}}},\"description\":\"An array of JSON `JobWageOverride` objects.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"The wage overrides for the employee are replaced. Returns \\nthe updated employee record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Employee\"}}}}},\"security\":[{\"oauth2\":[\"labor.employees:write\"]}]}},\"/shifts\":{\"get\":{\"tags\":[\"Shifts\"],\"summary\":\"Get shifts\",\"description\":\"Returns an array of `Shift` objects that contain information \\nabout schedule shifts for restaurant employees.\\n\",\"operationId\":\"shiftsGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftIds\",\"description\":\"An optional identifier that filters return values for a\\nspecific shift. The identifier can be a Toast platform GUID\\nor an external identifier. If present, the shifts\\nresource will only return the shifts you specify. You\\ncan include multiple `shiftIds` query parameters (maximum\\n100).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"startDate\",\"description\":\"Optional start date and time of time period to match \\nshifts. A shift matches the time period if the shift \\n`inDate` is after (inclusive) the specified `startDate` and \\nthe shift `outDate` is before the `endDate` (exclusive). \\nThese parameters are required if the `shiftIds` parameter \\nis not defined. The specified period cannot be longer than \\none month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"Optional end date and time of time period to match shifts. \\nA shift matches the time period if the shift `inDate` is \\nafter (inclusive) the specified `startDate` and the shift \\n`outDate` is before the `endDate` (exclusive). These \\nparameters are required if the `shiftIds` parameter is not \\ndefined. The specified period cannot be longer than one \\nmonth.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shifts in an unordered list.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Shift\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]},\"post\":{\"tags\":[\"Shifts\"],\"summary\":\"Create a shift\",\"description\":\"Creates a schedule shift for a restaurant employee.\\n\",\"operationId\":\"shiftsPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"externalId\":\"MyToastNamingAuthority:1234\",\"entityType\":\"Shift\",\"jobReference\":{\"guid\":\"678758d1-6aa8-494c-be55-0614f761d160\",\"externalId\":\"\",\"entityType\":\"RestaurantJob\"},\"employeeReference\":{\"guid\":\"7030407f-761c-4d92-86d9-4e84bc700d0f\",\"externalId\":\"\",\"entityType\":\"RestaurantUser\"},\"inDate\":\"2015-10-10T06:00:00.000+0000\",\"outDate\":\"2015-10-10T12:00:00.000+0000\"}}}},\"description\":\"A `Shift` object containing information about the shift, \\nincluding the job identifier, the employee identifier, and \\nthe start and end times.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Creates a shift record and returns information about it.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"415\":{\"description\":\"The request did not have \\\"application/json\\\" in the \\n`Content-Type` header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]}},\"/shifts/{shiftId}\":{\"get\":{\"tags\":[\"Shifts\"],\"summary\":\"Get a shift\",\"description\":\"Returns a `Shift` object containing of information about one \\nschedule shift for a restaurant employee.\\n\",\"operationId\":\"shiftsShiftIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The Toast platform GUID or an external identifier for the \\nshift.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shifts in an unordered list.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any shifts\\nat the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]},\"put\":{\"tags\":[\"Shifts\"],\"summary\":\"Update a shift\",\"description\":\"Updates an existing schedule shift record for a restaurant \\nemployee. A `PUT` request completely replaces the information \\nin the existing record.\\n\",\"operationId\":\"shiftsShiftIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The shift identifier, either the Toast platform GUID or an \\nexternal identifier.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":{\"entityType\":\"Shift\",\"jobReference\":{\"guid\":\"678758d1-6aa8-494c-be55-0614f761d160\",\"externalId\":\"\",\"entityType\":\"RestaurantJob\"},\"employeeReference\":{\"guid\":\"7030407f-761c-4d92-86d9-4e84bc700d0f\",\"externalId\":\"\",\"entityType\":\"RestaurantUser\"},\"inDate\":\"2015-10-10T06:00:00.000+0000\",\"outDate\":\"2015-10-10T12:00:00.000+0000\"}}}},\"description\":\"The shift information. The `externalId` identifier is not \\nallowed for`PUT` requests.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"Returns the updated `Shift`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The request contains data that is not supported by the \\ncurrent version of the API as described.\\n\"},\"404\":{\"description\":\"The GUID or external identifier does not match any shifts\\nat the current restaurant.\\n\"},\"415\":{\"description\":\"The request did not have `application/json` in the \\n`Content-Type` header.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]},\"delete\":{\"tags\":[\"Shifts\"],\"summary\":\"Delete a shift\",\"description\":\"Marks an existing schedule shift record for a restaurant \\nemployee as deleted. If the shift record was already deleted, \\nthen the operation will succeed (HTTP 200 response code) and no \\nchange will be made.\\n\",\"operationId\":\"shiftsShiftIdDelete\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"shiftId\",\"description\":\"The shift identifier, either the Toast platform GUID or an \\nexternal identifier.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified shift, with the deleted flag set to \\n`true`.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Shift\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed.\\n\"},\"404\":{\"description\":\"The Toast platform GUID or external identifier does not \\nmatch any shifts at the current restaurant.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor.shifts:write\"]}]}},\"/jobs\":{\"get\":{\"tags\":[\"Jobs\"],\"summary\":\"Get jobs\",\"description\":\"Returns an array of `Job` objects containing information about \\nthe employee jobs configured at a restaurant. By default, if no\\njob IDs are provided in the request, deleted jobs will be excluded\\nfrom the array.\\n\",\"operationId\":\"jobsGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"jobIds\",\"description\":\"An optional array of one or more job identifiers, either \\nthe Toast platform GUID or an external identifier assigned \\nby the client. 100 max. If not provided, all jobs known to \\nthe Toast platform for this restaurant will be returned.\\n\",\"in\":\"query\",\"style\":\"form\",\"explode\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}],\"responses\":{\"200\":{\"description\":\"Returns the specified jobs.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/jobs/{jobId}\":{\"get\":{\"tags\":[\"Jobs\"],\"summary\":\"Get one job\",\"description\":\"Returns a `Job` object containing information about one \\nemployee job at a restaurant.\\n\",\"operationId\":\"jobsJobIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"jobId\",\"description\":\"The Toast platform GUID or an external identifier for the \\njob.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified job.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}},\"400\":{\"description\":\"The Toast platform GUID or external identifier was \\nmalformed.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/jobs/{jobId}/externalId\":{\"parameters\":[{\"name\":\"jobId\",\"description\":\"The Toast platform GUID or external identifier of the job \\nrecord.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"Jobs\"],\"summary\":\"Add an external identifier\",\"description\":\"Adds an external identifier for an existing job. Include the \\nstring value of the new external identifier in the message \\nbody.\\n\\nYou cannot change an existing external identifier with another \\n`POST` request. The Toast platform uses this external \\nidentifier as one of the unique, persistent identifiers for a \\njob record.\\n\",\"operationId\":\"jobsJobIdExternalIdPost\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/jobsJobIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated job record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"security\":[{\"oauth2\":[\"labor.jobs:write\"]}]},\"put\":{\"tags\":[\"Jobs\"],\"summary\":\"Add or replace an external identifier\",\"description\":\"Adds or replaces the external identifier for an existing job. \\nInclude the string value of the new external identifier in the \\nmessage body.\\n\\nThe Toast platform uses this external identifier as one of the \\nunique, persistent identifiers for a job record. _Changing the \\nexternal identifier for an existing job might affect reporting \\nand other Toast platform functions that select jobs using the \\n`externalId` value._\\n\",\"operationId\":\"jobsJobIdExternalIdPut\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"Content-Type\",\"description\":\"The Internet Assigned Numbers Authority (IANA) media type \\nof the message body data. The value must be \\n`application/json`.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}}],\"requestBody\":{\"$ref\":\"#/components/requestBodies/jobsJobIdExternalIdPostBody\"},\"responses\":{\"200\":{\"description\":\"Returns the updated job record.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Job\"}}}}},\"security\":[{\"oauth2\":[\"labor.jobs:write\"]}]}},\"/timeEntries\":{\"get\":{\"tags\":[\"Time entries\"],\"summary\":\"Get time entries\",\"description\":\"Returns an array of `TimeEntry` objects that contain \\ninformation about employee shift events. The information \\nincludes shift start times, end times, and the start and end \\ntimes of break periods.\\n\\n*  Include one or more `timeEntryId` query parameters set to \\n   the GUIDs for specific time entries.\\n\\n*  Include both a `startDate` and an `endDate` query parameter \\n   to get time entries for a specific time period.\\n\\n*  Include both a `modifiedStartDate` and a `modifiedEndDate` \\n   query parameter to get the time entries that were modified \\n   during a specific time period.\\n\\n*  Includes a `businessDate` query parameter to get the time \\n   entries with an `inDate` during a specific business date.\\n\\nValid requests include one or more `timeEntryId` parameters, \\nboth a `startDate` and an `endDate`, both a `modifiedStartDate` \\nand a `modifiedEndDate`, or a `businessDate`.\\n\",\"operationId\":\"timeEntriesGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"timeEntryIds\",\"description\":\"Optional array of one or more time entry identifiers, \\neither the Toast platform GUID or an external identifier. \\n100 max.\\n\",\"in\":\"query\",\"explode\":true,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},{\"name\":\"startDate\",\"description\":\"Optional start date and time of time period to match time \\nentries. A time entry matches the time period if its \\nclock-in `inDate` is after (inclusive) the specified \\n`startDate` and before (exclusive) the `endDate`. The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"endDate\",\"description\":\"Optional end date and time of time period to match time \\nentries. A time entry matches the time period if its \\nclock-in `inDate` is after (inclusive) the specified \\n`startDate` and before (exclusive) the `endDate`. The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"modifiedStartDate\",\"description\":\"Start date and time of the time period to match modified \\ntime entries. A time entry matches the time period if that \\nentry was modified after (inclusive) the \\n`modifiedStartDate`. If you include this parameter, you \\nmust also include the `modifiedEndDate` parameter.  The \\nspecified period cannot be longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"modifiedEndDate\",\"description\":\"End date and time of the time period to match modified time \\nentries. A time entry matches the time period if that entry \\nwas modified before (exclusive) the `modifiedEndDate`. If \\nyou include this parameter, you must also include the \\n`modifiedStartDate` parameter.  The specified period cannot \\nbe longer than one month.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"ISO-8601\"}},{\"name\":\"businessDate\",\"description\":\"Optional date to match time entries. A time entry matches \\nthe business date if its clock-in `inDate` is during the \\nbusiness date. The cutoff from one `businessDate` to the \\nnext is the `closeoutHour` for the restaurant.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"format\":\"yyyymmdd\"}},{\"name\":\"includeMissedBreaks\",\"description\":\"Optional flag to indicate whether missed breaks should be \\nreturned in the breaks array for the time entries.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}},{\"name\":\"includeArchived\",\"description\":\"Controls whether the response includes archived time entries, when\\nusing the `startDate` and `endDate` parameters.\\n\\n**Important**: this parameter _has no effect_ if you use the\\n`modifiedStartDate` and `modifiedEndDate` parameters or the\\n`businessDate` parameter to select time entries.\\n\\n* Querying by modified date range _always_ returns archived time entries.\\n* Querying by businessDate _never_ returns archived time entries.\\n\\nThis parameter is optional and the default value is `false`.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified time entries.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TimeEntry\"}}}}},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}},\"/timeEntries/{timeEntryId}\":{\"get\":{\"tags\":[\"Time entries\"],\"summary\":\"Get one time entry\",\"description\":\"Returns a `TimeEntry` object containing information about one \\nemployee shift. The information includes the shift start time, \\nend time, and the start and end times of break periods.\\n\",\"operationId\":\"timeEntriesTimeEntryIdGet\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The Toast platform GUID of the restaurant that is the \\ncontext for this operation.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"timeEntryId\",\"description\":\"The Toast platform GUID or an external identifier for the \\ntime entry.\\n\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"includeMissedBreaks\",\"description\":\"Optional flag to indicate whether missed breaks should be \\nreturned in the breaks array for the time entries.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}},{\"name\":\"includeArchived\",\"description\":\"Controls whether the response includes an archived time entry.\\nOptional.\\n\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"Returns the specified time entry.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/TimeEntry\"}}}},\"400\":{\"description\":\"The GUID or external identifier was malformed.\\n\"},\"500\":{\"description\":\"An unexpected internal error occurred. There is a \\n`requestId` attached to this error that can be referenced \\nby Toast support.\\n\"}},\"security\":[{\"oauth2\":[\"labor:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/labor/v1\"}],\"components\":{\"requestBodies\":{\"jobsJobIdExternalIdPostBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":\"MyToastNamingAuthority:9876543210\"}}},\"description\":\"The JSON string value of the `externalId` for the job \\nrecord. Wrap the value in double quotation marks to make it \\nvalid JSON syntax.\\n\",\"required\":true},\"employeesEmployeeIdExternalIdPostBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\",\"example\":\"MyToastNamingAuthority:9876543210\"}}},\"description\":\"The JSON string value of the `externalId` for the employee \\nrecord. Wrap the value in double quotation marks to make it \\nvalid JSON syntax.\\n\",\"required\":true}},\"securitySchemes\":{\"oauth2\":{\"description\":\"Access to Toast APIs, specific endpoints, \\nand specific API endpoint operations is \\ncontrolled by the scopes that are associated \\nwith your API account. \\nA full reference for Toast API scopes and \\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"labor.employees:read\":\"Allows reading employee information from the labor API.\\n\",\"labor.employees:write\":\"Allows updating employee information in the labor API.\\n\",\"employees.tax-identifier-unmasked:read\":\"Allows reading full unmasked tax identifier (SSN) information for employees\\nvia expand parameter.\\n\",\"employees.tax-identifier-masked:read\":\"Allows reading masked tax identifier (SSN) information for employees via\\nexpand parameter.\\n\",\"labor:read\":\"Allows reading all data except employees from the labor API.\\n\",\"labor.shifts:write\":\"Allows updating shift information in the labor API.\\n\",\"labor.jobs:write\":\"Allows updating job information in the labor API.\\n\"}}}}},\"schemas\":{\"Employee\":{\"type\":\"object\",\"description\":\"A restaurant employee\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"firstName\":{\"type\":\"string\",\"description\":\"Optional, first name of the employee.\\n\"},\"chosenName\":{\"type\":\"string\",\"description\":\"Optional, chosen name of the employee. To be used, when appropriate, in place of first name.\\n\"},\"lastName\":{\"type\":\"string\",\"description\":\"Optional, last name of the employee.\\n\"},\"email\":{\"type\":\"string\",\"description\":\"Employee's email address.\\n\"},\"phoneNumber\":{\"type\":\"string\",\"description\":\"Employee's phone number\\n\"},\"phoneNumberCountryCode\":{\"type\":\"string\",\"description\":\"A numeric code corresponding to one or more countries, \\nused as a telephone number prefix when making international telephone calls.\\n\"},\"passcode\":{\"type\":\"string\",\"description\":\"An optional numeric security code that a new employee can \\nuse to begin a session in a Toast POS device. The \\npasscode value can only occur in `POST` requests. The \\nvalue must be numeric and it must contain at least one \\nand no more than eight digits. The employee can only use \\nthe passcode at the restaurant specified in the `POST` \\nrequest.   The response to a successful `POST` request \\nwill include the passcode value in clear text. A `GET` \\nrequest for the employee will not return the passcode.\\n\"},\"externalEmployeeId\":{\"type\":\"string\",\"description\":\"Optional, employee’s external ID in the Toast platform.\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the employee is deleted in the Toast platform.\\n\"},\"jobReferences\":{\"type\":\"array\",\"description\":\"An array of external references to jobs assigned to this \\nemployee. If the job is deleted, it will be excluded from this array.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/ExternalReference\"}},\"wageOverrides\":{\"type\":\"array\",\"description\":\"An optional array of per job wage overrides, where each \\nelement defines a job reference and the wage override for \\nthis employee when performing that job. If the underlying job\\nis deleted, it will be excluded from the array.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/JobWageOverride\"}},\"v2EmployeeGuid\":{\"type\":\"string\",\"description\":\"This value is included for future use. An alternate Toast \\nplatform GUID for the employee that will be used in \\nupcoming labor API functionality.\\n\"}}}]},\"Job\":{\"type\":\"object\",\"description\":\"A restaurant job.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"title\":{\"type\":\"string\",\"description\":\"Title of the job.\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the job is deleted in the Toast platform.\\n\"},\"wageFrequency\":{\"type\":\"string\",\"description\":\"An enumerated type specifying how to interpret the \\ndefault wage for this job.\\n\",\"enum\":[\"HOURLY\",\"SALARY\"]},\"defaultWage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The default wage of the job.\\n\"},\"tipped\":{\"type\":\"boolean\",\"description\":\"Indicates whether the job receives gratuities (tips).\\n\"},\"code\":{\"type\":\"string\",\"description\":\"A reference identifier for the job. This is an optional \\nfield entered when the job is created. For example, it \\ncan be used to match Toast platform jobs to jobs \\nconfigured in external labor management systems.\\n\"},\"excludeFromReporting\":{\"type\":\"boolean\",\"description\":\"Indicates whether labor summary reports should include hours and pay \\nfor this job. Restaurant employees set this configuration option for a job \\non the **Jobs** page of Toast Web.\\n\"}}}]},\"JobWageOverride\":{\"type\":\"object\",\"description\":\"The overriding job wage, for an employee that has a wage that \\ndiffers from the job's default wage.\\n\",\"required\":[\"wage\",\"jobReference\"],\"properties\":{\"wage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Required currency value of the employee's overriding job wage.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"}}},\"Shift\":{\"type\":\"object\",\"description\":\"A scheduled shift in the Toast platform used to enforce employee \\nclock-in and clock outs. Shifts might be created in an external \\nscheduling system and pushed to the Toast platform.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the shift is deleted in the Toast platform.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employeeReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Timestamp of the beginning of the shift. This is when the \\nemployee can clock in. Expressed in the UTC time zone.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Timestamp of the end of the shift. This is when the \\nemployee can clock out. Expressed in the UTC time zone.\\n\"},\"scheduleConfig\":{\"$ref\":\"#/components/schemas/ScheduleConfig\"}}}]},\"ScheduleConfig\":{\"type\":\"object\",\"description\":\"Schedule configuration containing info about the clock in/clock out\\ngrace period.\\n\",\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"minBeforeClockIn\":{\"description\":\"Grace period minutes before clock in\\n\",\"type\":\"number\",\"format\":\"double\"},\"minAfterClockIn\":{\"description\":\"Grace period minutes after clock in\\n\",\"type\":\"number\",\"format\":\"double\"},\"minBeforeClockOut\":{\"description\":\"Grace period minutes before clock out\\n\",\"type\":\"number\",\"format\":\"double\"},\"minAfterClockOut\":{\"description\":\"Grace period minutes after clock out\\n\",\"type\":\"number\",\"format\":\"double\"}}},\"TimeEntry\":{\"type\":\"object\",\"description\":\"A `TimeEntry` captures the actual time an employee worked or took \\na break. Typically, a time entry is one-to-one with a scheduled \\nshift, but it is possible in the Toast platform for an employee \\nto clock-in and clock-out without a shift.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ExternalReference\"},{\"type\":\"object\",\"properties\":{\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date created, in UTC format (read-only).\\n\"},\"modifiedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date modified, in UTC format (read-only).\\n\"},\"deletedDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date deleted, in UTC format (read-only).\\n\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"If the time entry is deleted in the Toast platform.\\n\"},\"jobReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employeeReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"shiftReference\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that an employee clocked in to a work\\nshift.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that an employee closed a work shift.\\nIf the employee has not closed the shift this field is\\nnull.\\n\"},\"autoClockedOut\":{\"type\":\"boolean\",\"description\":\"Indicates whether the Toast platform automatically clocked the\\nemployee out of their shift at the end of the restaurant business\\nday. For more information, see [the Toast platform guide section\\nabout automatic clock-out and time\\nentries](https://doc.toasttab.com/doc/platformguide/adminEffectOfAutoclockOutOnBreakEntries.html).\\n\"},\"businessDate\":{\"type\":\"string\",\"description\":\"The business date of `inDate`, in the format of \\n\\\"yyyymmdd\\\".\\n\"},\"regularHours\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Regular hours worked by the employee for this time entry, \\nexcluding breaks.\\n\"},\"overtimeHours\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Any overtime hours taken by this employee during this \\ntime entry.\\n\"},\"hourlyWage\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"Optional, historical `hourlyWage`; that is, the wage in \\neffect when the time entry was made. The current \\n`hourlyWage` for the employee (or job) may be different. \\nThis will be null if the job is `SALARY`.\\n\"},\"breaks\":{\"type\":\"array\",\"description\":\"An optional array of time entry breaks, each break \\ndefining a clock-in date, clock-out date, and whether or \\nnot the break was paid.\\n\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/TimeEntryBreak\"}},\"declaredCashTips\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of tips paid in cash during the time\\nentry. This does not include service charges applied as\\nautomatic gratuities. If the employee has not closed the\\nshift, this value is not final and may change. If the\\n`outDate` value is set, the `declaredCashTips` value is\\nfinal.\\n\"},\"nonCashTips\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of tips paid using non-cash tender\\nduring the time entry. For example, this includes credit\\ncard tips. This does not include service charges applied\\nas automatic gratuities. If the employee has not closed\\nthe shift, this value is not final and may change. If the\\n`outDate` value is set, the `nonCashTips` value is final.\\n\"},\"nonCashTipsRoundingLoss\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of cash added to the payout of total\\ntips paid using non-cash tender and service charges\\napplied as automatic gratuities to round up the total to\\nthe nearest $.05. This only applies if tip rounding is\\nconfigured for shift review. If the employee has not\\nclosed the shift, the value should be null.\\n\",\"nullable\":true},\"cashGratuityServiceCharges\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of service charges applied as\\nautomatic gratuities that were paid in cash during the\\ntime entry. If the employee has not closed the shift,\\nthis value is not final and may change. If the `outDate`\\nvalue is set, the `cashGratuityServiceCharges` value is\\nfinal.\\n\"},\"nonCashGratuityServiceCharges\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of service charges applied as\\nautomatic gratuities that were paid using non-cash tender\\nduring the time entry. If the employee has not closed the\\nshift, this value is not final and may change. If the\\n`outDate` value is set, the\\n`nonCashGratuityServiceCharges` value is final.\\n\"},\"tipsWithheld\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount withheld from the employee's credit \\ncard tips during the time entry. The amount withheld is \\ncalculated as a percentage of tips added to credit card \\npayments. If the employee has not closed the shift (the \\n`outDate` value is null), the `tipsWithheld` value is not \\nfinal and may change. If the employee has closed the \\nshift (the `outDate` value is set), the `tipsWithheld` \\nvalue is final.\\n\"},\"nonCashSales\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of non-cash sales during the time \\nentry. The value includes the order amounts and tax.\\nIt does not include tips.\\n\\nIf the employee has not closed the shift, this \\nvalue is `0`. If the `outDate` value is set, then the \\n`nonCashSales` value is final.\\n\"},\"cashSales\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of sales paid for in cash during the \\ntime entry. The value includes the order amounts and tax.\\nIt does not include tips.\\n\\nIf the employee has not closed the shift, \\nthis value is `0`. If the `outDate` value is set, \\nthen the `cashSales` value is final.\\n\"}}}]},\"TimeEntryBreak\":{\"type\":\"object\",\"description\":\"Information about a period of time that an employee is not\\nworking during a shift. For example, an employee might take a\\nbreak to eat at some time during a shift. An employee can be paid\\nor unpaid for the break period.\\n\",\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"breakType\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"paid\":{\"type\":\"boolean\",\"description\":\"Indicates whether the employee was paid for the break.\\n* `true` - The break was a paid break.\\n* `false` - The break was an unpaid break.\\n\"},\"inDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the employee started the break period,\\nin UTC.\\n\"},\"outDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the employee ended the break period\\nand returned to work, in UTC.\\n\"},\"missed\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break was a missed break.\\n* `true` - The break was missed.\\n* `false` - The break was taken.\\n\"},\"waived\":{\"type\":\"boolean\",\"description\":\"Indicates whether the break was waived by the employee.\\n* `true` - The break was waived.\\n* `false` - The break was not waived.\\n\"},\"auditResponse\":{\"type\":\"boolean\",\"description\":\"Indicates whether the employee was asked to take the break.\\n\\n* `true` - The employee was asked to take the break.\\n* `false` - The employee was not asked to take the break.\\n\\nNull for break types that do not use break acknowledgement \\ntracking or when the employee did not complete the audit \\nresponse prompt.\\n\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast \\nplatform entity by Toast GUID or an external identifier.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming \\nauthority. You can, for example, use the labor API to \\n`POST` an `externalId` for an employee and then `GET` the \\nemployee with that `externalId`.\\n\",\"type\":\"string\"}}}]},\"ToastReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast \\nplatform entity by Toast GUID.\\n\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID maintained by the Toast platform.\\n\",\"type\":\"string\"},\"entityType\":{\"description\":\"The type of object this is.\\n\",\"type\":\"string\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-labor-api.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/labor/overview/","redocItemId":"tag/Shifts/operation/shiftsShiftIdPut","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-labor-api.yaml"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"Update a shift"}}},"pageContext":{"id":"2b9d6692-d42d-5a91-be13-a2dd7189ad8boperation/shiftsShiftIdPut__redocly content/labor/operation/shiftsShiftIdPut/","seo":{"title":"Update a shift","description":"Updates an existing schedule shift record for a restaurant \nemployee. A `PUT` request completely replaces the information \nin the existing record.\n","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"labor.reference.page.yaml#operation/shiftsShiftIdPut","pageBaseUrl":"/labor","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/labor/operation/shiftsShiftIdPut/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"labor","id":"labor","title":"labor","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}