Create an employee

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.

The employee's first name.

The employee's last name.

The employee's middle initial.

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

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

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

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

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

Up to 30 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

The city of the employee's mailing address.

Up to 28 characters when the address's country_code is CA or empty. Up to 255 characters for any other country.

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.

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

The country code for the employee's mailing address.

The postal code for the employee's mailing address.

The employee's Social Insurance Number (SIN), used for tax reporting. 9 digits, sent as a string. Spaces and dashes are stripped before validation. The first digit cannot be 0 or 8, and the number must pass the Luhn checksum. Required before year-end forms can be filed correctly, but not required to create the employee or run a payroll.

The employee's date of birth.

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

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.

The unique identifier of the object in Nmbr.

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