ContractJobs

Replaces the updatable fields of a contract job (BF-7467).

Full replace: send all 15 fields. The 11 non-nullable ones are required - a missing one is a 400 naming it. overtimeRuleId, firstWeekEndingDate, workersCompCodeId and burdenManual may be null or absent, which clears them. Other keys are ignored, so a GET response can be sent back. To change only some fields, use PATCH. statusId and endDate are never written; to end a job use POST /terminate. clientId and contractorId cannot be changed on an existing job: send the stored values. Rules on the resulting job are enforced only for fields that change. addressId and stateId set the worksite: leave them out to keep it, send null to clear the address (a state cannot be cleared), or a number to set it. A new address must be an active address of the job's client and gives the job its state.

put/v{version}/ContractJobs/{jobId}

Path parameters

jobIdinteger required

Job to update. Addresses the resource; any jobId in the body is ignored.

versionstring required

Headers

company-idstring required

Request body

companyIdstring uuid
jobIdinteger
clientIdinteger nullable
contractorIdinteger nullable
contractorTypeId1 | 2
timeCardMethodId1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11
overtimeRuleIdinteger nullable
jobTitlestring nullable
startDatestring date-time nullable
firstWeekEndingDatestring date-time nullable
isPerDiemEnabledboolean nullable
isSickTimeEnabledboolean nullable
isExpensesEnabledboolean nullable
isWaiveMealPeriodboolean nullable
isAllowSkipLunchboolean nullable
workersCompCodeIdinteger nullable
burdenManualnumber double nullable

Response

Success

isValidboolean
errorsstring[] nullable
warningsstring[] nullable
infostring[] nullable
messagestring nullable
datainteger

Changes

No recorded changes to this endpoint across all 8 revisions of this API.