5.8 KiB
5.8 KiB
name, description
| name | description |
|---|---|
| labor-routes | Handle 27 OpenAPI operation(s) under /v2/labor for the labor route group. |
labor API Routes
Handle 27 OpenAPI operation(s) under /v2/labor for the labor route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_break_types
- Operation ID:
list_break_types - Route:
GET /v2/labor/break-types - Mode: READ
- Summary: ListBreakTypes
- Parameters:
location_idinquerylimitinquerycursorinquery
create_break_type
- Operation ID:
create_break_type - Route:
POST /v2/labor/break-types - Mode: WRITE
- Summary: CreateBreakType
- Body: JSON request body accepted.
delete_break_type
- Operation ID:
delete_break_type - Route:
DELETE /v2/labor/break-types/{id} - Mode: WRITE
- Summary: DeleteBreakType
- Parameters:
idinpathrequired
get_break_type
- Operation ID:
get_break_type - Route:
GET /v2/labor/break-types/{id} - Mode: READ
- Summary: GetBreakType
- Parameters:
idinpathrequired
update_break_type
- Operation ID:
update_break_type - Route:
PUT /v2/labor/break-types/{id} - Mode: WRITE
- Summary: UpdateBreakType
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
list_employee_wages
- Operation ID:
list_employee_wages - Route:
GET /v2/labor/employee-wages - Mode: READ
- Summary: ListEmployeeWages
- Parameters:
employee_idinquerylimitinquerycursorinquery
get_employee_wage
- Operation ID:
get_employee_wage - Route:
GET /v2/labor/employee-wages/{id} - Mode: READ
- Summary: GetEmployeeWage
- Parameters:
idinpathrequired
create_scheduled_shift
- Operation ID:
create_scheduled_shift - Route:
POST /v2/labor/scheduled-shifts - Mode: WRITE
- Summary: CreateScheduledShift
- Body: JSON request body accepted.
bulk_publish_scheduled_shifts
- Operation ID:
bulk_publish_scheduled_shifts - Route:
POST /v2/labor/scheduled-shifts/bulk-publish - Mode: WRITE
- Summary: BulkPublishScheduledShifts
- Body: JSON request body accepted.
search_scheduled_shifts
- Operation ID:
search_scheduled_shifts - Route:
POST /v2/labor/scheduled-shifts/search - Mode: WRITE
- Summary: SearchScheduledShifts
- Body: JSON request body accepted.
retrieve_scheduled_shift
- Operation ID:
retrieve_scheduled_shift - Route:
GET /v2/labor/scheduled-shifts/{id} - Mode: READ
- Summary: RetrieveScheduledShift
- Parameters:
idinpathrequired
update_scheduled_shift
- Operation ID:
update_scheduled_shift - Route:
PUT /v2/labor/scheduled-shifts/{id} - Mode: WRITE
- Summary: UpdateScheduledShift
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
publish_scheduled_shift
- Operation ID:
publish_scheduled_shift - Route:
POST /v2/labor/scheduled-shifts/{id}/publish - Mode: WRITE
- Summary: PublishScheduledShift
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
create_shift
- Operation ID:
create_shift - Route:
POST /v2/labor/shifts - Mode: WRITE
- Summary: CreateShift
- Body: JSON request body accepted.
search_shifts
- Operation ID:
search_shifts - Route:
POST /v2/labor/shifts/search - Mode: WRITE
- Summary: SearchShifts
- Body: JSON request body accepted.
delete_shift
- Operation ID:
delete_shift - Route:
DELETE /v2/labor/shifts/{id} - Mode: WRITE
- Summary: DeleteShift
- Parameters:
idinpathrequired
get_shift
- Operation ID:
get_shift - Route:
GET /v2/labor/shifts/{id} - Mode: READ
- Summary: GetShift
- Parameters:
idinpathrequired
update_shift
- Operation ID:
update_shift - Route:
PUT /v2/labor/shifts/{id} - Mode: WRITE
- Summary: UpdateShift
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
list_team_member_wages
- Operation ID:
list_team_member_wages - Route:
GET /v2/labor/team-member-wages - Mode: READ
- Summary: ListTeamMemberWages
- Parameters:
team_member_idinquerylimitinquerycursorinquery
get_team_member_wage
- Operation ID:
get_team_member_wage - Route:
GET /v2/labor/team-member-wages/{id} - Mode: READ
- Summary: GetTeamMemberWage
- Parameters:
idinpathrequired
create_timecard
- Operation ID:
create_timecard - Route:
POST /v2/labor/timecards - Mode: WRITE
- Summary: CreateTimecard
- Body: JSON request body accepted.
search_timecards
- Operation ID:
search_timecards - Route:
POST /v2/labor/timecards/search - Mode: WRITE
- Summary: SearchTimecards
- Body: JSON request body accepted.
delete_timecard
- Operation ID:
delete_timecard - Route:
DELETE /v2/labor/timecards/{id} - Mode: WRITE
- Summary: DeleteTimecard
- Parameters:
idinpathrequired
retrieve_timecard
- Operation ID:
retrieve_timecard - Route:
GET /v2/labor/timecards/{id} - Mode: READ
- Summary: RetrieveTimecard
- Parameters:
idinpathrequired
update_timecard
- Operation ID:
update_timecard - Route:
PUT /v2/labor/timecards/{id} - Mode: WRITE
- Summary: UpdateTimecard
- Parameters:
idinpathrequired
- Body: JSON request body accepted.
list_workweek_configs
- Operation ID:
list_workweek_configs - Route:
GET /v2/labor/workweek-configs - Mode: READ
- Summary: ListWorkweekConfigs
- Parameters:
limitinquerycursorinquery
update_workweek_config
- Operation ID:
update_workweek_config - Route:
PUT /v2/labor/workweek-configs/{id} - Mode: WRITE
- Summary: UpdateWorkweekConfig
- Parameters:
idinpathrequired
- Body: JSON request body accepted.