Skip to navigation
Employee

Update Job

Update a job record.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

employeeUuidstringRequired

User id of the employee (not a UUID)

engagementUuidstringRequiredformat: "uuid"
UUID of the engagement
jobUuidstringRequiredformat: "uuid"
UUID of the job to update

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Request

This endpoint expects an object.
jobDetailsobjectRequired

Job details. Replaced as a whole, so send every field; missing ones, including the approvers, are cleared.

customerUuidstringOptionalformat: "uuid"
Customer UUID
enableLeavebooleanOptional
enableExpensesbooleanOptional
payFrequencystringOptional
timesheetTypestringOptional
timesheetEnablebooleanOptional
Send the current value with every update. If the job has submitted timesheets, an update that leaves it out or sets it to false is rejected.
fixedPayItemsbooleanOptional
timesheetLengthstringOptional
variableTimesheetbooleanOptional
splitShiftsbooleanOptional
timesheetForPayrollbooleanOptional
timesheetStartstringOptional

Timesheet start day, 0 (Monday) to 6 (Sunday), or 1 to 31 for monthly timesheets. Send the current value with every update; if it is missing it is reset to 0.

rateCardstringOptional
ruleGroupstringOptional
companyUuidstringOptionalformat: "uuid"
Payroll company UUID for the job. Must be an existing company.
billingGroupUuidstringOptionalformat: "uuid"
glGroupUuidstringOptionalformat: "uuid"

Response

Job updated successfully
idstringOptionalformat: "uuid"
UUID of the job
affectedintegerOptional
eventJobIdstringOptional

Errors

400
Bad Request Error
404
Not Found Error