v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Work Assignments

Update a work assignment

put/work_assignments/{work_assignment}

Path parameters

work_assignmentstring required

Request body

pay_split_idstring
is_primaryboolean

When true, the standard tax reductions are applied to this work assignment's Pay Stubs. Only one work assignment per Employee per Business Entity may be primary. If none is explicitly set to primary, the earliest work assignment is treated as primary.

titlestring nullable

An optional label for this work assignment, used to distinguish between multiple work assignments for the same Employee or Contractor.

archived_atstring date

The date the work assignment was archived. Archiving ends the work assignment's participation in future Payrolls. The archive date must not fall before any active Pay Rate's effective period.

external_refstring

Response

OK

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("work_assignment").