Update a work assignment

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/work_assignments/{work_assignment} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "New title"
}
'

{
  "id": "<id>",
  "object": "work_assignment",
  "data": {
    "title": "New title",
    "employee": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "pay_schedule": {
      "id": "<id>",
      "object": "pay_schedule",
      "links": {
        "self": "/pay_schedules/<id>"
      }
    },
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "current_tax_jurisdiction": "ca_on",
    "is_primary": true,
    "accrued_vacation_pay": 0,
    "paid_vacation_pay": 0,
    "first_non_draft_period_start": null,
    "last_non_draft_period_end": null,
    "available_tax_properties": [
      "ca::province_of_employment",
      "ca::province_of_work",
      "ca::federal_oc_surtax_exempt",
      "ca::cpp_exempt",
      "ca::ei_exempt",
      "ca::qc::qpp_exempt",
      "ca::qc::qpip_exempt",
      "ca::nt::territorial_payroll_tax",
      "ca::nu::territorial_payroll_tax",
      "ca::federal::additional_tax",
      "ca::federal::claim_amount",
      "ca::federal::total_income_less_than_total_claim_amount",
      "ca::federal::annual_deduction_at_source",
      "ca::statutory_holiday_pay",
      "ca::first_nation_exemptions",
      "ca::ab::workers_compensation_class",
      "ca::bc::workers_compensation_class",
      "ca::mb::workers_compensation_class",
      "ca::nb::workers_compensation_class",
      "ca::nl::workers_compensation_class",
      "ca::ns::workers_compensation_class",
      "ca::nt::workers_compensation_class",
      "ca::nu::workers_compensation_class",
      "ca::on::workers_compensation_class",
      "ca::pe::workers_compensation_class",
      "ca::qc::workers_compensation_class",
      "ca::sk::workers_compensation_class",
      "ca::yt::workers_compensation_class",
      "ca::on::claim_amount",
      "ca::on::dependent_children_credit",
      "ca::on::impaired_dependants_credit"
    ],
    "external_ref": null,
    "archived_at": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/work_assignments/<id>"
  }
}

PUT

work_assignments

{work_assignment}

Update a work assignment

curl --request PUT \
  --url https://sandbox.nmbr.co/services/payroll/work_assignments/{work_assignment} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "New title"
}
'

{
  "id": "<id>",
  "object": "work_assignment",
  "data": {
    "title": "New title",
    "employee": {
      "id": "<id>",
      "object": "employee",
      "links": {
        "self": "/employees/<id>"
      }
    },
    "pay_schedule": {
      "id": "<id>",
      "object": "pay_schedule",
      "links": {
        "self": "/pay_schedules/<id>"
      }
    },
    "business_entity": {
      "id": "<id>",
      "object": "business_entity",
      "links": {
        "self": "/business_entities/<id>"
      }
    },
    "current_tax_jurisdiction": "ca_on",
    "is_primary": true,
    "accrued_vacation_pay": 0,
    "paid_vacation_pay": 0,
    "first_non_draft_period_start": null,
    "last_non_draft_period_end": null,
    "available_tax_properties": [
      "ca::province_of_employment",
      "ca::province_of_work",
      "ca::federal_oc_surtax_exempt",
      "ca::cpp_exempt",
      "ca::ei_exempt",
      "ca::qc::qpp_exempt",
      "ca::qc::qpip_exempt",
      "ca::nt::territorial_payroll_tax",
      "ca::nu::territorial_payroll_tax",
      "ca::federal::additional_tax",
      "ca::federal::claim_amount",
      "ca::federal::total_income_less_than_total_claim_amount",
      "ca::federal::annual_deduction_at_source",
      "ca::statutory_holiday_pay",
      "ca::first_nation_exemptions",
      "ca::ab::workers_compensation_class",
      "ca::bc::workers_compensation_class",
      "ca::mb::workers_compensation_class",
      "ca::nb::workers_compensation_class",
      "ca::nl::workers_compensation_class",
      "ca::ns::workers_compensation_class",
      "ca::nt::workers_compensation_class",
      "ca::nu::workers_compensation_class",
      "ca::on::workers_compensation_class",
      "ca::pe::workers_compensation_class",
      "ca::qc::workers_compensation_class",
      "ca::sk::workers_compensation_class",
      "ca::yt::workers_compensation_class",
      "ca::on::claim_amount",
      "ca::on::dependent_children_credit",
      "ca::on::impaired_dependants_credit"
    ],
    "external_ref": null,
    "archived_at": null,
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  },
  "links": {
    "self": "/work_assignments/<id>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

work_assignment

string

required

Body

application/json

pay_split_id

string

is_primary

boolean

When true, standard tax credits 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.

title

string | null

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

Maximum string length: 255

archived_at

string<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_ref

string

Maximum string length: 255

tag_assignment

object

Hide child attributes

tag_assignment.unit

enum<string>

Available options:

percentage

tag_assignment.is_component_locked

boolean

tag_assignment.tag_allocations

object[]

Hide child attributes

tag_assignment.tag_allocations.tags

string[]

tag_assignment.tag_allocations.value

number<decimal>

Required range: x >= 0

tag_assignment_patch

object

Additive changes to the existing tag assignment, as an alternative to replacing it with tag_assignment. The two keys are mutually exclusive.

tag_assignment_patch.add_tags — Tag IDs to add to every existing allocation. Adding a tag replaces any other tag from the same tag group on that allocation.

tag_assignment_patch.remove_tags — Tag IDs to remove from every existing allocation. An allocation left with no tags is deleted; the distribution strategy decides what happens to its value.

tag_assignment_patch.distribution_strategy (optional) — Governs the value of allocations deleted by remove_tags. Defaults to reallocate when omitted. Accepted values: reallocate (spread the deleted value proportionally across the remaining allocations), unallocated (drop the value; the assignment's allocations will sum to less than before), error (refuse the patch if any allocation would be deleted).

Hide child attributes

tag_assignment_patch.add_tags

string[]

tag_assignment_patch.remove_tags

string[]

tag_assignment_patch.distribution_strategy

enum<string>

Available options:

error,

reallocate,

unallocated

Response

200 - application/json

string

read-only

The unique identifier of the object in Nmbr.

object

string

read-only

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

data

Work Assignment · object

Hide child attributes

data.title

string | null

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

Maximum string length: 255

data.employee

object

Hide child attributes

data.employee.id

string

read-only

The unique identifier of the object in Nmbr.

data.employee.object

string

read-only

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

data.pay_schedule

object

Hide child attributes

data.pay_schedule.id

string

read-only

The unique identifier of the object in Nmbr.

data.pay_schedule.object

string

read-only

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

data.business_entity

object

Hide child attributes

data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.business_entity.object

string

read-only

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

data.current_tax_jurisdiction

string | null

The current Province of Employment (POE) for the work assignment, derived from the ca::province_of_employment Tax Property on the work assignment or, if none is set, from the Business Entity.

data.is_primary

boolean

data.accrued_vacation_pay

number<decimal>

deprecated

This attribute is deprecated and will be removed.

data.paid_vacation_pay

number<decimal>

deprecated

This attribute is deprecated and will be removed.

data.first_non_draft_period_start

string<date> | null

The start of the first pay period for which this work assignment has a non-draft Payroll. null if the work assignment has never appeared on an approved or paid Payroll.

data.last_non_draft_period_end

string<date> | null

The end of the most recent pay period for which this work assignment has a non-draft Payroll. null if the work assignment has never appeared on an approved or paid Payroll.

data.available_tax_properties

string[] | null

A list of Tax Property template identifiers supported for this work assignment, based on its jurisdiction.

data.external_ref

string | null

A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference.

Maximum string length: 255

data.archived_at

string<dateTime> | null

read-only

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.

data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.updated_at

string<dateTime>

read-only

The date and time the object was last updated in Nmbr.

Retrieve a work assignment Delete a work assignment

⌘I