basic-read

Method
Description

GET

Profile Photos

https://api.trinet.com/{version}/profile/{companyId}/{employeeId}/photos

GET

Profile Photo By ID

https://api.trinet.com/{version}/profile/{companyId}/{employeeId}/photos/{photoId}

GET

Holidays by Schedule

https://api.trinet.com/{version}/company/{company}/holidays/{schedule}

Response Template Field Information { "schedule":"string", "date":"datetime", "desc":"number", "hours":"number" }  

GET

Time Off Calendar

https://api.trinet.com/{version}/timeoff/{companyId}/timeoff-calendar

Retrieve employee Time Off information for a specified period of time..   Response Template Field Information { "employeeId":"string", "name":{ "lastName":"string", "middleName":"string", "firstName":"string" }, "timeOff":[ { "type":"string", "date":"YYYY-MM-DD", "hours":"number", "status":"string" } ] }     Field Description    employeeId Employee Id    name         lastName Last Name       middleName Middle Name       firstName First Name    timeOff            type Time Off Type           date Time Off Date          hours Time Off Hours          status Time Off Status

GET

Company

https://api.trinet.com/{version}/manage-company/{company}/org-details

Retrieve basic company information.   Basic View All View Field Information { "companyId":"string", "parentClientId":"string", "companyName":"string", "legalName":"string", "liveDate":"datetime" } { "companyId": "string", "companyName": "string", "legalName": "string", "liveDate": "datetime", "pfCorp": "string", "planStartDate": "datetime", "pfClentEIN": "number", "clientType": "string", "terminationDate": "datetime", "naics": "string", "naicsDescr": "string", "peoId": "string", "timezone": "ET#CT#MT#PT", "referrer": "string", "setupDate": "datetime", "address1": "string", "address2": "string", "city": "string", "country": "string", "postalCode": "string", "state": "string", "email": "string", "fax": "string", "phone": "string", "medicalPlan": "string", "openEnrollmentQuarter": "string", "acaLargeEmployer": "boolean", "paymentMethod": "string", "industry": "string", "clientNumber": "string", "verticalCode": "string", "verticalDescr": "string", "wcCoverageOption": "string", "ficaFuta": "string", "suta": "boolean", "productLine": "string", "productLineDescr": "string", "eeoGovContractor": "string", "parentClientId": "string" } Field Description companyId Unique ID for your company parentClientId Please ignore—field used by TriNet only companyName Company name legalName Company legal name liveDate Date company started with TriNet

GET

Company Support Contacts

https://api.trinet.com/{version}/manage-company/{company}/support-contacts

Response Template Field Information { "contactType":"Payroll Coordinator#Managing Director#HR Manager#Implementation Consultant#Benefits Consultant", "contactName":"string", "phoneNumber":"string", "email":"string" }  

GET

Supervisors

https://api.trinet.com/{version}/company/{companyId}/supervisors

Response Template Field Information { "employeeId":"string", "frirstName":"string", "lastName":"string", "middleName": "string" }  

GET

Company Contacts

https://api.trinet.com/{version}/manage-company/{company}/company-contacts

Response Template Field Information { "effectiveDate":"datetime", "employeeId":"string", "name":"string", "businessTitle":"string", "contactType":"FIN#I9#INV#PAM#PHR#PRC#TDM", "contactMethod":"email#fax#phone", "notificationTemplate":"string", "email":"string", "phoneNumber":"string" }  

GET

Work Profile

https://api.trinet.com/{version}/identity/{company}/{employeeId}/work-profiles

Retrieve basic employee job information.   Response Template Field Information { "employeeId":"string", "businessTitle":"string", "deptId":"string", "effectiveDate":"datetime", "employeeStatus":"A#D#L#P#S#T#U", "employeeType":"string", "jobCode":"string", "locationId":"string", "supervisorId":"string", "serviceDate":"datetime", "regularTemporary":"R#T", "workEmail":"string", "workPhone":"string" } Field Description employeeId System assigned TriNet's employee ID businessTitle Business title deptId Department Id effectiveDate Date the information became effective employeeStatus Employment status Values: A (for Active), D (for Deceased), L (for Leave of Absence), P (for Leave with Pay), S (for Suspended), T (for Terminated), U (for Terminated with Pay) employeeType Employee type jobCode Job code or job category for EEOC reporting locationId Location ID supervisorId Manager’s employee Id serviceDate Service date: typically the hire date, can be changed for benefits eligibility or time off accrual regularTemporary Whether the employee is temporary or regular workEmail Work email address workPhone Work phone number

GET

Location

https://api.trinet.com/{version}/company/{company}/locations

Retrieve information about your company’s locations.   Response Template Field Information { "locationId":"string", "locationName":"string", "shortDesc":"string", "locationDeptCount": "number", "locationEmployeeCount": "number", "headquarter":"boolean", "effectiveDate":"datetime", "phone": "string", "officeHours": "string", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state":"string", "postalCode":"string", "county":"string", "country":"string", } } Field Description companyId Unique ID for your company locationId Unique ID for the location locationName Location name shortDesc Location short description locationDeptCount Number of departments in location locationEmployeeCount Number of people in location Headquarter Whether location is the company headquarters effectiveDate Date the information became effective Phone Phone number for location officeHours Office hours for location address   Address1 Address line 1 Address2 Address line 2 Address3 Address line 3 Address4 Address line 4 City City State State or province PostalCode ZIP or postal code County County Country Country Values: CA (for Canada), US (for United States)  

GET

Department

https://api.trinet.com/{version}/company/{company}/departments

Retrieve information about your company’s departments.   Response Template Field Information { "deptId":"string", "deptCode":"string", "deptName":"string", "deptEmployeeCount":"number", "deptLocationCount":"number", "shortDesc":"string", "effectiveDate":"datetime" } Field Description companyId Unique ID for your company deptId Unique ID for the department deptCode Department code deptName Department name deptEmployeeCount Number of employees in the department deptLocationCount Number of locations for each department shortDesc Department short description effectiveDate Date the information became effective

GET

Company Benefit Classes

https://api.trinet.com/{version}/company/{company}/benefit-classes

Response Template Field Information { "benefitClassName" : "string", "benefitClassCode" : "string", "benefitProgram" : "string" , "effectiveDate" : "yyyy-mm-dd" }

GET

Department Split

https://api.trinet.com/{version}/department/{companyId}/{employeeId}/department-split

Retrieve employee department split information.   Response Template Field Information { "employeeId":"string", "departmentSplit": [ { "departmentId":"string", "departmentName":"string" "splitPercentage":"number", "effectiveDate":"datetime" } ] } Field Description employeeId TriNet employee ID departmentId Department Id departmentName Department name splitPercentage Percentage allocation to a department effectiveDate Date the information became effective

GET

Department by ID

https://api.trinet.com/{version}/company/{company}/departments/{departmentId}

Retrieve information about your company’s departments by department ID.   Response Template Field Information { "deptId":"string", "deptCode":"string", "deptName":"string", "deptEmployeeCount":"number", "deptLocationCount":"number", "shortDesc":"string", "effectiveDate":"datetime" } Field Description companyId Unique ID for your company deptId Unique ID for the department deptCode Department code deptName Department name deptEmployeeCount Number of employees in the department deptLocationCount Number of locations for each department shortDesc Department short description effectiveDate Date the information became effective

GET

Location by ID

https://api.trinet.com/{version}/company/{company}/locations/{locationId}

Retrieve information about your company’s locations by location ID.   Response Template Field Information { "locationId":"string", "locationName":"string", "shortDesc":"string", "locationDeptCount": "number", "locationEmployeeCount": "number", "headquarter":"boolean", "effectiveDate":"datetime", "phone": "string", "officeHours": "string", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state":"string", "postalCode":"string", "county":"string", "country":"string" } } Field Description companyId Unique ID for your company locationId Unique ID for the location locationName Location name shortDesc Location short description locationDeptCount Number of departments in location locationEmployeeCount Number of people in location Headquarter Whether location is the company headquarters effectiveDate Date the information became effective Phone Phone number for location officeHours Office hours for location address   Address1 Address line 1 Address2 Address line 2 Address3 Address line 3 Address4 Address line 4 City City State State or province PostalCode ZIP or postal code County County Country Country Values: CA (for Canada), US (for United States)  

GET

Job Details

https://api.trinet.com/{version}/identity/{company}/{employeeId}/employment-details

Retrieve detailed employee job information.   Response Template Field Information { "employeeId":"string", "alternateId":"string", "name":{ "lastName":"string", "middleName":"string", "firstName":"string" }, "employmentInfo":{ "effectiveDate":"datetime", "jobCode":"string", "regularTemporary":"regular#temporary", "employeeType":"fulltime#parttime", "FlsaCode":"string", "employmentStatus":"A#D#L#P#S#T#U", "standardhours":"int", "businessTitle":"string", "serviceDate":"datetime", "terminationDate":"datetime", "supervisor":{ "supervisorId":"string", "supervisorName":"string" }, "workEmail":"string", "workPhone:"string", "customGroupA ":"string", "customGroupB":"string", "workersCompCodes":{ "state":"string", "code":"string" }, "payGroup":"string" }, "department":{ "deptId":"string", "deptName":"string" }, "location":{ "locationtId":"string", "locationtName":"string" } } Field Description employeeId TriNet employee ID alternateId Alternate employee ID, if your company uses different employee IDs name   lastName Last name middleName Middle name firstName First name employmentInfo   effectiveDate Date the information became effective jobCode Job code or category used for EEO reporting regularTemporary Whether the employee is regular or temporary employeeType Whether the employee is fulltime or parttime FlsaCode Whether the employee is exempt or non-exempt employmentStatus Employment status Values: A (for Active), D (for Deceased), L (for Leave of Absence), P (for Leave with Pay), S (for Suspended), T (for Terminated), U (for Terminated with Pay) standardHours Employee’s standard number of hours per week businessTitle Business title serviceDate Service date: typically the hire date, can be changed for benefits eligibility or time off accrual terminationDate   supervisorId Supervisor’s ID supervisorName Supervisor’s full name workEmail Employee’s work email address workPhone Employee’s work phone number customGroupA Group A-Used to store company-specific information customGroupB Group B-Used to store company-specific information workersCompCodes   state State for workers’ compensation code Workers’ compensation code payGroup Paygroup deptId Department ID for the primary department deptName Department name locationId Location ID locationName Location name

GET

Pay Group by ID

https://api.trinet.com/{version}/company/{company}/paygroups/{paygroupId}

Retrieve pay group and pay frequency information for a specific pay group ID.   Response Template Field Information { "paygroupId":"string", "desc":"string", "shortDesc":"string", "payFrequency":"string", "effectiveDate":"datetime" }  

GET

Pay Group

https://api.trinet.com/{version}/company/{company}/paygroups

Retrieve pay group and pay frequency information.   Response Template Field Information { "paygroupId":"string", "desc":"string", "shortDesc":"string", "payFrequency":"string", "effectiveDate":"datetime" }  

GET

Work Contact

https://api.trinet.com/{version}/identity/{company}/{employeeId}/contacts

Retrieve employee work contact information.   Response Template Field Information { "employeeId":"string", "accessType":"string", "actualAccessType":"string", "effectiveDate":"datetime", "media":"string", "notes":"string", "telephoneNumber":"string", "uniqueId":"string", "url":"string" } Field Description employeeId TriNet employee ID accessType Access Type, such as Work effectiveDate Date the information became effective Media Type of media/contact, such as Email, Phone Notes Not currently used telephoneNumber Phone number uniqueId TriNet only url Email address

GET

Holidays

https://api.trinet.com/{version}/company/{company}/holidays

Response Template Field Information { "schedule":"string", "date":"datetime", "desc":"number", "hours":"number" }  

hr-admin-write

Method
Description

PUT

Custom Fields

https://api.trinet.com/{version}/manage-employee/{companyId}/{employeeId}/custom-fields

Update employee custome fields information.   Payload Template Field Information { "fieldLabel":"string", "fieldValue":"string" }

PUT

Job Reclassification

https://api.trinet.com/{version}/manage-employee/{company}/{employeeId}/jobs

Update system with Employee job changes.   Payload Template Field Information { "effectiveDate":"YYYY-MM-DD", "seniorityDate":"YYYY-MM-DD", "workPhone":"string", "businessTitle":"string", "managerId":"string", "jobReclassification":{ "employeeType":"F#P", "flsaStatus":"Z#C#T#N", "jobId":"strong", "reasonId":"string", "standardHours":"number", "temporaryInd":"boolean", "variableHour":"boolean" }, "optionalGrouping":{ "groupA":"string", "groupB":"string" }, "payChange":{ "compBasis":"A#H", "compRate":"number", "reasonId":"string" }, "demotion":{ "compBasis":"A#H", "compRate":"number", "reasonId":"string" }, "promotion":{ "compBasis":"A#H", "compRate":"number", "reasonId":"string" }, "employeeTransfer":{ "locationId":"string", "reasonId":"string" }, "departments":[ { "deptId":"string", "percentage":"number" } ], "workComp":{ "jobDuties":"string", "workCompCode":"string", "workCompState":"string" } } Section Field Req Description   effectiveDate Y Date the change becomes effective   seniorityDate N Employee agreed seniority date   workPhone N Work phone number   businessTitle N Business title   managerId N Employee Id of the supervisor jobReclassification employeeType N Employment type Values: F – full time, P – part time jobReclassification flsaStatus N Fair Labor Standards Act (FLSA) code Whether the employee is exempt or nonexempt Values jobReclassification jobId N Job code or category used for EEO reporting jobReclassification reasonId N Company specific reason code jobReclassification standardHours N Number of hours a week employee is required to work jobReclassification temporaryInd N Whether employee is R- regular or T – temporary jobReclassification variableHour N Indication whenter employee is working variable hours. optionalGrouping groupA N Group A-Used to store company-specific information optionalGrouping groupB N Group B-Used to store company-specific information payChange compBasis N Compensation frequency: A – Annual, H – Hourly payChange compRate N Compensation Rate payChange reasonId N Company specific reason code demotion compBasis N Compensation frequency: A – Annual, H – Hourly demotion compRate N Compensation Rate demotion reasonId N Company specific reason code promotion compBasis N Compensation frequency: A – Annual, H – Hourly promotion compRate N Compensation Rate promotion reasonId N Company specific reason code employeeTransfer locationId N Location Id. Validated against the list of Company’s locations employeeTransfer reasonId N Company specific reason code departments deptId N Department Id. Validated against the list of Company’s departments. departments percentage N Percentage employee works in the department workComp jobDuties N Job duties description (worker’s compensation) workComp workCompCode N Workers’ compensation code workComp workCompState N State for workers’ compensation While most of the fields are not required each section if applied needs to be completed.

POST

Location

https://api.trinet.com/{version}/manage-company/{companyId}/locations

Create new location   Response Template Field Information { "locationName":"string", "shortDesc":"string", "effectiveDate":"datetime", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state":"string", "postalCode":"string", "county":"string", "country":"string", } }  

POST

Department

https://api.trinet.com/{version}/manage-company/{companyId}/departments

Create new department.   Payload Template Field Information { "deptCode":"string", "deptName":"string", "shortDesc":"string", "effectiveDate":"datetime" }

PUT

Department

https://api.trinet.com/{version}/manage-company/{companyId}/departments/{departmentId}

Update department.   Payload Template Field Information { "deptCode":"string", "deptName":"string", "shortDesc":"string", "effectiveDate":"datetime" }

hr-security-write

Method
Description

DELETE

Roles

https://api.trinet.com/{version}/manage-employee/{companyId}/{employeeId}/employee-role/{roleId}

Remove role assignment for the employee

POST

Roles

https://api.trinet.com/{version}/manage-employee/{companyId}/{employeeId}/employee-role/{roleId}

Assign new role to an Employee   Payload Template Field Information { "role":"string", "deptId":"string", "locationId":"string" } Section Field Req Description   role Y Role ID   deptId N Department Id; applicable only for payroll roles   locationId N Location Id; applicable only for payroll roles    

hr-personal-write

Method
Description

PUT

Retirement Election

https://api.trinet.com/{version}/retirement-plan/{company}/{employeeId}/contributions

Update employee savings plan elections    Payload Template Field Information { "planType": "String", "benefitPlan": "String", "effectiveDate": "String", "electType": "E#W" "beforeTax": { "flatDeductionAmount": "Number", "percentGrossDeduction": "Number", "limitedAmount": "Number" }, "afterTax": { "flatDeductionAmount": "Number", "percentGrossDeduction": "Number", } }

POST

Direct Deposit

https://api.trinet.com/{version}/direct-deposit/{company}/{employeeId}/accounts

Update employee direct deposit information.   Response Template Field Information { "effectiveDate":"datetime", "accountType":"string", "routingNumber":"string", "bankId":"string", "branchId":"string", "accountNumber":"string", "priority":"int", "netBalance":"boolean", "fsaAccount":"boolean", "apAccount":"boolean", "amount":"number", "percent":"int", } Field Description effectiveDate Date the change became effective accountType Account type routingNumber Routing number bankId Bank ID branchId Branch ID accountNumber Account Number Priority Priority/order of the deposit netBalance Whether the account should be used for any remaining/net balance after deposits fsaAccount Whether the account should be used for FSA reimbursements apAccount Whether the account should be used for accounts payable/expense reimbursements Amount Flat dollar deposit amount Percent Percentage deposit amount

POST

Employee Name

https://api.trinet.com/{version}/identity/{company}/{employeeId}/names

Add employee name.   Payload Template Field Information { "effectiveDate": "YYYY-MM-DD", "personTitle": "string", "firstName": "string", "middleName":"string" "lastName": "string", "suffix": "string", "nameType": "PRI#PRF" } Section Field Req Description  

PUT

Employee Name

https://api.trinet.com/{version}/identity/{company}/{employeeId}/names

Update Employee's name.   Payload Template Field Information { "effectiveDate": "YYYY-MM-DD", "personTitle": "string", "firstName": "string", "middleName":"string" "lastName": "string", "suffix": "string", "nameType": "PRI#PRF" } Section Field Req Description  

PUT

Personal Address

https://api.trinet.com/{version}/identity/{company}/{employeeId}/addresses

Update Employee's address.   Payload Template Field Information "addressType": "Home Address", "effectiveDate": "yyyy-mm-dd", "address1": "string", "address2": "string", "address3": "string", "address4": "string", "city": "string", "county": "string", "state": "string", "postalCode": "string", "country":"CA#US" } Section Field Req Description  

PUT

Emergency Contact

https://api.trinet.com/{version}/profile/{company}/{employeeId}/emergency-contacts

Update employee emergency contact information.   Payload Template Field Information { "name":{ "firstName":"string", "middleName":"string", "lastName":"string", }, "primaryContactFlag":"boolean", "contactRelationship":"string", "sameAddressPerson":"boolean", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state": "string", "postalCode":"string", "county":"string", "country":"string" }, "samePhonePerson":"boolean", "telephoneNumbers":{ "telephoneNumber1":"string", "telephoneNumber2":"string", "telephoneNumber3":"string", "telephoneNumber4":"string" } } Field Req Description firstName yes First name of emergency contact middleName no Middle name of emergency contact lastName yes Last name of emergency contact primaryContactFlag yes Whether this is the primary emergency contact contactRelationship yes Relationship to the employee sameAddressPerson yes Whether the emergency contact has the same address as the employee Address1 yes Address line 1 Address2 no Address line 2 Address3 no Address line 3 Address4 no Address line 4 City yes City State yes State or province postalCode yes ZIP or postal code County no County Country yes Country Values: CA (for Canada), US (for United States) samePhonePerson yes Whether the emergency contact has the same phone number as the employee telephoneNumber1 no Phone number 1 telephoneNumber2 no Phone number 2 telephoneNumber3 no Phone number 3 telephoneNumber4 no Phone number 4

POST

Emergency Contact

https://api.trinet.com/{version}/profile/{company}/{employeeId}/emergency-contacts

Add employee emergency contact information.   Payload Template Field Information { "name":{ "firstName":"string", "middleName":"string", "lastName":"string", }, "primaryContactFlag":"boolean", "contactRelationship":"string", "sameAddressPerson":"boolean", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state": "string", "postalCode":"string", "county":"string", "country":"string" }, "samePhonePerson":"boolean", "telephoneNumbers":{ "telephoneNumber1":"string", "telephoneNumber2":"string", "telephoneNumber3":"string", "telephoneNumber4":"string" } } Field Req Description firstName yes First name of emergency contact middleName no Middle name of emergency contact lastName yes Last name of emergency contact primaryContactFlag yes Whether this is the primary emergency contact contactRelationship yes Relationship to the employee sameAddressPerson yes Whether the emergency contact has the same address as the employee Address1 yes Address line 1 Address2 no Address line 2 Address3 no Address line 3 Address4 no Address line 4 City yes City State yes State or province postalCode yes ZIP or postal code County no County Country yes Country Values: CA (for Canada), US (for United States) samePhonePerson yes Whether the emergency contact has the same phone number as the employee telephoneNumber1 no Phone number 1 telephoneNumber2 no Phone number 2 telephoneNumber3 no Phone number 3 telephoneNumber4 no Phone number 4

PUT

Tax Withholding

https://api.trinet.com/{version}/tax-withholding/{company}/{employeeId}/withholdings

Retrieve employee federal, state and local tax withholding information.    Payload Template Field Information { "effectiveDate":"YYYY-MM-DD", "FedTaxWithholdings":[ { "addlAmount":"number", "addlExempts":"number", "allowancesRequested":"integer", "payDedCode":"$$US", "relatedEntity":"$$US", "exempt":"boolean", "marriedFileSingle":"boolean", "maritalStatus":"M#S", "payControlOrg":"string", "nonResidentIsDeclared":"boolean", "exemptNoAppendTxt":"string" } ], "StateTaxWithholdings":[ { "addlAmount":"number", "addlExempts":"number", "allowancesRequested":"integer", "payDedCode":"string", "relatedEntity":"$$US", "exempt":"booolean", "marriedFileSingle":"boolean", "maritalStatus":"H#M#S", "payControlOrg":"string", "nonResidentIsDeclared":"boolean", "exemptNoAppendTxt":"string" } ] } Field Req Description effectiveDate yes Date the tax withholding became effective FedTaxWithholdings     addlAmount no Amount of any additional tax withholding addlExempts no Please ignore – not valid for federal allowancesRequested yes Number of allowances/exemptions payDedCode yes Code identifying if the tax is federal Exempt yes Whether or not the employee is exempt from tax withholding marriedFileSingle no Whether or not the employee is married but filing as single for tax purposes maritalStatus yes Marital status nonResidentIsDeclared no Please ignore – not valid for federal exemptNoAppendTxt no Please ignore – not valid for federal StateTaxWithholding     addlAmount no Amount of any additional tax withholding addlExempts no Additional exemptions allowancesRequested yes Number of allowances/exemptions payDedCode yes Code identifying the state Exempt yes Whether or not the employee is exempt from tax withholding marriedFileSingle no Whether or not the employee is married but filing as single for tax purposes maritalStatus yes Marital status nonResidentIsDeclared no Whether or not the employee is a nonresident alien exemptNoAppendTxt no  

PUT

Personal Contacts

https://api.trinet.com/{version}/identity/{company}/{employeeId}/contacts

Update Employee's contact information.   Payload Template Field Information { "accessType": "Campus#Dorm#Emerg#Home#Other#Work#Work2", "effectiveDate": "YYYY-MM-DD", "media": "Cellular#Fax#Pager#Phone#Telex#Email", "telephoneNumber": "string" , "url":"string" } Section Field Req Description  

PUT

Employee Identitifiers

https://api.trinet.com/{version}/identity/{companyId}/{employeeId}/identity

Update Employee's Identifiers - SSN/SID, alternate ID or citizenship code.   Payload Template Field Information   { "alternateId": "string", "citizenship": "string", "nationalIds":{ "country": "US#CA", "id": "string" } }   Section Field Req Description   alternateId N Employee's Alternate ID   citizenship N Employee's citizenship code nationalIds country N Country code: CA - Canada US - USA Required when updating national ID nationalIds id N SID  for Canada SSN for USA This service updates any of those 3 fields: alternateId, citizenship, SID/SSN. Only changes should be include. Living field blank will reatin current value.

POST

Personal Contacts

https://api.trinet.com/{version}/identity/{company}/{employeeId}/contacts

Add Employee's contact information.   Payload Template Field Information { "accessType": "Campus#Dorm#Emerg#Home#Other#Work#Work2", "effectiveDate": "YYYY-MM-DD", "media": "Cellular#Fax#Pager#Phone#Telex#Email", "telephoneNumber": "string" , "url":"string" } Section Field Req Description  

PUT

Personal Identification

https://api.trinet.com/{version}/identity/{company}/{employeeId}/personals

Add Employee's personal identification information.   Payload Template Field Information { "effectiveDate": "YYYY-MM-DD", "gender": "M#F", "maritalStatus": "String", "birthDate": "YYYY-MM-DD", "country":"US#CA", "militaryStatus": "string", "ethnicity":"string" } Section Field Req Description  

payroll-write

Method
Description

DELETE

Add Payroll

https://api.trinet.com/{version}/payroll/{companyId}/pay-entries/{batchId}

Remove payroll batch before it gets processed

POST

Add Payroll

https://api.trinet.com/{version}/payroll/{companyId}/pay-entries

Add a new payroll entries.   Payload Template Field Information   { "clientCode":"string", "payPeriodEndDate":"YYYY-MM-DD", "paygroupId":"string", "personIdType":"E#A", "payrollEditable":"boolean", "externalId":"string", "externalDescription":"string", "payrollDetails":[ { "personId":"string", "earningCode":"string", "jobCode":"string", "amount":"number", "overridePayRate":"number", "departmentId":"string", "locationId":"string", "earningsBeginDate":"YYYY-MM-DD", "earningsEndDate":"YYYY-MM-DD", "hoursEarned":"number", "overridePayRate":"number", "overrideUnitRate":"number", "units":"number" } ] }   Field Required Description clientCode Y External system code to identify data in Payroll. Example: "TriNet Time" paygroupId Y Pay Group Id payPeriodEndDate Y The presumed pay period end date. Subject to change in payroll processing payrollEditable N Future use externalId N External system batch Id for future reconciliation. externalDescription N External system batch description for future reconciliation. personIdType Y Employee Id or Alternate Id. Determines how employees are identified in a feed personId Y Either employeeId or alternateId earningsCode Y Code associated with a specific earning code. Validated against the list of Company’s Pay codes departmentId N Department code. Validated against the list of Company’s departments. locationId N Location code. Validated against the list of Company’s locations. jobCode N Job Code. Validated against the list of Company’s Job codes amount N Dollar amount. Required if Earn Code of "Amount" type earningsBeginDate N Beginning date this earning code was earned. YYYY-MM-DD format earningsEndDate N Ending date this earning code was earned. YYYY-MM-DD format hoursEarned N Hours. Required if Earn Code of "Hours" type overridePayRate N The override rate to pay for hours. overrideUnitRate N The rate to pay for incoming units. Required if Earn Code of "Unit/Override" type units N The number of units being reported. Required if Earn Code of "Unit/Override" type

GET

Add Payroll detailed status

https://api.trinet.com/{version}/payroll/{companyId}/pay-entries/{batchId}

Retrieve new payroll entries update status.   Payload Template Field Information   { "clientCode":"string", "payPeriodEndDate":"YYYY-MM-DD", "paygroupId":"string", "status":"string", "personIdType":"E#A", "payrollEditable":"boolean", "externalId":"string", "externalDescription":"string", "operatorId": "string", "payrollDetails":[ { "personId":"string", "earningCode":"string", "departmentId":"string", "locationtId":"string", "jobCode":"string", "hoursEarned":"number", "amount":"number", "overridePayRate":"number", "overrideUnitRate":"number", "units":"number", "earningsBeginDate":"YYYY-MM-DD", "earningsEndDate":"YYYY-MM-DD", "detailStatus":"string", "error":[ { "message":"string", "field":"string" } ] } ] }   Field Description clientCode External system code to identify data in Payroll. Example: "TriNet Time" paygroupId Pay Group Id payPeriodEndDate Pay period end date. status Status of the batch payrolleditable Future use externalId External Id for cross reference externalDescription External description for reference operatorId Employee ID of the operator who submitted original request personIdType Employee Id or Alternate Id. Determines how employees are identified in a feed personId Either employeeId or alternateId earningsCode Code associated with a specific earning code. departmentId Department code. locationId Location code. jobCode Job Code. amount Dollar amount earningsBeginDate Beginning date this earning code was earned. YYYY-MM-DD format earningsEndDate Ending date this earning code was earned. YYYY-MM-DD format hoursEarned Hours overridePayRate The override rate to pay for incoming hours overrideUnitRate The rate to pay for incoming units units The number of units being reported detailStatus Status of the given row message Error message if detailStatus indicates error field Field in error if detailStatus indicates error

PUT

Add Payroll

https://api.trinet.com/{version}/payroll/{companyId}/pay-entries/{batchId}

Modify payroll entries that has not been processed yet.   Payload Template Field Information   { "clientCode":"string", "payPeriodEndDate":"YYYY-MM-DD", "paygroupId":"string", "personIdType":"E#A", "payrollEditable":"boolean", "externalId":"string", "externalDescription":"string", "payrollDetails":[ { "personId":"string", "earningCode":"string", "jobCode":"string", "amount":"number", "overridePayRate":"number", "departmentId":"string", "locationId":"string", "earningsBeginDate":"YYYY-MM-DD", "earningsEndDate":"YYYY-MM-DD", "hoursEarned":"number", "overridePayRate":"number", "overrideUnitRate":"number", "units":"number" } ] }   Field Required Description clientCode Y External system code to identify data in Payroll. Example: "TriNet Time" paygroupId Y Pay Group Id payPeriodEndDate Y The presumed pay period end date. Subject to change in payroll processing payrollEditable N Future use externalId N External system batch Id for future reconciliation. externalDescription N External system batch description for future reconciliation. personIdType Y Employee Id or Alternate Id. Determines how employees are identified in a feed personId Y Either employeeId or alternateId earningsCode Y Code associated with a specific earning code. Validated against the list of Company’s Pay codes departmentId N Department code. Validated against the list of Company’s departments. locationId N Location code. Validated against the list of Company’s locations. jobCode N Job Code. Validated against the list of Company’s Job codes amount N Dollar amount. Required if Earn Code of "Amount" type earningsBeginDate N Beginning date this earning code was earned. YYYY-MM-DD format earningsEndDate N Ending date this earning code was earned. YYYY-MM-DD format hoursEarned N Hours. Required if Earn Code of "Hours" type overridePayRate N The override rate to pay for hours. overrideUnitRate N The rate to pay for incoming units. Required if Earn Code of "Unit/Override" type units N The number of units being reported. Required if Earn Code of "Unit/Override" type

hr-pay-read

Method
Description

GET

Pay Info

https://api.trinet.com/{version}/payroll/{company}/{employeeId}/pay-info

Retrieve employee ID and pay information.   Response Template Field Information { "employeeId":"string", "alternateId":"string", "employmentStatus":"A#D#L#P#S#T#U", "compRate":"number", "compFrequency":"string", "lastIncreaseDate":"datetime", "lastIncreasedAmt":"number", "bonus":[ { "mount":"number", "type":"string", "date":"datetime" } ], "additionalPay":[ { "amount":"number", "description":"string" } ] } Field Description employeeId TriNet employee ID alternateId Alternate ID, if your company uses different employee IDs employmentStatus Employment status Values: A (for Active), D (for Deceased), L (for Leave of Absence), P (for Leave with Pay), S (for Suspended), T (for Terminated), U (for Terminated with Pay) compRate Compensation rate compFrequency Compensation frequency such as hourly or annual lastIncreaseDate Date of the last pay increase lastIncreaseAmt Amount of the last pay increase bonus   amount Bonus amount type Bonus type date Bonus date additionalPay   amount Amount of any additional pay description Additional pay description

GET

Pay Check Details

https://api.trinet.com/{version}/payroll/{company}/{employeeId}/paycheck-details/{id}

Response Template Field Information { "header":{ "peoDesc":"string", "companyObj":"string", "companyId":"string", "payGroup":"string", "earnsBegDt":"datetime", "earnsEndDt":"datetime", "payEndDt":"datetime", "checkDt":"datetime", "checkNumber":"number", "employerName":"string", "employerAddress1":"string", "employerAddress2":"string", "employerAddress3":"string", "employerCountry":"string", "payCurrencyCd":"string", "employerPhone":"string", "name":"string", "address1":"string", "address2":"string", "address3":"string", "employeeId":"string", "ssn":"string", "department":"string", "location":"string", "businessTitle":"string", "payRate":"number", "payRateDesc":"string", "netPay":"number", "link":"string" }, "detail":{ "key":{ "payGroup":"string", "payPeriodEndDate":"datetime", "payEndDt":"datetime", "pageNo":"number", "lineNo":"number", "sepChk":"boolean", "offCycle":"boolean", "effDt":"datetime" }, "taxData":[ { "taxWithHolding":"string", "maritalStatus":"string", "allowances":"number", "addlPct":"number", "addlAmt":"number", "netClaimAmt":"number", "splLetters":"string" } ], "earns":[ { "curEarnsDesc":"string", "curEarnsRate":"number", "curEarnsHours":"number", "curEarnsEarn":"number", "ytdEarnsHours":"number", "ytdEarnsEarn":"number", "earnsBegDt":"datetime", "earnsEndDt":"datetime" } ], "taxWithholdings":[ { "taxDesc":"string", "curTaxes":"number", "ytdTaxes":"number" } ], "preTaxDedns":[ { "desc":"string", "curDedns":"number", "ytdDedns":"number", "pytdDedns":"number" } ], "postTaxDedns":[ { "desc":"string", "curDedns":"number", "ytdDedns":"number" } ], "employerBenefits":[ { "desc":"string", "curEmpBenf":"number", "ytdEmpBenf":"number" } ], "employerBenefitsTaxable":[ { "desc":"string", "curEmpBenf":"number", "ytdEmpBenf":"number" } ], "employerBenefitsNonTaxable":[ { "desc":"string", "curEmpBenf":"number", "ytdEmpBenf":"number" } ], "totals":{ "curHour":"number", "curGross":"number", "ytdHrsEarn":"number", "ytdGross":"number", "curTaxes":"number", "ytdTaxes":"number", "curPreDedn":"number", "ytdPreDedn":"number", "ytdPreDDedn":"number", "curPostDedn":"number", "ytdPostDedn":"number", "ytdTotalDedn":"number", "curTotalDedn":"number", "curEmpBenf":"number", "ytdEmpBenf":"number", "curFedTaxableGross":"number", "ytdFedTaxableGross":"number", "curNetPay":"number", "ytdNetPay":"number", "curNonTaxableTot":"number", "ytdNonTaxableTot":"number", "curTaxableTot":"number", "ytdTaxableTot":"number", "totalBenefitsCurrent":"number", "totalBenefitsYtd":"number", "totDirectDeposit":"number" }, "ptos":[ { "desc":"string", "begBal":"number", "earned":"number", "taken":"number", "adjust":"number", "endBal":"number" } ], "netPayDistributions":[ { "desc":"string", "refNum":"string", "depositAmt":"number" } ], "directDepositDistributions":[ { "acctType":"string", "acctNum":"string", "depositAmount":"number" } ], "link":"string" }, "link":"string" }  

GET

Pay Checks

https://api.trinet.com/{version}/payroll/{company}/{employeeId}/paychecks

Response Template Field Information { "employeeID":"string", "checkSummaries":[ { "id":"string", "netPay":"number", "checkIssueDate":"datetime", "checkDate":"datetime", "checkKey":{ "payGroup":"string", "payPeriodEndDate":"datetime", "payEndDt":"datetime", "pageNo":"number", "lineNo":"number", "sepChk":"boolean", "offCycle":"boolean", "effectiveDate":"dateime" }, "checkNumber":"string" } ] }  

GET

Social Security Number

https://api.trinet.com/{version}/identity/{company}/{employeeId}/ssn

Retrieve employee Social Security numbers (in US) or Social Insurance Numbers (in Canada).   Response Template Field Information { "employeeId": "string", "alternateId": "string", "employmentStatus": "string", "nationalIds":{ "country": "string", "idType":"SSN#SIN", "id": "string" } } < Field Description employeeId TriNet employee ID alternateId Alternate employee ID, if your company uses its own employee IDs EmploymentStatus Employment status Values: A (for Active), D (for Deceased), L (for Leave of Absence), P (for Leave with Pay), S (for Suspended), T (for Terminated), U (for Terminated with Pay) Country Country idType SSN (in US) or SIN (in Canada) id Social Security number (in US) or Social Insurance Number (in Canada)

hr-personal-read

Method
Description

GET

Tax Withholding

https://api.trinet.com/{version}/tax-withholding/{company}/{employeeId}/withholdings

Retrieve employee federal, state and local tax withholding information.    Response Template Field Information { "employeeId":"string", "effectiveDate":"datetime", "FedTaxWithholdings":{ "addlAmount":"number", "addlExempts":"int", "allowancesRequested":"int", "desc":"string", "payDedCode":"string", "exempt":"boolean", "marriedFileSingle":"boolean", "maritalStatus":"string", "maritalStatusAllowance":"string", "percentageGrossList":"string", "percentageGross":"string", "nonResidentIsDeclared":"boolean", "type":"string", "exemptNoAppendTxt":"string", "dependentAllowances":"string", "additionalAllowances":"string", "annualExemptionAmount":"string", "maritalAllowance":"string", "payControlOrg":"string", "localTaxNames":"string", "relatedEntity":"string" }, "StateTaxWithholdings":[ { "addlAmount":"number", "addlExempts":"int", "allowancesRequested":"int", "desc":"string", "payDedCode":"string", "exempt":"boolean", "marriedFileSingle":"boolean", "maritalStatus":"string", "maritalStatusAllowance":"string", "percentageGrossList":"string", "percentageGross":"string", "nonResidentIsDeclared":"boolean", "type":"string", "exemptNoAppendTxt":"string", "dependentAllowances":"string", "additionalAllowances":"string", "annualExemptionAmount":"string", "maritalAllowance":"string", "payControlOrg":"string", "localTaxNames":"string", "relatedEntity":"string" } ], "LocalTaxWithholdings":[ { "addlAmount":"number", "addlExempts":"int", "allowancesRequested":"int", "desc":"string", "payDedCode":"string", "exempt":"boolean", "marriedFileSingle":"boolean", "maritalStatus":"string", "maritalStatusAllowance":"string", "percentageGrossList":"string", "percentageGross":"string", "nonResidentIsDeclared":"boolean", "type":"string", "exemptNoAppendTxt":"string", "dependentAllowances":"string", "additionalAllowances":"string", "annualExemptionAmount":"string", "maritalAllowance":"string", "payControlOrg":"string", "localTaxNames":"string", "relatedEntity":"string" } ] } Field Description employeeId TriNet employee ID effectiveDate Date the tax withholding became effective FedTaxWithholdings   addlAmount Amount of any additional tax withholding addlExempts Please ignore – not valid for federal allowancesRequested Number of allowances/exemptions Desc Description of the type of tax payDedCode Code identifying if the tax is federal Exempt Whether or not the employee is exempt from tax withholding marriedFileSingle Whether or not the employee is married but filing as single for tax purposes maritalStatus Marital status maritalStatusAllowance Please ignore – not valid for federal percentageGrossList Please ignore – not valid for federal percentageGross Please ignore – not valid for federal nonResidentIsDeclared Please ignore – not valid for federal Type Whether it’s for federal, state or local taxes exemptNoAppendTxt Please ignore – not valid for federal dependentAllowances Please ignore – not valid for federal additionalAllowances Please ignore – not valid for federal annualExemptionAmount Please ignore – not valid for federal StateTaxWithholding   addlAmount Amount of any additional tax withholding addlExempts Additional exemptions allowancesRequested Number of allowances/exemptions Desc Description of the type of tax payDedCode Code identifying the state Exempt Whether or not the employee is exempt from tax withholding marriedFileSingle Whether or not the employee is married but filing as single for tax purposes maritalStatus Marital status maritalStatusAllowance   percentageGrossList   percentageGross   nonResidentIsDeclared Whether or not the employee is a nonresident alien Type   exemptNoAppendTxt   dependentAllowances   additionalAllowances   annualExemptionAmount   LocalTaxWithholdings   addlAmount Amount of any additional tax withholding addlExempts   allowancesRequested Number of allowances/exemptions Desc Description of the type of tax payDedCode Code identifying the city or county for local tax Exempt Whether or not the employee is exempt from tax withholding marriedFileSingle Whether or not the employee is married but filing as single for tax purposes maritalStatus Marital status maritalStatusAllowance   percentageGrossList   percentageGross   nonResidentIsDeclared   Type   exemptNoAppendTxt   dependentAllowances   additionalAllowances   annualExemptionAmount  

GET

Direct Deposit

https://api.trinet.com/{version}/direct-deposit/{company}/{employeeId}/accounts

Retrieve employee direct deposit information.   Response Template Field Information { "employeeId":"string", "effectiveDate":"datetime", "accountName":"string", "accountType":"string", "routingNumber":"string", "bankId":"string", "branchId":"string", "accountNumber":"string", "priority":"int", "netBalance":"boolean", "fsaAccount":"boolean", "apAccount":"boolean", "amount":"number", "percent":"int", "uniqueId":"string" } Field Description employeeId TriNet employee ID effectiveDate Date the change became effective accountName Account name accountType Account type routingNumber Routing number bankId Bank ID branchId Branch ID accountNumber Account Number Priority Priority/order of the deposit netBalance Whether the account should be used for any remaining/net balance after deposits fsaAccount Whether the account should be used for FSA reimbursements apAccount Whether the account should be used for accounts payable/expense reimbursements Amount Flat dollar deposit amount Percent Percentage deposit amount uniqueId TriNet only – please ignore

GET

Retirement Election

https://api.trinet.com/{version}/retirement-plan/{company}/{employeeId}/contributions

Retrieve employee retirement election information.   Response Template Field Information { "planType":"string", "planTypeDescription":"string", "benefitPlan":"string", "benefitPlanDescription":"string", "effectiveDate": "YYYY-MM-DD", "electType": "E#W", "federalAmount": "number", "catchupAmount": "number", "beforeTax": { "flatDeductionAmount": "number", "percentGrossDeduction": "number", "limitedAmount": "number" }, "afterTax": { "flatDeductionAmount": "number", "percentGrossDeduction": "number" } }

GET

Personal Address

https://api.trinet.com/{version}/identity/{company}/{employeeId}/addresses

Retrieve employee address information.   Response Template Field Information { "employeeId":"string", "addressType":"HOME", "effectiveDate":"datetime", "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "county":"string", "state":"string", "postalCode":"string", "country":"string", "primaryInd":"boolean", "uniqueId":"string" } Field Description employeeId TriNet employee ID addressType Type of address, such as Home effectiveDate Date the information became effective Address1 Address line 1 Address2 Address line 2 Address3 Address line 3 Address4 Address line 4 City City County County State State or province postalCode ZIP or postal code Country Country Values: CA (for Canada), US (for United States) primaryInd Whether this is the primary address uniqueId TriNet only

GET

Citizenship

https://api.trinet.com/{version}/profile/{company}/{employeeId}/citizenship

Retrieve employee citizenship information.   Response Template Field Information { "employeeId":"string", "alternateId":"string", "workEligibility":{ "citizenshipStatus":"string", "USWorkEligibility":"string", "effectiveDate":"datetime", "visa":{ "visaId":"string", "visaType":"string", "visaExpirationDate":"datetime" } } }   Field Description employeeId TriNet employee ID alternateId Alternate employee ID, if your company uses its own employee IDs workEligibility   citizenshipStatus Citizenship status such as Naturalized or Permanent Resident USWorkEligibility Whether or not the employee is eligible to work in the U.S.   effectiveDate Date the information became effective visa   visaId Visa Id visaType Type of the visa visaExpirationDate Expiration date of the visa

GET

Emergency Contact

https://api.trinet.com/{version}/profile/{company}/{employeeId}/emergency-contacts

Retrieve employee emergency contact information.   Response Template Field Information { "employeeId":"string", "name":{ "firstName":"string", "fullName": "string"", "middleName":"string", "lastName":"string", }, "primaryContactFlag":"boolean", "contactRelationship":"string", "sameAddressPerson":"boolean", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state":"string", "postalCode":"string", "county":"string", "country":"string" }, "samePhonePerson":"boolean", "telephoneNumbers":{ "telephoneNumber1":"string", "telephoneNumber2":"string", "telephoneNumber3":"string", "telephoneNumber4":"string" } } Field Description employeeId TriNet employee ID firstName First name of emergency contact fullName Full name of emergency contact middleName Middle name of emergency contact lastName Last name of emergency contact primaryContactFlag Whether this is the primary emergency contact contactRelationship Relationship to the employee sameAddressPerson Whether the emergency contact has the same address as the employee Address1 Address line 1 Address2 Address line 2 Address3 Address line 3 Address4 Address line 4 City City State State or province postalCode ZIP or postal code County County Country Country Values: CA (for Canada), US (for United States) samePhonePerson Whether the emergency contact has the same phone number as the employee telephoneNumber1 Phone number 1 telephoneNumber2 Phone number 2 telephoneNumber3 Phone number 3 telephoneNumber4 Phone number 4

GET

Time Off Accrual

https://api.trinet.com/{version}/employee/{company}/{employeeId}/leave-plan-accruals

Retrieve employee accrual information for time off plans.   Response Template Field Information { "employeeID":"string", "planType":"string", "planTypeDesc":"string", "accrualList":[ { "accrualDate":"datetime", "balanceHours":"number", "serviceHoursTotal":"number", "carryOverHours":"number", "hoursAdjustYtd":"number", "hoursEarnedYtd":"number", "hoursTakenYtd":"number", "hoursAdjustPeriod":"number", "hoursEarnedPeriod":"number", "hoursTakenPeriod":"number", "serviceHoursPeriod":"number" } ] } Field Description employeeId TriNet employee ID PlanType Plan Type planTypeDesc Plan Description  AccrualList   accrualDate Date accrual was processed balanceHours Balance as of the accrual date serviceHoursTotal Number of service hours since hire date carryOverHours Number of hours carried over from the previous year hoursAdustYtd Hours adjusted year to date hoursEarnedYtd Hours earned/accrued year to date hoursTakenYtd Hours taken year to date hoursAdjustPeriod Hours adjusted in the pay period hoursEarnedPeriod Hours earned/accrued in the pay period hoursTakenPeriod Hours taken in the pay period serviceHoursPeriod Number of service hours worked in the pay period

GET

Personal Identification

https://api.trinet.com/{version}/identity/{company}/{employeeId}/biographical-details

Retrieve employee identification and personal status information.   Response Template Field Information { "employeeId":"string", "uniqueId":"string", "effectiveDate":"datetime", "gender":"M#F", "marriageStatus":"string", "birthDate":"datetime", "country":"string", "militaryStatus":"string", "ethnicity":"string", "names":[ { "effectiveDate":"datetime", "formOfAddress":"string", "lastName":"string", "firstName":"string", "middleName":"string", "nameFormat":"string", "suffix":"string", "nameType":"primary#preferred", "personTitle":"string", "reasonChangeCode":"string", "uniqueId":"string" } ] } Field Description employeeId TriNet employee ID uniqueId TriNet only – please ignore effectiveDate Date the information became effective Gender Male or female marriageStatus Marital status birthdate Birthdate Country Country militaryStatus Military status Ethnicity Ethnicity for EEOC reporting Names   effectiveDate Date the information became effective formOfAddress Title or form of address lastName Last name firstName First name middleName Middle name nameFormat Not currently used suffix Name suffix nameType Name type Values: primary, preferred personTitle Not currently used reasonChangeCode Not currently used uniqueId TriNet only – please ignore

payroll-read

Method
Description

GET

Payroll Schedules by Pay Group ID

https://api.trinet.com/{version}/company/{companyId}/payroll-schedules/{paygroup}

Response Template Field Information { "paygroupId":"string", "payPeriodBeginDate":"datetime", "payPeriodEndDate":"datetime", "paycheckIssueDate":"datetime", "payrollPreparationDate":"datetime", "reportDate":"datetime", "processDate":"datetime" }  

GET

Pay Codes

https://api.trinet.com/{version}/company/{company}/pay-codes

Response Template Field Information { "payCode":"string", "description":"string", "type": "Amount#Hours#Units" }  

GET

Payroll Schedules

https://api.trinet.com/{version}/company/{company}/payroll-schedules

Response Template Field Information { "paygroupId":"string", "payPeriodBeginDate":"datetime", "payPeriodEndDate":"datetime", "paycheckIssueDate":"datetime", "payrollPreparationDate":"datetime", "reportDate":"datetime", "processDate":"datetime" }  

GET

Job Codes

https://api.trinet.com/{version}/company/{company}/jobs

Response Template Field Information { "key":"string", "value":"string" }  

benefits-read

Method
Description

GET

Company Savings Plans

https://api.trinet.com/{version}/company/{company}/savings-plans

List company savings plans Response Template Field Information { "planType":"String", "benefitPlan":"String", "benefitPlanDescription":"String", "adoptionDate":"String", "effectiveDate":"String", "vendorId":"String", "profitSharing":{ "type":"String", "typeDescription":"String", "vestingCode":"String", "vestingDescription":"String" }, "selfDirectedBrokerage":"boolean", "safeHarborContributions":{ "type":"String", "typeDescription":"String", "frequencyCode":"String", "frequencyDescription":"String", "vestingCode":"String", "vestingDescription":"String" }, "owner":"String", "webNotes":"String" }  

GET

Leave Plans Details by Plan Type

https://api.trinet.com/{version}/company/{company}/leave-plans/{planType}

Response Template Field Information {   "effectiveDate":"datetime",   "planType":"string",   "planTypeDescription":"string",   "benefitPlan":"string",   "benefitPlanDescription":"string",   "serviceUnits":"string",   "accrualMethod":"string",   "specialCalc":"string",   "serviceCalcAtYearBegin":"string",   "maxLeaveBalance":"number",   "maxLeaveCarryover":"number",   "accrualCalc": [    {     "afterServiceInterval":"number",     "accrualRatio":"number",     "accrualMax":"number"     }    ],   "serviceBonusValues":[    {     "afterServiceInterval":"number",     "awardBonusHours":"number"    }  ],   "firstYearAwardValues":[    {     "employmentMonth":"number",     "hoursEarned":"number",     "monthEligible":"number"    }   ] }  

GET

Leave Plans

https://api.trinet.com/{version}/company/{company}/leave-plans

Response Template Field Information {  "effectiveDate":"datetime",  "planType":"string",  "planTypeDescription":"string",  "benefitPlan":"string",  "benefitPlanDescription":"string" }  

hr-admin-read

Method
Description

GET

Company Benefits

https://api.trinet.com/{version}/company/{company}/benefits

Response Template Field Information { "effectiveDate":"datetime", "planType":"string", "planTypeDescription":"string", "waitingPeriod":"number", "fundingOption":"string", "sponsMedicalDentalVisionPlan":{ "benefitPlanCode":"string", "benefitPlanDescription":"string" }, "lifeBenefitPlan":{ "benefitPlanCode":"string", "benefitPlanDescription":"string" }, "ltdBenefitPlan":{ "benefitPlanCode":"string", "benefitPlanDescription":"string" }, "stdBenefitPlan":{ "benefitPlanCode":"string", "benefitPlanDescription":"string" }, "employerHSAContribution":"number", "forfeitExcessCredits":"boolean", "coverageMedical":{ "employee":"number", "dependent":"number" }, "coverageVision":{ "employee":"number", "dependent":"number" }, "coverageDental":{ "employee":"number", "dependent":"number" }, "suplements":{ "amountEmployee":"number", "amountSpouse":"number", "amountDependent":"number", "amountFamily":"number", "amountAll":"number", "amountWaiver":"number" }, "contributionsMedical":{ "employeeAmount":"number", "emplSpouseAmount":"number", "emplDependentsAmount":"number", "emplFamilyAmount":"number" }, "contributionsDental":{ "employeeAmount":"number", "emplSpouseAmount":"number", "emplDependentsAmount":"number", "emplFamilyAmount":"number" }, "contributionsVision":{ "employeeAmount":"number", "emplSpouseAmount":"number", "emplDependentsAmount":"number", "emplFamilyAmount":"number" }, "limits":{ "benefitLimitPlan10":"number", "benefitLimitPlan15":"number", "medicalEmployeeLimit":"number", "medicalEmplSpouseLimit":"number", "medicalEmplDependentsLimit":"number", "medicalEmplFamilyLimit":"number" }, "ppoBandCode":"string", "caHMOBandCode":"string", "txHMOBandCode":"string" }  

GET

Workers Comp Codes

https://api.trinet.com/{version}/company/{company}/workers-comp-codes

Response Template Field Information { "code":"string", "description":"string", "state":"string", "effectiveDate":"datetime", "costRateId":"PEO", "costRate":"number", "pricing":[ { "rateId":"string", "rate":"number" } ], "rateModifier":[ { "billModifier":"number", "lumpRate":"number" } ] }  

hr-new-hire-write

Method
Description

POST

Add Employee

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

Add a new employee.   Payload Template Field Information { "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  

hr-pay-read

Method
Description
,

basic-read

Method
Description

GET

All Employee Details

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

Retrieve detailed employee information.   Basic View All View Field Information { "employeeId":"string", "alternateId":"string", "names":[ { "effectiveDate":"datetime", "formOfAddress":"string", "lastName":"string", "firstName":"string", "middleName":"string", "nameFormat":"string", "suffix":"string", "nameType":"primary#preferred", "personTitle":"string", "reasonChangeCode":"string", "uniqueId":"string" } ], "employmentInfo":{ "jobCode":"string", "serviceDate":"datetime", "temporaryIndicator":"regular#temporary", "employeeType":"fulltime#parttime", "flsaCode":"C#Z#T#N", "employmentStatus":"A#D#L#P#S#T#U", "standardhours":"int", "businessTitle":"string", "supervisorId":"string", "supervisorName":"string", "workEmail":"string", "workPhone":"string", "groupA":"string", "groupB":"string", "workersCompCodes":{ "state":"string", "workersCompCode":"string" }, "payGroup":"string", "departmentId":"string", "locationId":"string", "effectiveDate":"datetime" } "employeePhoto": { "mimeType": "string", "photoId": "number", "uri": "string" } } { "employeeId":"string", "alternateId":"string", "employmentInfo":{ "effectiveDate":"datetime", "regularTemporary":"Regular#Temporary", "serviceDate":"datetime", "terminationDate":null, "standardHours":"number", "jobCode":"string", "workersCompCode":{ "code":"string", "state":"string" }, "flsaCode":"C#Z#T#N", "employmentStatus":"A#D#L#P#S#T#U", "payGroup":"string", "employeeType":"string", "businessTitle":"string", "customGroupA":"string", "customGroupB":"string", "workPhone":"string", "workEmail":"string", "location":{ "locationtId":"string", "locationtName":"string" }, "department":{ "deptName":"string", "deptId":"string" }, "supervisor":{ "supervisorName":"string", "supervisorId":"string" } }, "customFields": [ { "fieldLabel": "string", "fieldType": "string", "fieldValue": "string" } ], "roles":[ { "role":"string" } ], "employeeContacts":[ { "accessType":"string", "actualAccessType":"string", "effectiveDate":"datetime", "media":"string", "notes":"string", "telephoneNumber":"string", "uniqueId":"string", "url":"string" } ], "emergencyContacts":[ { "primaryContactFlag":"boolean", "contactRelationship":"string", "sameAddressPerson":"boolean", "address":{ "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "state":"string", "postalCode":"string", "county":"string", "country":"string" }, "samePhonePerson":"boolean", "telephoneNumbers":{ "telephoneNumber1":"string", "telephoneNumber2":"string", "telephoneNumber3":"string", "telephoneNumber4":"string" } } ], "nationalIds":{ "country":"string", "idType":"SSN#SIN", "id":"string" }, "names":[ { "nameType":"PRI#PRF", "firstName":"string", "personTitle":"string", "lastName":"string", "nameFormat":"string", "formOfAddress":"string", "name":"string", "middleName":"string", "suffix":"string", "effectiveDate":"datetime", "uniqueId":"string", "reasonChangeCode":"string" } ], "workEligibility":{ "citizenshipStatus":"string", "visa":{ "visaExpirationDate":"datetime", "visaId":"string", "visaType":"string" }, "USWorkEligibility":"string", "effectiveDate":"datetime" }, "bioInfo":{ "effectiveDate":"datetime", "gender":"M#F", "marriageStatus":"string", "birthDate":"datetime", "country":"string", "militaryStatus":"string", "ethnicity":"string" }, "payInfo":{ "compRate":"number", "compFrequency":"string", "lastIncreaseDate":"datetime", "lastIncreasedAmt":"number", "bonus":[ { "mount":"number", "type":"string", "date":"datetime" } ], "additionalPay":[ { "amount":"number", "description":"string" } ] }, "departmentSplit":[ { "departmentId":"string", "departmentName":"string", "splitPercentage":"number", "effectiveDate":"datetime" } ], "homeAddress":{ "effectiveDate":"datetime", "address1":"string", "address2":"string", "address3":"string", "address4":"string", "city":"string", "county":"string", "state":"string", "postalCode":"string", "country":"string", "primaryInd":"boolean" } "employeePhoto": { "mimeType": "string", "photoId": "number", "uri": "string" } } Field Description employeeId TriNet Employee ID alternateId Alternate ID, if your company uses different employee IDs names   effectiveDate Date the name change became effective formOfAddress Title or form of address lastName Last name firstName First name middleName Middle name nameFormat Not currently used suffix Suffix nameType Whether the name is primary or preferred personTitle Not currently used reasonChangeCode Not currently used uniqueId TriNet only – please ignore employmentInfo   jobCode Job code or job category for EEOC reporting serviceDate Service date: typically the hire date, can be changed for benefits eligibility or time off accrual temporaryIndicator Whether the employee is regular or temporary employeeType Employee type such as full time or part time FlsaCode Fair Labor Standards Act (FLSA) code Whether the employee is exempt or nonexempt employmentStatus Employment Status standardhours Standard hours per week bussinessTitle Job title supervisorId Unique ID for the supervisor supervisorName Supervisor’s name workEmail Work email address workPhone Work phone number groupA Group A-Used to store company-specific information groupB Group B- Used to store company-specific information workersCompCodes   state Employee’s state for workers’ compensation workersCompCode Workers’ compensation code payGroup Pay group departmentId Department ID locationId Location ID effectiveDate Date the employment info change became effective bioInfo   effectiveDate Date the information became effective gender Male or female marriageStatus Marital status birthdate Birthdate country Country militaryStatus Military status ethnicity Ethnicity for EEOC reporting homeAddress   effectiveDate Date the information became effective address1 Address line 1 address2 Address line 2 address3 Address line 3 address4 Address line 4 city City county County state State or province postalCode ZIP or postal code country Country Values: CA (for Canada) or US (for United States) primaryInd Whether this is the primary address payInfo   compRate Compensation rate compFrequency Compensation frequency Values: hourly, annual lastIncreaseDate Last increase date lastIncreaseAmt Last increase amount bonus   bonusAmount Bonus amount bonusType Bonus type bonusDate Bonus date bonusPercentage Whether this is a percentage bonus vs flat amount additionalPay   additionalPay Additional pay amount additionalPayDescription Additional pay description workEligibility   citizenshipStatus Citizenship status Values: Naturalized, Permanent Resident… USWorkEligibility Whether or not the employee is eligible to work in the U.S.  effectiveDate Date the information became effective Ssn-sid   country Country socialId Social Security number (in US) or Social Insurance Number (in Canada) employeeContacts   accessType Access Type, such as Work actualAccessType   effectiveDate Date the information became effective media Type of media/contact, such as Email, Phone notes Not currently used telephoneNumber Phone number uniqueId TriNet only url Email address emergencyContacts   firstName First name of emergency contact fullName Full name of emergency contact middleName Middle name of emergency contact lastName Last name of emergency contact primaryIndicator Whether this is the primary emergency contact designeeRelation Relationship to the employee sameAddressPerson Whether the emergency contact has the same address as the employee address1 Address line 1 address2 Address line 2 address3 Address line 3 address4 Address line 4 city City state State or province postalCode ZIP or postal code county County country Country samePhonePerson Whether the emergency contact has the same phone number as the employee telephoneNumber1 Phone number 1 telephoneNumber2 Phone number 2 telephoneNumber3 Phone number 3 telephoneNumber4 Phone number 4 Roles   role TriNet permissions/roles assigned to employee departmentSplit   departmentId Department ID departmentName Department Name splitPercentage Percentage employee works in the department effectivedate Date the information became effective customFields   fieldLabel Custom field label as shown in TriNet platform fieldType Custom field type (date, currency, text etc.) fieldValue Custom field value employeePhoto   mimeType Mime type of the photo file photoId Unique Id of the photo of associated with this profile uri URI to retrieve actual photo file  

hr-security-read

Method
Description

GET

Roles

https://api.trinet.com/{version}/manage-employee/{companyId}/{employeeId}/employee-roles

Retrieve employee role information.   Response Template Field Information { "category": "string", "longDesc": "string", "role": "string", "roleDesc": "string" } Field Description category Role category longDesc Long defnition of the role role Role Id roleDesc Role Description