PayEntriesById

GET

Add Payroll detailed status

Retrieve new payroll entries update status.

 

 

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

Resource URL

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

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:

Scope:

payroll-write

Working...