Update an employee

Authorizations

Authorization

string

header

required

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

Path Parameters

employee

string

required

Body

application/json

employee_number

string | null

An optional identifier for the employee within the partner's system, such as a badge number or HR system ID. Distinct from id and external_ref.

Maximum string length: 40

first_name

string

The employee's first name.

Maximum string length: 50

last_name

string

The employee's last name.

Maximum string length: 50

middle_initial

string | null

The employee's middle initial.

Maximum string length: 1

personal_email

string | null

The employee's personal email address, used as the primary address for payroll communications such as Pay Stub emails.

work_email

string | null

The employee's work email address. Used for payroll communications if personal_email is not set.

address_line_1

string | null

The first line of the employee's mailing address. This character limit (30) is set by government reporting requirements, not application-level validation.

Maximum string length: 30

address_line_2

string | null

The second line of the employee's mailing address. This character limit (30) is set by government reporting requirements, not application-level validation.

Maximum string length: 30

city

string | null

The city of the employee's mailing address.

Maximum string length: 28

province_code

enum<string>

The province code for the employee's mailing address. This is the Province of Residence (POR), not the Province of Employment (POE) or Province of Work (POW). POE and POW are configured via the Work Assignment's Tax Properties.

Available options:

AB,

BC,

MB,

NB,

NL,

NS,

NT,

NU,

ON,

PE,

QC,

SK,

YT

country_code

enum<string>

The country code for the employee's mailing address.

Available options:

CA

postal_code

string | null

The postal code for the employee's mailing address.

Maximum string length: 10

sin

string

The employee's Social Insurance Number (SIN), used for tax reporting.

date_of_birth

string<date>

The employee's date of birth.

external_ref

string

Maximum string length: 255

preferred_locale

enum<string>

The locale used for payroll communications sent to this employee, such as Pay Stub emails. If not set, the Business Entity's locale is used.

Available options:

en,

fr

archived_at

string<date>

The date the employee was archived. Archiving an employee also archives all Work Assignments that are not already archived. Archived employees do not appear in active listings.

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 ("employee").

data

Employee · object

Hide child attributes

data.company

object

Hide child attributes

data.company.id

string

read-only

The unique identifier of the object in Nmbr.

data.company.object

string

read-only

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

data.employee_number

string | null

An optional identifier for the employee within the partner's system, such as a badge number or HR system ID. Distinct from id and external_ref.

Maximum string length: 40

data.first_name

string

The employee's first name.

Maximum string length: 50

data.last_name

string

The employee's last name.

Maximum string length: 50

data.middle_initial

string | null

The employee's middle initial.

Maximum string length: 1

data.personal_email

string | null

The employee's personal email address, used as the primary address for payroll communications such as Pay Stub emails.

Maximum string length: 255

data.work_email

string | null

The employee's work email address. Used for payroll communications if personal_email is not set.

Maximum string length: 255

data.address_line_1

string | null

The first line of the employee's mailing address. This character limit (30) is set by government reporting requirements, not application-level validation.

Maximum string length: 255

data.address_line_2

string | null

The second line of the employee's mailing address. This character limit (30) is set by government reporting requirements, not application-level validation.

Maximum string length: 30

data.city

string | null

The city of the employee's mailing address.

Maximum string length: 255

data.province_code

enum<string> | null

Available options:

AB,

BC,

FEDERAL,

MB,

NB,

NL,

NS,

NT,

NU,

OC,

ON,

PE,

QC,

SK,

YT

Maximum string length: 3

data.country_code

enum<string> | null

The country code for the employee's mailing address.

Available options:

CA

Maximum string length: 2

data.postal_code

string | null

The postal code for the employee's mailing address.

Maximum string length: 10

data.sin

string | null

deprecated

This attribute is deprecated and will be removed.

The employee's Social Insurance Number (SIN), used for tax reporting.

If you only need the last 3 digits for display purposes, use sin_last_3 instead. If you need the complete SIN, use the /employees/:id/reveal endpoint instead. Note the /reveal endpoint can only reveal one employee at a time and is rate-limited for security reasons.

data.sin_last_3

string | null

The last 3 digits of the employee's Social Insurance Number (SIN). null if no SIN has been provided.

data.date_of_birth

string<date> | null

The employee's date of birth.

data.warnings

object

A collection of data validation warnings for this employee. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing.

Hide child attributes

data.warnings.object

string | null

data.warnings.data

object[] | null

Hide child attributes

data.warnings.data.object

string | null

data.warnings.data.data

object

Hide child attributes

data.warnings.data.data.namespace

string | null

data.warnings.data.data.type

string | null

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

enum<string> | null

The locale used for payroll communications sent to this employee, such as Pay Stub emails. If not set, the Business Entity's locale is used.

Available options:

en,

fr

data.archived_at

string<dateTime> | null

read-only

The date the employee was archived. Archiving an employee also archives all Work Assignments that are not already archived. Archived employees do not appear in active listings.

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.