EmployeeHire

POST

Add Employee

Add a new employee.

 

{
  "approvalStatus":"A#F#I#AF",
  "alternateId":"string",
  "name":{
    "lastName":"string",
    "firstName":"string",
    "middleName":"string",
    "formOfAddress":"string",
    "suffix":"string"
  },
  "biographicalInfo":{
    "gender":"M#F",
    "ethnicity":"string",
    "militaryStatus":"string",
    "maritalStatus":"string",
    "birthDate":"YYYY-MM-DD",
    "nationalId":"string"
  },
  "homeContact":{
    "address1":"string",
    "address2":"string",
    "address3":"string",
    "address4":"string",
    "city":"string",
    "county":"string",
    "state":"string",
    "postalCode":"string",
    "country":"string",
    "phone":"string",
    "email":"string"
  },
  "employmentInfo":{
    "startDate":"YYYY-MM-DD",
    "seniorityDate":"YYYY-MM-DD",
    "reasonCode":"PLV#ULV#HIR#REH",
    "employeeType":"F#P",
    "regularTemporary":"R#T",
    "employeeClass":" #D",
    "standardHoursPerWeek":"number",
    "tipped":"string",
    "businessTitle":"string",
    "supervisorId":"string",
    "homeDepartment":{
      "deptId":"string"
    },
    "deptSplitFlag":"boolean",
    "deptSplit":[
      {
        "deptId":"string",
        "percentage":"string"
      }
    ],
    "locationId":"string",
    "payGroupId":"string",
    "workEmail":"string",
    "customGroupA":"string",
    "customGroupB":"string",
    "compliance":{
      "jobCode":"string",
      "flsaCode":"C#Z#T#N",
      "workersCompCode":"string",
      "workersCompState":"string",
      "jobDuties":"string"
    }
  },
  "payInfo":{
    "compFrequency":"A#H",
    "compRate":"number",
    "estimatedAnnualWages":"number"
  },
  "trustedAdvisor":{
    "effectiveDate":"YYYY-MM-DD",
    "userRole":"string",
    "lastHire":"boolean"
  },
  "timeOffAndBenefits":{
    "benefitClass":{
      "benefitClassId":"string",
      "futureBenefitClassId":"string"
    },
    "leavePlanCodes":{
      "vacationPTO":"string",
      "sick":"string",
      "personalTime":"string",
      "floatingHolidays":"string"
    }
  }
}

Section

Field

Req

Description

 

approvalStatus

Y

Status indicates the workflow after successful submit ion. Valid values are:

I – Incomplete – the employee information is incomplete and saved in a staging table. Notification email will also be sent to all employees with HR Authorizer role indicating that additional steps are required to complete the new hire process.

F – Final – All required employee information is entered and Employee is automatically added to TriNet Platform.

A – Approval needed – All required employee information is entered but the action required approval from HR Authorized. Record is placed on appropriate approval queue.

AF – Indicates that employee was approve HR authorizer.

 

alternateId

N

Alternate employee ID, if your company uses different employee IDs

Name

lastName

Y

Last name

Name

firstName

Y

First name

Name

middleName

N

Middle name

Name

formOfAddress

N

Title

Values: <Mr, Mrs…>

Name

suffix

N

Suffix

Values: <Jr, Sr…>

Currently not supported. For future use.

biographicalInfo

gender

NF

Values M, F

biographicalInfo

ethnicity

NF

Ethnicity for EEOC reporting

Values

biographicalInfo

militaryStatus

N

Military status

Values

biographicalInfo

maritalStatus

N

Marital Status

Values

Currently not supported. For future use.

biographicalInfo

birthDate

NF

Date of birth

biographicalInfo

nationalId

N

SSN or SID, Required for Canada.

homeContact

address1

NF

Address line 1

homeContact

address2

N

Address line 2

homeContact

address3

N

Address line 3

Currently not supported. For future use.

homeContact

address4

N

Address line 4

Currently not supported. For future use.

homeContact

city

NF

City

homeContact

county

N

County

homeContact

state

NF

State/Province code

homeContact

postalCode

NF

ZIP or postal code

homeContact

country

Y

Country

homeContact

phone

N

Personal phone number

homeContact

email

N

Personal email address

employmentInfo

startDate

Y

Employee agreed hire date

employmentInfo

seniorityDate

N

Employee agreed seniority date

employmentInfo

reasonCode

NF

Whether the employee is a new hire or rehire

Values:

PLV - Hire on Paid Leave

ULV - Hire on Unpaid Leave

HIR - New Hire

REH - ReHire

employmentInfo

employeeType

NF

Employment type

Values: F – full time, P – part time

employmentInfo

regularTemporary

NF

Whether employee is R- regular or T – temporary

employmentInfo

employeeClass

NF

Employee (space) or Commission (“D”)

employmentInfo

standardHoursPerWeek

NF

Number of hours a week employee is required to work

employmentInfo

tipped

N

 

employmentInfo

businessTitle

N

Business title

employmentInfo

supervisorId

N

Employee Id of the supervisor

employmentInfo.homeDepartment

deptId

NF

Department Id. Validated against the list of Company’s departments.

employmentInfo

deptSplitFlag

N

Whether the department split is needed.

employmentInfo. deptSplit

deptId

N

Department Id. Validated against the list of Company’s departments.

employmentInfo. deptSplit

percentage

N

Percentage employee works in the department

employmentInfo

locationId

NF

Location Id. Validated against the list of Company’s locations

employmentInfo

payGroupId

NF

Pay group Id. Validated against the list of Company’s Pay groups

employmentInfo

workEmail

NF

Employee’s work email address

employmentInfo

customGroupA

N

Group A-Used to store company-specific information

employmentInfo

customGroupB

N

Group B-Used to store company-specific information

employmentInfo. compliance

jobCode

NF

Job code or category used for EEO reporting

employmentInfo. compliance

flsaCode

NF

Fair Labor Standards Act (FLSA) code

Whether the employee is exempt or nonexempt

Values

employmentInfo. compliance

workersCompCode

N

Workers’ compensation code

employmentInfo. compliance

workersCompState

N

State for workers’ compensation

employmentInfo. compliance

jobDuties

N

Job duties description (worker’s compensation)

payInfo

compFrequency

NF

Compensation frequency: A – Annual, H – Hourly

payInfo

compRate

NF

Compensation Rate

payInfo

estimatedAnnualWages

N

 

trustedAdvisor

effectiveDate

N

Currently not supported. For future use.

trustedAdvisor

userRole

N

Currently not supported. For future use.

trustedAdvisor

lastHire

N

Currently not supported. For future use.

timeOffAndBenefits. benefitClass

benefitClassId

NF

Benefits group ID

timeOffAndBenefits. benefitClass

futureBenefitClassId

N

Benefits group ID – needed if employee is hired during open enrollment period

timeOffAndBenefits. leavePlanCodes

vacationPTO

N

Vacation/PTO  plan type

timeOffAndBenefits. leavePlanCodes

sick

N

Sick plan type

timeOffAndBenefits. leavePlanCodes

personalTime

N

Personal time plan type

timeOffAndBenefits. leavePlanCodes

floatingHolidays

N

Floating holidays plan type

 

F – required for Final and Approval Needed statuses

 

Resource URL

https://api.trinet.com /{version}/hire/{company}/employees

Body Parameters


Name Values Description
body
(required)

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security:

Content Type:

application/json

Scope:

hr-new-hire-write

Working...