Search work assignments

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/work_assignments/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "work_assignments": {
    "include": "all"
  }
}
'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "work_assignment",
      "data": {
        "title": null,
        "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>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/work_assignments/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "last": "http://localhost/work_assignments/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

POST

work_assignments

curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/work_assignments/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_entity_id": "<id>",
  "work_assignments": {
    "include": "all"
  }
}
'

{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "work_assignment",
      "data": {
        "title": null,
        "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>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/work_assignments/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "last": "http://localhost/work_assignments/search?business_entity_id=<id>&work_assignments%5Binclude%5D=all&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

business_entity_id

string

required

The business entity whose work assignments to search.

work_assignments

object

required

The selection criteria.

work_assignments.include must be either the string "all", or an object containing one or more of ids (string array), payee_type (employee or contractor), pay_schedule_id, archived (boolean).

work_assignments.exclude (optional) is an object containing one or more of the same keys.

Hide child attributes

work_assignments.exclude

object

Hide child attributes

work_assignments.exclude.ids

string[]

work_assignments.exclude.payee_type

enum<string>

Available options:

contractor,

employee

work_assignments.exclude.pay_schedule_id

string

work_assignments.exclude.archived

boolean

work_assignments.exclude.payee_names

string

Response

200 - application/json

object

string

read-only

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

data

object[]

Hide child attributes

data.id

string

read-only

The unique identifier of the object in Nmbr.

data.object

string

read-only

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

data.data

Work Assignment · object

Hide child attributes

data.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.data.employee

object

Hide child attributes

data.data.employee.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.employee.object

string

read-only

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

data.data.pay_schedule

object

Hide child attributes

data.data.pay_schedule.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.pay_schedule.object

string

read-only

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

data.data.business_entity

object

Hide child attributes

data.data.business_entity.id

string

read-only

The unique identifier of the object in Nmbr.

data.data.business_entity.object

string

read-only

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

data.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.data.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.

data.data.accrued_vacation_pay

number<decimal>

deprecated

This attribute is deprecated and will be removed.

data.data.paid_vacation_pay

number<decimal>

deprecated

This attribute is deprecated and will be removed.

data.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.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.data.available_tax_properties

string[] | null

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

data.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.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.data.created_at

string<dateTime>

read-only

The date and time the object was created in Nmbr.

data.data.updated_at

string<dateTime>

read-only

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

Terminate a work assignment Batch upsert work assignments

⌘I