PayEntriesUpdate

PUT

Add Payroll

Modify payroll entries that has not been processed yet.

 

 

{
   "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

Resource URL

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

Body Parameters


Name Values Description
body

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:

payroll-write

Working...