PApaychex
Worker

Worker

Update a unique worker (employee and contractor) that your application has been granted access to modify.

patch/workers/{workerId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Request body

workerIdstring

The unique identifier associated with this worker representation.

employeeIdstring

The workers employee identification information.

workerType'EMPLOYEE' | 'CONTRACTOR' | 'INDEPENDENT_CONTRACTOR'

The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.

employmentType'FULL_TIME' | 'PART_TIME'

The type of employment for the worker.

exemptionType'EXEMPT' | 'NON_EXEMPT'

The Overtime classification of the worker. This data field cannot be PATCHED for ACTIVE workers.

workStatestring

The state(s) in which the worker works in.

birthDatestring date-time

The workers date of birth. It cannot be greater than today's date.

sex'MALE' | 'FEMALE' | 'NOT_SPECIFIED'
ethnicityCodestring

Disclaimer:This parameter is not visible in Flex for the client. This data field cannot be PATCHED for ACTIVE workers.

hireDatestring date-time

The date which the worker was hired. It cannot be PATCHED for ACTIVE workers.

clockIdstring

The clock ID of the worker that can be an identification for other systems.

seniorityDatestring date-time

The workers seniority date. This data field cannot be POSTED or PATCHED.

profileImageURLstring

The workers profile image url. This data field cannot be POSTED or PATCHED.

laborAssignmentIdstring

The workers home labor assignment.

locationIdstring

The workers location.

jobIdstring

The workers home job

_linksLinks
workerCorrelationIdstring

Id that you define which is used for error handling/responses.This data field is used while POSTING multiple IN_PROGRESS workers

Example request

{
  "workerId": "00Z5V9BTIHRQF2CF7BTH",
  "employeeId": "3052",
  "workerType": "EMPLOYEE",
  "employmentType": "FULL_TIME",
  "customEmploymentType": {
    "customEmploymentTypeId": "970008177269854",
    "customEmploymentTypeName": "Hybrid"
  },
  "exemptionType": "NON_EXEMPT",
  "birthDate": "1988-07-01T00:00:00Z",
  "sex": "MALE",
  "hireDate": "2015-06-15T00:00:00Z",
  "clockId": "4321",
  "name": {
    "familyName": "JONES",
    "middleName": "H",
    "givenName": "INDIANA",
    "preferredName": "Indi",
    "preferredLastName": "Jan",
    "pronoun": "He/him/his",
    "qualificationAffixCode": "Jr",
    "titleAffixCode": "Dr"
  },
  "seniorityDate": "2015-06-15T00:00:00Z",
  "profileImageURL": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg",
  "legalId": {
    "legalIdValue": "333221111"
  },
  "laborAssignmentId": "970001557863345",
  "locationId": "970001701620675",
  "jobId": "970001557916904",
  "job": {
    "jobTitleId": "00DWS906IMW2JSH8AQJ8",
    "title": "Archaeologist"
  },
  "organization": {
    "organizationId": "1020022951957523",
    "name": "2 Division B",
    "number": "1"
  },
  "supervisor": {
    "workerId": "00H2A1IUJ4IPERJ589YE",
    "name": {
      "familyName": "JONES",
      "middleName": "H",
      "givenName": "INDIANA",
      "preferredName": "Indi",
      "preferredLastName": "Jan",
      "pronoun": "He/him/his",
      "qualificationAffixCode": "Jr",
      "titleAffixCode": "Dr"
    }
  },
  "currentStatus": {
    "workerStatusId": "00DWS906IMW2JSH8AQJ9",
    "statusType": "ACTIVE",
    "statusReason": "HIRED",
    "effectiveDate": "2015-06-15T00:00:00Z"
  }
}

Response

successful operation

Example response

{
  "content": {
    "workerId": "00Z5V9BTIHRQF2CF7BTH",
    "employeeId": "3052",
    "workerType": "EMPLOYEE",
    "employmentType": "FULL_TIME",
    "customEmploymentType": {
      "customEmploymentTypeId": "970008177269854",
      "customEmploymentTypeName": "Hybrid"
    },
    "exemptionType": "NON_EXEMPT",
    "birthDate": "1988-07-01T00:00:00Z",
    "sex": "MALE",
    "hireDate": "2015-06-15T00:00:00Z",
    "clockId": "4321",
    "name": {
      "familyName": "JONES",
      "middleName": "H",
      "givenName": "INDIANA",
      "preferredName": "Indi",
      "preferredLastName": "Jan",
      "pronoun": "He/him/his",
      "qualificationAffixCode": "Jr",
      "titleAffixCode": "Dr"
    },
    "seniorityDate": "2015-06-15T00:00:00Z",
    "profileImageURL": "https://cdn.url/flexworkerphotos/wrkr0ad1b60a-45cc-4bbb-b5gc-299a832ce111.jpg",
    "legalId": {
      "legalIdValue": "333221111"
    },
    "laborAssignmentId": "970001557863345",
    "locationId": "970001701620675",
    "jobId": "970001557916904",
    "job": {
      "jobTitleId": "00DWS906IMW2JSH8AQJ8",
      "title": "Archaeologist"
    },
    "organization": {
      "organizationId": "1020022951957523",
      "name": "2 Division B",
      "number": "1"
    },
    "supervisor": {
      "workerId": "00H2A1IUJ4IPERJ589YE",
      "name": {
        "familyName": "JONES",
        "middleName": "H",
        "givenName": "INDIANA",
        "preferredName": "Indi",
        "preferredLastName": "Jan",
        "pronoun": "He/him/his",
        "qualificationAffixCode": "Jr",
        "titleAffixCode": "Dr"
      }
    },
    "currentStatus": {
      "workerStatusId": "00DWS906IMW2JSH8AQJ9",
      "statusType": "ACTIVE",
      "statusReason": "HIRED",
      "effectiveDate": "2015-06-15T00:00:00Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.