Update Employee

patch

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

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

employeeId

string

required

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

Body Params

externalId

string | null

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

employerProvidedId

string | null

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

lastName

string | null

Employee last name

firstName

string | null

Employee first name

string

Employee email

streetAddress

string | null

Employee street address

city

string | null

Employee city

state

string | null

Employee state

zipCode

string | null

Employee zip code

gender

string | null

enum

Employee gender

Allowed:

sexAssignedAtBirth

string | null

enum

Employee sex assigned at birth

Allowed:

dateOfBirth

date | null

Employee date of birth

startDate

date | null

Employee start date

terminatedDate

date | null

Employee terminated date

phoneNumber

string | null

Employee phone number

ssn

string | null

Employee SSN (9 digits)

incomeAmountCents

number | null

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:

tobaccoUsage

boolean | null

Employee tobacco usage

hoursPerWeek

number | null

Employee hours worked per week

ethnicity

string | null

Employee ethnicity

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

200Ok