curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/work_assignments/bulk/create/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"pay_schedule_id": "<id>"
},
"payees": {
"include": {
"ids": [
"<id>"
]
}
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "employee",
"data": {
"company": {
"id": "<id>",
"object": "company",
"links": {
"self": "/companies/<id>"
}
},
"employee_number": "001",
"first_name": "Marley",
"last_name": "Prosacco",
"middle_initial": null,
"personal_email": "marley.prosacco@personal.test",
"work_email": "mprosacco@work.test",
"address_line_1": "Angelina Ridge",
"address_line_2": null,
"city": "Toronto",
"province_code": "ON",
"country_code": "CA",
"postal_code": "M1M1M1",
"sin": "196710156",
"sin_last_3": "156",
"date_of_birth": "1985-01-20",
"warnings": {
"object": "list",
"data": [
{
"object": "warning",
"data": {
"namespace": "onboarding",
"type": "bank_account_doesnt_exists"
}
}
]
},
"external_ref": null,
"preferred_locale": null,
"archived_at": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/employees/<id>"
}
}
]
}Show bulk create scope for work assignments
curl --request POST \
--url https://sandbox.nmbr.co/services/payroll/work_assignments/bulk/create/scope \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"pay_schedule_id": "<id>"
},
"payees": {
"include": {
"ids": [
"<id>"
]
}
}
}
'{
"object": "list",
"data": [
{
"id": "<id>",
"object": "employee",
"data": {
"company": {
"id": "<id>",
"object": "company",
"links": {
"self": "/companies/<id>"
}
},
"employee_number": "001",
"first_name": "Marley",
"last_name": "Prosacco",
"middle_initial": null,
"personal_email": "marley.prosacco@personal.test",
"work_email": "mprosacco@work.test",
"address_line_1": "Angelina Ridge",
"address_line_2": null,
"city": "Toronto",
"province_code": "ON",
"country_code": "CA",
"postal_code": "M1M1M1",
"sin": "196710156",
"sin_last_3": "156",
"date_of_birth": "1985-01-20",
"warnings": {
"object": "list",
"data": [
{
"object": "warning",
"data": {
"namespace": "onboarding",
"type": "bank_account_doesnt_exists"
}
}
]
},
"external_ref": null,
"preferred_locale": null,
"archived_at": null,
"created_at": "2026-01-01T00:00:00.000000Z",
"updated_at": "2026-01-01T00:00:00.000000Z"
},
"links": {
"self": "/employees/<id>"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Must be present when payees.include.payee_type, payees.include.payee_names and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_names and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_type and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_type and payees.include.payee_names is either empty or not set.
Hide child attributes
Hide child attributes
Must be present when payees.include.payee_type, payees.include.payee_names and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_names and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_type and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_type and payees.include.payee_names is either empty or not set.
Hide child attributes
Hide child attributes
Must be present when payees.include.payee_type, payees.include.payee_names and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_names and payees.include.archived is either empty or not set.
contractor, employee Must be present when payees.include.ids, payees.include.payee_type and payees.include.archived is either empty or not set.
Must be present when payees.include.ids, payees.include.payee_type and payees.include.payee_names is either empty or not set.
Response
OK
The type of the object in Nmbr ("list").
Hide child attributes
Hide child attributes
The unique identifier of the object in Nmbr.
The type of the object in Nmbr ("employee").
Hide child attributes
Hide child attributes
An optional label for this work assignment, used to distinguish between multiple work assignments for the same Employee or Contractor.
255The 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.
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.
This attribute is deprecated and will be removed.
This attribute is deprecated and will be removed.
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.
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.
A list of Tax Property template identifiers supported for this work assignment, based on its jurisdiction.
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.
255The 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.
The date and time the object was created in Nmbr.
The date and time the object was last updated in Nmbr.