v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Employees

Create an employee

post/employees

Request body

employee_numberstring nullable

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.

first_namestring required

The employee's first name.

last_namestring required

The employee's last name.

middle_initialstring nullable

The employee's middle initial.

personal_emailstring

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

work_emailstring

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

address_line_1string nullable

The first line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.

address_line_2string nullable

The second line of the employee's mailing address. Canada Revenue Agency forms (T4, RL-1) truncate this to the length those forms allow.

citystring nullable

The city of the employee's mailing address.

administrative_areastring nullable

The region of the employee's mailing address — the province, state, or county, depending on the country. For Canadian employees 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.

province_codestring nullable

This attribute is deprecated and will be removed.

A deprecated alias of administrative_area that mirrors its value. Use administrative_area instead.

In Canada, must be an uppercase 2-letter province code: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT

country_code'CA' | 'GB'

The country code for the employee's mailing address.

postal_codestring nullable

The postal code for the employee's mailing address.

sinstring

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

date_of_birthstring date

The employee's date of birth.

external_refstring
preferred_locale'en' | 'fr'

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.

archived_atstring 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

Created

idstring

The unique identifier of the object in Nmbr.

objectstring

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