Create an Employee

post

https://integrate.nayya.com/accounts/employers/{employerId}/employees

Path Params

employerId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employer (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

Body Params

externalId

string

A unique identifier from the partner's system, used to map employee records between the partner's system and Nayya.

employerProvidedId

string

An employer-specific identifier for an employee, unique within a single employer but not across the entire partner system.

lastName

string

required

Employee last name

firstName

string

required

Employee first name

string

required

Employee email

streetAddress

string

Employee street address

city

string

Employee city

state

string

Employee state

zipCode

string

Employee zip code

gender

string

enum

Employee gender

Allowed:

sexAssignedAtBirth

string

enum

Employee sex assigned at birth

Allowed:

startDate

date

Employee start date

dateOfBirth

date

required

Employee date of birth

terminatedDate

date

Employee terminated date

phoneNumber

string

Employee phone number

ssn

string

Employee SSN (9 digits)

incomeAmountCents

number

Employee income amount in cents

additionalIncomeAmountCents

number

Employee additional income amount in cents

incomeType

string

enum

Employee income type

Allowed:

locale

string

enum

Employee locale

Allowed:

employmentType

string

enum

Employee employment type

Allowed:

employmentSubType

string

enum

Employee employment sub type

Allowed:

ethnicity

string

Employee ethnicity

tobaccoUsage

boolean

Employee tobacco usage

hoursPerWeek

number

Employee hours worked per week

customAttributes

object

Employee custom attributes

Headers

X-API-Version

string

Defaults to 1

Optional API major version. Omit this header for the same behavior as 1 (this specification).

Responses

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

201Created