> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # paychex-workers > Paychex Workers - Employee profiles, contacts, communications, documents, and custom fields **Server path:** `/paychex-workers` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | [`paychex_workers_add_profile_image`](#paychex_workers_add_profile_image) | Worker Profile Image | | [`paychex_workers_add_worker_contacts`](#paychex_workers_add_worker_contacts) | Worker Contacts | | [`paychex_workers_create_worker_communication`](#paychex_workers_create_worker_communication) | Worker Communication | | [`paychex_workers_create_worker_custom_field`](#paychex_workers_create_worker_custom_field) | Worker Custom Field | | [`paychex_workers_delete_document`](#paychex_workers_delete_document) | Worker Document | | [`paychex_workers_delete_in_progress_worker`](#paychex_workers_delete_in_progress_worker) | Worker | | [`paychex_workers_delete_profile_image`](#paychex_workers_delete_profile_image) | Worker Profile Image | | [`paychex_workers_delete_worker_communication`](#paychex_workers_delete_worker_communication) | Worker Communication | | [`paychex_workers_delete_worker_contact`](#paychex_workers_delete_worker_contact) | Worker Contact | | [`paychex_workers_delete_worker_custom_field`](#paychex_workers_delete_worker_custom_field) | Worker Custom Field | | [`paychex_workers_get_document`](#paychex_workers_get_document) | Worker Document | | [`paychex_workers_get_document_list`](#paychex_workers_get_document_list) | Worker Documents | | [`paychex_workers_get_profile_image`](#paychex_workers_get_profile_image) | Worker Profile Image | | [`paychex_workers_get_worker_assignments_distributions`](#paychex_workers_get_worker_assignments_distributions) | Worker Assignments | | [`paychex_workers_get_worker_communications`](#paychex_workers_get_worker_communications) | Worker Communications | | [`paychex_workers_get_worker_communications_by_id`](#paychex_workers_get_worker_communications_by_id) | Worker Communication | | [`paychex_workers_get_worker_contacts`](#paychex_workers_get_worker_contacts) | Worker Contacts | | [`paychex_workers_get_worker_contacts_by_contact_id`](#paychex_workers_get_worker_contacts_by_contact_id) | Worker Contact | | [`paychex_workers_get_worker_custom_fields`](#paychex_workers_get_worker_custom_fields) | Worker Custom Fields | | [`paychex_workers_get_worker_custom_fields_by_id`](#paychex_workers_get_worker_custom_fields_by_id) | Worker Custom Field | | [`paychex_workers_get_worker_i9status`](#paychex_workers_get_worker_i9status) | Worker I9 Status | | [`paychex_workers_get_worker_status_history`](#paychex_workers_get_worker_status_history) | Worker Statuses | | [`paychex_workers_get_worker_users_communications_nonpii_1_1_1_1_1_1_1_1`](#paychex_workers_get_worker_users_communications_nonpii_1_1_1_1_1_1_1_1) | Worker | | [`paychex_workers_update_worker`](#paychex_workers_update_worker) | Worker | | [`paychex_workers_update_worker_communication`](#paychex_workers_update_worker_communication) | Worker Communication | | [`paychex_workers_update_worker_contact`](#paychex_workers_update_worker_contact) | Worker Contacts | | [`paychex_workers_update_worker_custom_field`](#paychex_workers_update_worker_custom_field) | Worker CustomField | | [`paychex_workers_upload_document`](#paychex_workers_upload_document) | Worker Document | *** ## paychex\_workers\_add\_profile\_image Worker Profile Image **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `image` | string | Yes | — | The image value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "image": { "type": "string", "description": "The image value" } }, "required": [ "PCID", "workerId", "image" ] } ``` *** ## paychex\_workers\_add\_worker\_contacts Worker Contacts **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `contactId` | string | No | — | The ID for the workers specific contact. | | `contactType` | object | No | — | The type of this worker contact. Required for POST contacts. | | `relationship` | object | No | — | The relationship for this worker contract. Required for POST contacts. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "contactId": { "type": "string", "description": "The ID for the workers specific contact." }, "contactType": { "type": "object", "description": "The type of this worker contact. Required for POST contacts.", "properties": { "contactTypeId": { "type": "string", "description": "The ID for specific type of contact. Required for POST contacts." }, "contactTypeName": { "type": "string", "description": "Enum: \"EMERGENCY_CONTACT\" The name for specific type of contact." } } }, "relationship": { "type": "object", "description": "The relationship for this worker contract. Required for POST contacts.", "properties": { "relationshipId": { "type": "string", "description": "The ID for the workers relationship to contact." }, "relationWeid": { "type": "string", "description": "The ID for the workers specific relation." }, "relationshipType": { "type": "object", "description": "The relationship type for this worker contact. Required for POST person contacts." }, "primary": { "type": "boolean", "description": "Where to indicate if the contact is selected as Primary, where true = Primary contact and false = not Primary contact." }, "person": { "type": "object", "description": "The person associated with this relationship. The relationship must have either a person or entity." }, "entity": { "type": "object", "description": "The organization associated with this relationship. The relationship must have either a person or entity." } } } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_create\_worker\_communication Worker Communication **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `workerId` | string | Yes | — | The id assigned to the worker that workers are being requested for. | | `_links` | object | No | — | The links value | | `city` | string | No | — | The city name | | `communicationId` | string | No | — | The ID for the workers specific communication item. | | `countryCode` | string | No | — | The country code (ISO 3166 alpha-2) | | `countrySubdivisionCode` | string | No | — | The state code (ISO 3166 subdivision code) | | `dialArea` | string | No | — | The area dialing code for a communication number | | `dialCountry` | string | No | — | The country dialing code for a communication number | | `dialExtension` | string | No | — | The extension of the associated communication number | | `dialNumber` | string | No | — | The communication number, not including country dialing or area dialing codes | | `postalCode` | string | No | — | The zip-code | | `postalCodeExtension` | string | No | — | The zip-code extension | | `postOfficeBox` | string | No | — | The postal office box. This data field cannot be PATCHED | | `streetLineOne` | string | No | — | The street address line one | | `streetLineTwo` | string | No | — | The street address line two | | `type` | string | No | — | A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE\_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED. | | `uri` | string | No | — | The mailto address as specified in RFC2368 | | `usageType` | string | No | — | A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The id assigned to the worker that workers are being requested for." }, "_links": { "type": "object", "description": "The links value" }, "city": { "type": "string", "description": "The city name" }, "communicationId": { "type": "string", "description": "The ID for the workers specific communication item." }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2)" }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code)" }, "dialArea": { "type": "string", "description": "The area dialing code for a communication number" }, "dialCountry": { "type": "string", "description": "The country dialing code for a communication number" }, "dialExtension": { "type": "string", "description": "The extension of the associated communication number" }, "dialNumber": { "type": "string", "description": "The communication number, not including country dialing or area dialing codes" }, "postalCode": { "type": "string", "description": "The zip-code" }, "postalCodeExtension": { "type": "string", "description": "The zip-code extension" }, "postOfficeBox": { "type": "string", "description": "The postal office box. This data field cannot be PATCHED" }, "streetLineOne": { "type": "string", "description": "The street address line one" }, "streetLineTwo": { "type": "string", "description": "The street address line two" }, "type": { "type": "string", "description": "A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.", "enum": [ "STREET_ADDRESS", "PO_BOX_ADDRESS", "PHONE", "MOBILE_PHONE", "FAX", "EMAIL", "PAGER" ] }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368" }, "usageType": { "type": "string", "description": "A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.", "enum": [ "PERSONAL", "BUSINESS", "HOME", "WORK", "LOCATION_STREET_ADDRESS", "MAILING_ADDRESS" ] } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_create\_worker\_custom\_field Worker Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `booleanValue` | boolean | No | — | The value for BOOLEAN type (true/false) | | `checkStub` | boolean | No | — | Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required. | | `customFieldId` | string | No | — | client Custom Field Id | | `customFieldName` | string | No | — | The name of the custom field. Such as: "Hobbies" | | `dateValue` | string | No | — | The value for DATE type , example : 2012-02-01T05:00:00Z | | `dropdownId` | string | No | — | The unique identifier that is autogenerated when dropdown list is created | | `dropdownValue` | string | No | — | The value for dropdown list | | `employeeEditable` | boolean | No | — | Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required. | | `numericValue` | number | No | — | Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456 | | `required` | boolean | No | — | Where to indicate if the custom field is required on the worker where true = required and false = not required | | `textValue` | string | No | — | The value for TEXT type (any text, alphanumeric, special characters allowed) | | `type` | string | No | — | The type of field the custom field is | | `workerCustomFieldId` | string | No | — | The unique identifier that is autogenerated when a custom field is created | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true/false)" }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required." }, "customFieldId": { "type": "string", "description": "client Custom Field Id" }, "customFieldName": { "type": "string", "description": "The name of the custom field. Such as: \"Hobbies\"" }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z" }, "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list" }, "employeeEditable": { "type": "boolean", "description": "Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required." }, "numericValue": { "type": "number", "description": "Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456" }, "required": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker where true = required and false = not required" }, "textValue": { "type": "string", "description": "The value for TEXT type (any text, alphanumeric, special characters allowed)" }, "type": { "type": "string", "description": "The type of field the custom field is", "enum": [ "DROPDOWN", "TEXT", "BOOLEAN", "DATE", "NUMERIC", "NUMERIC__0_00_", "NUMERIC__0_0000_" ] }, "workerCustomFieldId": { "type": "string", "description": "The unique identifier that is autogenerated when a custom field is created" } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_delete\_document Worker Document **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `documentId` | string | Yes | — | ID associated with the document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "documentId": { "type": "string", "description": "ID associated with the document." } }, "required": [ "PCID", "workerId", "documentId" ] } ``` *** ## paychex\_workers\_delete\_in\_progress\_worker Worker **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_delete\_profile\_image Worker Profile Image **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_delete\_worker\_communication Worker Communication **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------- | | `workerId` | string | Yes | — | The id assigned to the worker that workers are being requested for. | | `communicationId` | string | Yes | — | The id of a single workers communication. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The id assigned to the worker that workers are being requested for." }, "communicationId": { "type": "string", "description": "The id of a single workers communication." } }, "required": [ "PCID", "workerId", "communicationId" ] } ``` *** ## paychex\_workers\_delete\_worker\_contact Worker Contact **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------ | | `workerId` | string | Yes | — | ID associated with desired worker. | | `contactId` | string | Yes | — | ID associated with desired worker contact. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "contactId": { "type": "string", "description": "ID associated with desired worker contact." } }, "required": [ "PCID", "workerId", "contactId" ] } ``` *** ## paychex\_workers\_delete\_worker\_custom\_field Worker Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ----------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `workerCustomFieldId` | string | Yes | — | ID associated with desired worker custom field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "workerCustomFieldId": { "type": "string", "description": "ID associated with desired worker custom field." } }, "required": [ "PCID", "workerId", "workerCustomFieldId" ] } ``` *** ## paychex\_workers\_get\_document Worker Document **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `documentId` | string | Yes | — | ID associated with the document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "documentId": { "type": "string", "description": "ID associated with the document." } }, "required": [ "PCID", "workerId", "documentId" ] } ``` *** ## paychex\_workers\_get\_document\_list Worker Documents **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_profile\_image Worker Profile Image **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_assignments\_distributions Worker Assignments **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------- | | `workerId` | string | Yes | — | The ID of the worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The ID of the worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_communications Worker Communications **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------- | | `workerId` | string | Yes | — | The id assigned to the worker that workers are being requested for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The id assigned to the worker that workers are being requested for." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_communications\_by\_id Worker Communication **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------- | | `workerId` | string | Yes | — | The id assigned to the worker that workers are being requested for. | | `communicationId` | string | Yes | — | The id of a single workers communication. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The id assigned to the worker that workers are being requested for." }, "communicationId": { "type": "string", "description": "The id of a single workers communication." } }, "required": [ "PCID", "workerId", "communicationId" ] } ``` *** ## paychex\_workers\_get\_worker\_contacts Worker Contacts **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_contacts\_by\_contact\_id Worker Contact **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `contactId` | string | Yes | — | The id of a single Contact. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "contactId": { "type": "string", "description": "The id of a single Contact." } }, "required": [ "PCID", "workerId", "contactId" ] } ``` *** ## paychex\_workers\_get\_worker\_custom\_fields Worker Custom Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------ | | `workerId` | string | Yes | — | ID associated with desired worker. | | `asof` | string | No | — | Returns all custom fields as of the date used in the request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "asof": { "type": "string", "description": "Returns all custom fields as of the date used in the request" } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_custom\_fields\_by\_id Worker Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `workerCustomFieldId` | string | Yes | — | ID associated with desired worker custom field. | | `asof` | string | No | — | Returns custom field as of the date used in the request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "workerCustomFieldId": { "type": "string", "description": "ID associated with desired worker custom field." }, "asof": { "type": "string", "description": "Returns custom field as of the date used in the request" } }, "required": [ "PCID", "workerId", "workerCustomFieldId" ] } ``` *** ## paychex\_workers\_get\_worker\_i9status Worker I9 Status **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_status\_history Worker Statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_get\_worker\_users\_communications\_nonpii\_1\_1\_1\_1\_1\_1\_1\_1 Worker **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_update\_worker Worker **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `_links` | object | No | — | The links value | | `birthDate` | string | No | — | The workers date of birth. It cannot be greater than today's date. | | `clockId` | string | No | — | The clock ID of the worker that can be an identification for other systems. | | `communications` | object\[] | No | — | Worker Communications. This data field cannot be updated for worker endpoint. | | `currentStatus` | object | No | — | The workers employment status information. This data field cannot be POSTED or PATCHED for an IN\_PROGRESS worker. | | `customEmploymentType` | object | No | — | The workers custom employment type | | `employeeId` | string | No | — | The workers employee identification information. | | `employmentType` | string | No | — | The type of employment for the worker. | | `ethnicityCode` | string | No | — | Disclaimer:This parameter is not visible in Flex for the client. This data field cannot be PATCHED for ACTIVE workers. | | `exemptionType` | string | No | — | The Overtime classification of the worker. This data field cannot be PATCHED for ACTIVE workers. | | `hireDate` | string | No | — | The date which the worker was hired. It cannot be PATCHED for ACTIVE workers. | | `job` | object | No | — | The workers current job/position information. | | `jobId` | string | No | — | The workers home job | | `laborAssignmentId` | string | No | — | The workers home labor assignment. | | `legalId` | object | No | — | The workers legal tax identification information. This data field cannot be PATCHED for ACTIVE workers. | | `locationId` | string | No | — | The workers location. | | `name` | object | No | — | Information about the workers name. | | `organization` | object | No | — | The organization which the worker is part of. | | `profileImageURL` | string | No | — | The workers profile image url. This data field cannot be POSTED or PATCHED. | | `seniorityDate` | string | No | — | The workers seniority date. This data field cannot be POSTED or PATCHED. | | `sex` | string | No | — | The sex value | | `supervisor` | object | No | — | The workers supervisor information.Supervisor cannot be a TERMINATED or IN\_PROGRESS worker. Assigned supervisors who are active employees within the company account will be returned. Supervisors that are users who are not workers will not be included in the response. | | `workerCorrelationId` | string | No | — | Id that you define which is used for error handling/responses.This data field is used while POSTING multiple IN\_PROGRESS workers | | `workerType` | string | No | — | The type of worker. This data field cannot be PATCHED.NOTE: An IN\_PROGRESS worker cannot be POSTED with a value of CONTRACTOR. | | `workState` | string | No | — | The state(s) in which the worker works in. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "_links": { "type": "object", "description": "The links value" }, "birthDate": { "type": "string", "description": "The workers date of birth. It cannot be greater than today's date." }, "clockId": { "type": "string", "description": "The clock ID of the worker that can be an identification for other systems." }, "communications": { "type": "array", "items": { "type": "object", "properties": { "communicationId": { "type": "string", "description": "The ID for the workers specific communication item." }, "type": { "type": "string", "enum": [ "STREET_ADDRESS", "PO_BOX_ADDRESS", "PHONE", "MOBILE_PHONE", "FAX", "EMAIL", "PAGER" ], "description": "A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED." }, "usageType": { "type": "string", "enum": [ "PERSONAL", "BUSINESS", "HOME", "WORK", "LOCATION_STREET_ADDRESS", "MAILING_ADDRESS" ], "description": "A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED." }, "dialCountry": { "type": "string", "description": "The country dialing code for a communication number" }, "dialArea": { "type": "string", "description": "The area dialing code for a communication number" }, "dialNumber": { "type": "string", "description": "The communication number, not including country dialing or area dialing codes" }, "dialExtension": { "type": "string", "description": "The extension of the associated communication number" }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368" }, "streetLineOne": { "type": "string", "description": "The street address line one" }, "streetLineTwo": { "type": "string", "description": "The street address line two" }, "postOfficeBox": { "type": "string", "description": "The postal office box. This data field cannot be PATCHED" }, "city": { "type": "string", "description": "The city name" }, "postalCode": { "type": "string", "description": "The zip-code" }, "postalCodeExtension": { "type": "string", "description": "The zip-code extension" }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code)" }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2)" }, "_links": { "type": "object", "description": "The links value" } } }, "description": "Worker Communications. This data field cannot be updated for worker endpoint." }, "currentStatus": { "type": "object", "description": "The workers employment status information. This data field cannot be POSTED or PATCHED for an IN_PROGRESS worker.", "properties": { "workerStatusId": { "type": "string", "description": "The unique identifier associated with this status representation." }, "statusType": { "type": "string", "description": "The workers current status.", "enum": [ "ACTIVE", "INACTIVE", "TERMINATED", "PENDING", "IN_PROGRESS" ] }, "statusReason": { "type": "string", "description": "The detailed reason of the workers current status." }, "effectiveDate": { "type": "string", "description": "Date that this status has started for the worker." }, "order": { "type": "integer", "description": "The order value" }, "_links": { "type": "object", "description": "The links value" } } }, "customEmploymentType": { "type": "object", "description": "The workers custom employment type", "properties": { "customEmploymentTypeId": { "type": "string", "description": "Unique ID for the custom employment type which the worker is assigned to. This data field cannot be PATCHED for IN_PROGRESS workers." }, "customEmploymentTypeName": { "type": "string", "description": "The name of the custom employment type that the worker is assigned to." } } }, "employeeId": { "type": "string", "description": "The workers employee identification information." }, "employmentType": { "type": "string", "description": "The type of employment for the worker.", "enum": [ "FULL_TIME", "PART_TIME" ] }, "ethnicityCode": { "type": "string", "description": "Disclaimer:This parameter is not visible in Flex for the client. This data field cannot be PATCHED for ACTIVE workers." }, "exemptionType": { "type": "string", "description": "The Overtime classification of the worker. This data field cannot be PATCHED for ACTIVE workers.", "enum": [ "EXEMPT", "NON_EXEMPT" ] }, "hireDate": { "type": "string", "description": "The date which the worker was hired. It cannot be PATCHED for ACTIVE workers." }, "job": { "type": "object", "description": "The workers current job/position information.", "properties": { "jobTitleId": { "type": "string", "description": "Unique ID for that job within the company that the worker is assigned to." }, "title": { "type": "string", "description": "The name of the title that the worker is assigned to." } } }, "jobId": { "type": "string", "description": "The workers home job" }, "laborAssignmentId": { "type": "string", "description": "The workers home labor assignment." }, "legalId": { "type": "object", "description": "The workers legal tax identification information. This data field cannot be PATCHED for ACTIVE workers.", "properties": { "legalIdType": { "type": "string", "description": "A value that identifies the type of taxpayer identification number provided. SSN: Social Security Number - 9 digit number , FEIN: Federal Employer Identification Number (EIN)", "enum": [ "SSN", "FEIN" ] }, "legalIdValue": { "type": "string", "description": "The federal level taxpayer id number that the worker has provided" } } }, "locationId": { "type": "string", "description": "The workers location." }, "name": { "type": "object", "description": "Information about the workers name.", "properties": { "familyName": { "type": "string", "description": "The family or last name of a worker." }, "middleName": { "type": "string", "description": "A subordinate given name, or initial representing that name, of a worker.
NOTE: Please send in just a single character initial for middleName.
If sending in more than one character the name will be truncated the first letter of the middleName.
A full middle name can be entered directly in Paychex Flex only at this time." }, "givenName": { "type": "string", "description": "The given or first name of a worker. For an independent contractor that is a company rather than an individual, the name of the company." }, "preferredName": { "type": "string", "description": "The first name that the worker prefers to go by" }, "preferredLastName": { "type": "string", "description": "The last name that the worker prefers to go by" }, "pronoun": { "type": "string", "description": "The pronoun that the worker prefers to go by. This data field cannot be POSTED." }, "qualificationAffixCode": { "type": "string", "description": "A qualifier to the name of a worker, indicating generation." }, "titleAffixCode": { "type": "string", "description": "A personal title that comes before an individual's name in a formal address (such as Dr., Prof., Rev., Mr.)." } } }, "organization": { "type": "object", "description": "The organization which the worker is part of.", "properties": { "organizationId": { "type": "string", "description": "The unique identifier associated with this organizations representation." }, "name": { "type": "string", "description": "The name of the organization." }, "number": { "type": "string", "description": "The number assigned to the organization." }, "level": { "type": "string", "description": "The level number within the organizational structures hierarchy." }, "_links": { "type": "array", "items": { "type": "object" }, "description": "The links value" } } }, "profileImageURL": { "type": "string", "description": "The workers profile image url. This data field cannot be POSTED or PATCHED." }, "seniorityDate": { "type": "string", "description": "The workers seniority date. This data field cannot be POSTED or PATCHED." }, "sex": { "type": "string", "description": "The sex value", "enum": [ "MALE", "FEMALE", "NOT_SPECIFIED" ] }, "supervisor": { "type": "object", "description": "The workers supervisor information.Supervisor cannot be a TERMINATED or IN_PROGRESS worker. Assigned supervisors who are active employees within the company account will be returned. Supervisors that are users who are not workers will not be included in the response.", "properties": { "workerId": { "type": "string", "description": "The supervisor's Id" }, "name": { "type": "object", "description": "Information about the workers name." } } }, "workerCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses.This data field is used while POSTING multiple IN_PROGRESS workers" }, "workerType": { "type": "string", "description": "The type of worker. This data field cannot be PATCHED.NOTE: An IN_PROGRESS worker cannot be POSTED with a value of CONTRACTOR.", "enum": [ "EMPLOYEE", "CONTRACTOR", "INDEPENDENT_CONTRACTOR" ] }, "workState": { "type": "string", "description": "The state(s) in which the worker works in." } }, "required": [ "PCID", "workerId" ] } ``` *** ## paychex\_workers\_update\_worker\_communication Worker Communication **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `workerId` | string | Yes | — | The id assigned to the worker that workers are being requested for. | | `communicationId` | string | Yes | — | The id of a single workers communication. | | `_links` | object | No | — | The links value | | `city` | string | No | — | The city name | | `countryCode` | string | No | — | The country code (ISO 3166 alpha-2) | | `countrySubdivisionCode` | string | No | — | The state code (ISO 3166 subdivision code) | | `dialArea` | string | No | — | The area dialing code for a communication number | | `dialCountry` | string | No | — | The country dialing code for a communication number | | `dialExtension` | string | No | — | The extension of the associated communication number | | `dialNumber` | string | No | — | The communication number, not including country dialing or area dialing codes | | `postalCode` | string | No | — | The zip-code | | `postalCodeExtension` | string | No | — | The zip-code extension | | `postOfficeBox` | string | No | — | The postal office box. This data field cannot be PATCHED | | `streetLineOne` | string | No | — | The street address line one | | `streetLineTwo` | string | No | — | The street address line two | | `type` | string | No | — | A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE\_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED. | | `uri` | string | No | — | The mailto address as specified in RFC2368 | | `usageType` | string | No | — | A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "The id assigned to the worker that workers are being requested for." }, "communicationId": { "type": "string", "description": "The id of a single workers communication." }, "_links": { "type": "object", "description": "The links value" }, "city": { "type": "string", "description": "The city name" }, "countryCode": { "type": "string", "description": "The country code (ISO 3166 alpha-2)" }, "countrySubdivisionCode": { "type": "string", "description": "The state code (ISO 3166 subdivision code)" }, "dialArea": { "type": "string", "description": "The area dialing code for a communication number" }, "dialCountry": { "type": "string", "description": "The country dialing code for a communication number" }, "dialExtension": { "type": "string", "description": "The extension of the associated communication number" }, "dialNumber": { "type": "string", "description": "The communication number, not including country dialing or area dialing codes" }, "postalCode": { "type": "string", "description": "The zip-code" }, "postalCodeExtension": { "type": "string", "description": "The zip-code extension" }, "postOfficeBox": { "type": "string", "description": "The postal office box. This data field cannot be PATCHED" }, "streetLineOne": { "type": "string", "description": "The street address line one" }, "streetLineTwo": { "type": "string", "description": "The street address line two" }, "type": { "type": "string", "description": "A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.", "enum": [ "STREET_ADDRESS", "PO_BOX_ADDRESS", "PHONE", "MOBILE_PHONE", "FAX", "EMAIL", "PAGER" ] }, "uri": { "type": "string", "description": "The mailto address as specified in RFC2368" }, "usageType": { "type": "string", "description": "A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.", "enum": [ "PERSONAL", "BUSINESS", "HOME", "WORK", "LOCATION_STREET_ADDRESS", "MAILING_ADDRESS" ] } }, "required": [ "PCID", "workerId", "communicationId" ] } ``` *** ## paychex\_workers\_update\_worker\_contact Worker Contacts **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `contactId` | string | Yes | — | ID associated with desired worker contact. | | `contactType` | object | No | — | The type of this worker contact. Required for POST contacts. | | `relationship` | object | No | — | The relationship for this worker contract. Required for POST contacts. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "contactId": { "type": "string", "description": "ID associated with desired worker contact." }, "contactType": { "type": "object", "description": "The type of this worker contact. Required for POST contacts.", "properties": { "contactTypeId": { "type": "string", "description": "The ID for specific type of contact. Required for POST contacts." }, "contactTypeName": { "type": "string", "description": "Enum: \"EMERGENCY_CONTACT\" The name for specific type of contact." } } }, "relationship": { "type": "object", "description": "The relationship for this worker contract. Required for POST contacts.", "properties": { "relationshipId": { "type": "string", "description": "The ID for the workers relationship to contact." }, "relationWeid": { "type": "string", "description": "The ID for the workers specific relation." }, "relationshipType": { "type": "object", "description": "The relationship type for this worker contact. Required for POST person contacts." }, "primary": { "type": "boolean", "description": "Where to indicate if the contact is selected as Primary, where true = Primary contact and false = not Primary contact." }, "person": { "type": "object", "description": "The person associated with this relationship. The relationship must have either a person or entity." }, "entity": { "type": "object", "description": "The organization associated with this relationship. The relationship must have either a person or entity." } } } }, "required": [ "PCID", "workerId", "contactId" ] } ``` *** ## paychex\_workers\_update\_worker\_custom\_field Worker CustomField **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `workerCustomFieldId` | string | Yes | — | ID associated with desired worker custom field. | | `booleanValue` | boolean | No | — | The value for BOOLEAN type (true/false) | | `checkStub` | boolean | No | — | Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required. | | `customFieldId` | string | No | — | client Custom Field Id | | `customFieldName` | string | No | — | The name of the custom field. Such as: "Hobbies" | | `dateValue` | string | No | — | The value for DATE type , example : 2012-02-01T05:00:00Z | | `dropdownId` | string | No | — | The unique identifier that is autogenerated when dropdown list is created | | `dropdownValue` | string | No | — | The value for dropdown list | | `employeeEditable` | boolean | No | — | Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required. | | `numericValue` | number | No | — | Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456 | | `required` | boolean | No | — | Where to indicate if the custom field is required on the worker where true = required and false = not required | | `textValue` | string | No | — | The value for TEXT type (any text, alphanumeric, special characters allowed) | | `type` | string | No | — | The type of field the custom field is | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "workerCustomFieldId": { "type": "string", "description": "ID associated with desired worker custom field." }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true/false)" }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required." }, "customFieldId": { "type": "string", "description": "client Custom Field Id" }, "customFieldName": { "type": "string", "description": "The name of the custom field. Such as: \"Hobbies\"" }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z" }, "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list" }, "employeeEditable": { "type": "boolean", "description": "Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required." }, "numericValue": { "type": "number", "description": "Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456" }, "required": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker where true = required and false = not required" }, "textValue": { "type": "string", "description": "The value for TEXT type (any text, alphanumeric, special characters allowed)" }, "type": { "type": "string", "description": "The type of field the custom field is", "enum": [ "DROPDOWN", "TEXT", "BOOLEAN", "DATE", "NUMERIC", "NUMERIC__0_00_", "NUMERIC__0_0000_" ] } }, "required": [ "PCID", "workerId", "workerCustomFieldId" ] } ``` *** ## paychex\_workers\_upload\_document Worker Document **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ---------------------------------------------- | | `workerId` | string | Yes | — | ID associated with desired worker. | | `file` | string | Yes | — | The file value | | `metadata` | object | Yes | — | The metadata value | | `notificationToggle` | boolean | No | — | The notification toggle for send notification. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "workerId": { "type": "string", "description": "ID associated with desired worker." }, "file": { "type": "string", "description": "The file value" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "docId": { "type": "string", "description": "The document id associated with this document." }, "name": { "type": "string", "description": "The name of the document." }, "expirationReminderDays": { "type": "integer", "description": "Expiration Reminder Days" }, "expirationDate": { "type": "string", "description": "The expiration date of the document." }, "category": { "type": "string", "description": "The category id of the document." }, "workerVisible": { "type": "boolean", "description": "Flag for if the document is visible to the worker." }, "workerVisibleDate": { "type": "string", "description": "The date that the document is visible to the worker." }, "document": { "type": "string", "description": "The document data in base64. This field cannot be POSTED. The document should be POSTED in the 'file' field." }, "_links": { "type": "object", "description": "The links value" } }, "required": [ "category" ] }, "notificationToggle": { "type": "boolean", "description": "The notification toggle for send notification." } }, "required": [ "PCID", "workerId", "file", "metadata" ] } ```