v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Work Assignments

Create a work assignment

post/work_assignments

Request body

employee_idstring

Must be present when contractor_id is either empty or not set.

contractor_idstring

Must be present when employee_id is either empty or not set.

pay_schedule_idstring required
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

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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