> ## 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-company > Paychex Company - Company data, jobs, locations, organizations, and workers **Server path:** `/paychex-company` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [`paychex_company_create_company_custom_fields`](#paychex_company_create_company_custom_fields) | Custom Field | | [`paychex_company_create_company_custom_fields_category`](#paychex_company_create_company_custom_fields_category) | Custom Fields Category | | [`paychex_company_create_company_jobs`](#paychex_company_create_company_jobs) | Company Job | | [`paychex_company_create_in_progress_workers`](#paychex_company_create_in_progress_workers) | In Progress Workers | | [`paychex_company_delete_custom_field`](#paychex_company_delete_custom_field) | Custom Field | | [`paychex_company_delete_custom_fields_category`](#paychex_company_delete_custom_fields_category) | Custom Fields Category | | [`paychex_company_get_1`](#paychex_company_get_1) | A Company | | [`paychex_company_get_calculation_bases`](#paychex_company_get_calculation_bases) | Company Calculation Bases | | [`paychex_company_get_companies_1`](#paychex_company_get_companies_1) | Companies | | [`paychex_company_get_contact_types`](#paychex_company_get_contact_types) | Company Contact Types | | [`paychex_company_get_custom_employment_types`](#paychex_company_get_custom_employment_types) | Company Custom Employment Types | | [`paychex_company_get_custom_field_by_id`](#paychex_company_get_custom_field_by_id) | Custom Field | | [`paychex_company_get_customfields`](#paychex_company_get_customfields) | Custom Fields | | [`paychex_company_get_customfieldscategories`](#paychex_company_get_customfieldscategories) | Custom Fields Categories | | [`paychex_company_get_customfieldscategory`](#paychex_company_get_customfieldscategory) | Custom Fields Category | | [`paychex_company_get_document_categories`](#paychex_company_get_document_categories) | Company Document Categories | | [`paychex_company_get_frequency_combinations`](#paychex_company_get_frequency_combinations) | Company Pay Frequencies | | [`paychex_company_get_job`](#paychex_company_get_job) | Company Job | | [`paychex_company_get_job_segments`](#paychex_company_get_job_segments) | Company Job Segments | | [`paychex_company_get_jobs`](#paychex_company_get_jobs) | Company Jobs | | [`paychex_company_get_labor_assignment`](#paychex_company_get_labor_assignment) | Company Labor Assignment | | [`paychex_company_get_labor_assignments`](#paychex_company_get_labor_assignments) | Company Labor Assignments | | [`paychex_company_get_location`](#paychex_company_get_location) | Company Location | | [`paychex_company_get_locations`](#paychex_company_get_locations) | Company Locations | | [`paychex_company_get_non_worker_users`](#paychex_company_get_non_worker_users) | Company Non Workers Users | | [`paychex_company_get_organizations`](#paychex_company_get_organizations) | Company Organizations | | [`paychex_company_get_organizations_by_id`](#paychex_company_get_organizations_by_id) | Company Organization | | [`paychex_company_get_position`](#paychex_company_get_position) | Job Title | | [`paychex_company_get_positions`](#paychex_company_get_positions) | Company Job Titles | | [`paychex_company_get_state_taxes`](#paychex_company_get_state_taxes) | Company State Taxes | | [`paychex_company_get_status_code`](#paychex_company_get_status_code) | Company Worker Status | | [`paychex_company_get_status_codes`](#paychex_company_get_status_codes) | Company Worker Statuses | | [`paychex_company_get_workers`](#paychex_company_get_workers) | Company Workers | | [`paychex_company_update_company_custom_field`](#paychex_company_update_company_custom_field) | Custom Field | | [`paychex_company_update_company_custom_fields_category`](#paychex_company_update_company_custom_fields_category) | Custom Fields Category | | [`paychex_company_update_company_jobs`](#paychex_company_update_company_jobs) | Company Job | *** ## paychex\_company\_create\_company\_custom\_fields Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `booleanValue` | boolean | No | — | The value for BOOLEAN type (true / false) | | `categoryId` | string | No | — | The unique identifier that is autogenerated when creating a category | | `checkStub` | boolean | No | — | Where to indicate if the custom field is required on the worker's pay stub, where true = required and false = not required | | `customFieldId` | string | No | — | The unique identifier that is autogenerated when a custom field is created | | `customFieldName` | string | No | — | The name of the custom field | | `dateValue` | string | No | — | The value for DATE type , example : 2012-02-01T05:00:00Z | | `dropdown` | object\[] | No | — | The dropdown value | | `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 | | `links` | object\[] | No | — | The links value | | `maxTextLength` | number | No | — | The maximum allowed value for textValue | | `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" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true / false)" }, "categoryId": { "type": "string", "description": "The unique identifier that is autogenerated when creating a category" }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker's pay stub, where true = required and false = not required" }, "customFieldId": { "type": "string", "description": "The unique identifier that is autogenerated when a custom field is created" }, "customFieldName": { "type": "string", "description": "The name of the custom field" }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z" }, "dropdown": { "type": "array", "items": { "type": "object", "properties": { "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list" }, "dropdownDefault": { "type": "boolean", "description": "The default value for dropdown list" } } }, "description": "The dropdown value" }, "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" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" }, "maxTextLength": { "type": "number", "description": "The maximum allowed value for textValue" }, "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", "companyId" ] } ``` *** ## paychex\_company\_create\_company\_custom\_fields\_category Custom Fields Category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | -------------------------------------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `categoryId` | string | No | — | The unique identifier that is autogenerated when creating a category | | `categoryName` | string | No | — | The name of the Category | | `links` | object\[] | No | — | The links value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "categoryId": { "type": "string", "description": "The unique identifier that is autogenerated when creating a category" }, "categoryName": { "type": "string", "description": "The name of the Category" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_create\_company\_jobs Company Job **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `endDate` | string | No | — | The end date associated with this job. | | `jobCorrelationId` | string | No | — | Id that you define which is used for error handling/responses. | | `jobId` | string | No | — | The unique identifier associated with this job. | | `jobName` | string | No | — | The name of the job. | | `jobNumber` | object | No | — | Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments. | | `links` | object\[] | No | — | The links value | | `startDate` | string | No | — | The start date associated with this job. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." }, "endDate": { "type": "string", "description": "The end date associated with this job." }, "jobCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses." }, "jobId": { "type": "string", "description": "The unique identifier associated with this job." }, "jobName": { "type": "string", "description": "The name of the job." }, "jobNumber": { "type": "object", "description": "Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments.", "properties": { "segment1": { "type": "string", "description": "This is segment 1 or the number associated to the job when segmentation is not used." }, "segment2": { "type": "string", "description": "This is segment 2." }, "segment3": { "type": "string", "description": "This is segment 3." } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" }, "startDate": { "type": "string", "description": "The start date associated with this job." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_create\_in\_progress\_workers In Progress Workers **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | The id assigned to the company that workers are being requested for. | | `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. | | `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 state representation of allowed worker job titles configured for the company. | | `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. When POSTING or PATCHING this field the organization must also be present. | | `name` | object | No | — | Data elements of a workers name. | | `organization` | object | No | — | The state representation of Organizations within a company. | | `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. | | `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 | | `workerId` | string | No | — | The unique identifier associated with this worker representation. | | `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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The id assigned to the company that workers are being requested for." }, "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 unique ID associated with communication" }, "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)" } } }, "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." } } }, "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.", "enum": [ "(blank)", "HISPANIC_OR_LATINO", "WHITE_NOT_OF_HISPANIC_ORIGIN", "BLACK_OR_AFRICAN_AMERICAN", "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLAND", "ASIAN", "AMERICAN_INDIAN_OR_ALASKAN_NATIVE", "TWO_OR_MORE_RACES", "PREFER_NOT_TO_ANSWER" ] }, "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 state representation of allowed worker job titles configured for the company.", "properties": { "jobTitleId": { "type": "string", "description": "The unique identifier associated with this job titles representation." }, "title": { "type": "string", "description": "The name of the title." }, "startDate": { "type": "string", "description": "Date when this job is available to be assigned to a worker." }, "endDate": { "type": "string", "description": "Date when this job is no longer available to be assigned to a worker." }, "links": { "type": "array", "items": { "type": "object" }, "description": "The links value" } } }, "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 assigned to a business" } } }, "locationId": { "type": "string", "description": "The workers location. When POSTING or PATCHING this field the organization must also be present." }, "name": { "type": "object", "description": "Data elements of a 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: More than one char is not allowed and returns an error.
A full middle name can be added directly via 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 state representation of Organizations within a company.", "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.", "properties": { "workerId": { "type": "string", "description": "The supervisor Id" }, "name": { "type": "object", "description": "Data elements of a 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" }, "workerId": { "type": "string", "description": "The unique identifier associated with this worker representation." }, "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" ] } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_delete\_custom\_field Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `customFieldId` | string | Yes | — | ID associated with desired custom field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "customFieldId": { "type": "string", "description": "ID associated with desired custom field." } }, "required": [ "PCID", "companyId", "customFieldId" ] } ``` *** ## paychex\_company\_delete\_custom\_fields\_category Custom Fields Category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------ | | `companyId` | string | Yes | — | ID associated with desired company. | | `categoryId` | string | Yes | — | ID associated with desired category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "categoryId": { "type": "string", "description": "ID associated with desired category." } }, "required": [ "PCID", "companyId", "categoryId" ] } ``` *** ## paychex\_company\_get\_1 A Company **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------ | | `companyId` | string | Yes | — | The ID of the company. | | `includelineage` | boolean | No | — | The includelineage value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." }, "includelineage": { "type": "boolean", "description": "The includelineage value" } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_calculation\_bases Company Calculation Bases **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------- | | `companyId` | string | Yes | — | The ID of the company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_companies\_1 Companies **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `displayid` | string | No | — | The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "displayid": { "type": "string", "description": "The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)" } }, "required": [ "PCID" ] } ``` *** ## paychex\_company\_get\_contact\_types Company Contact Types **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_custom\_employment\_types Company Custom Employment Types **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_custom\_field\_by\_id Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `customFieldId` | string | Yes | — | ID associated with desired custom field. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "customFieldId": { "type": "string", "description": "ID associated with desired custom field." } }, "required": [ "PCID", "companyId", "customFieldId" ] } ``` *** ## paychex\_company\_get\_customfields Custom Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_customfieldscategories Custom Fields Categories **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_customfieldscategory Custom Fields Category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------ | | `companyId` | string | Yes | — | ID associated with desired company. | | `categoryId` | string | Yes | — | ID associated with desired category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "categoryId": { "type": "string", "description": "ID associated with desired category." } }, "required": [ "PCID", "companyId", "categoryId" ] } ``` *** ## paychex\_company\_get\_document\_categories Company Document Categories **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_frequency\_combinations Company Pay Frequencies **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------------------ | | `payfrequency` | string | No | — | The frequency that you would like to search for. | | `companyId` | string | Yes | — | The ID of the company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "payfrequency": { "type": "string", "description": "The frequency that you would like to search for." }, "companyId": { "type": "string", "description": "The ID of the company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_job Company Job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `jobId` | string | Yes | — | The ID of the job. | | `asof` | string | No | — | Returns job 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "jobId": { "type": "string", "description": "The ID of the job." }, "asof": { "type": "string", "description": "Returns job as of the date used in the request." } }, "required": [ "PCID", "companyId", "jobId" ] } ``` *** ## paychex\_company\_get\_job\_segments Company Job Segments **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------- | | `companyId` | string | Yes | — | The ID of the company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_jobs Company Jobs **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `asof` | string | No | — | Returns all jobs 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "asof": { "type": "string", "description": "Returns all jobs as of the date used in the request." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_labor\_assignment Company Labor Assignment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ------------------------------------------------------------ | | `companyId` | string | Yes | — | The ID of the company. | | `laborAssignmentId` | string | Yes | — | The ID of the labor assignment. | | `asof` | string | No | — | Returns labor assignment 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "laborAssignmentId": { "type": "string", "description": "The ID of the labor assignment." }, "asof": { "type": "string", "description": "Returns labor assignment as of the date used in the request." } }, "required": [ "PCID", "companyId", "laborAssignmentId" ] } ``` *** ## paychex\_company\_get\_labor\_assignments Company Labor Assignments **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `asof` | string | No | — | Returns all labor assignments 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "asof": { "type": "string", "description": "Returns all labor assignments as of the date used in the request." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_location Company Location **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ---------------------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `locationId` | string | Yes | — | The ID of the location. | | `asof` | string | No | — | Returns location 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" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "locationId": { "type": "string", "description": "The ID of the location." }, "asof": { "type": "string", "description": "Returns location as of the date used in the request." } }, "required": [ "PCID", "companyId", "locationId" ] } ``` *** ## paychex\_company\_get\_locations Company Locations **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `asof` | string | No | — | Returns all locations 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "asof": { "type": "string", "description": "Returns all locations as of the date used in the request." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_non\_worker\_users Company Non Workers Users **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------- | | `companyId` | string | Yes | — | Company Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "Company Id" } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_organizations Company Organizations **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `asof` | string | No | — | Returns all Organizations 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "asof": { "type": "string", "description": "Returns all Organizations as of the date used in the request." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_organizations\_by\_id Company Organization **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ------------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `organizationId` | string | Yes | — | The ID of the organization. | | `asof` | string | No | — | Returns all Organizations 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" }, "companyId": { "type": "string", "description": "The ID of the company." }, "organizationId": { "type": "string", "description": "The ID of the organization." }, "asof": { "type": "string", "description": "Returns all Organizations as of the date used in the request." } }, "required": [ "PCID", "companyId", "organizationId" ] } ``` *** ## paychex\_company\_get\_position Job Title **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `jobTitleId` | string | Yes | — | The ID of the worker job title. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." }, "jobTitleId": { "type": "string", "description": "The ID of the worker job title." } }, "required": [ "PCID", "companyId", "jobTitleId" ] } ``` *** ## paychex\_company\_get\_positions Company Job Titles **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------- | | `companyId` | string | Yes | — | The ID of the company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_state\_taxes Company State Taxes **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `companyId` | string | Yes | — | The id assigned to the company that is being requested for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The id assigned to the company that is being requested for." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_status\_code Company Worker Status **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ---------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `workerStatusId` | string | Yes | — | The ID of the worker status. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." }, "workerStatusId": { "type": "string", "description": "The ID of the worker status." } }, "required": [ "PCID", "companyId", "workerStatusId" ] } ``` *** ## paychex\_company\_get\_status\_codes Company Worker Statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------- | | `companyId` | string | Yes | — | The ID of the company. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_get\_workers Company Workers **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | The id assigned to the company that workers are being requested for. | | `givenname` | string | No | — | The given or first name of the workers to search for. | | `familyname` | string | No | — | The family or last name of the workers to search for. | | `legallastfour` | string | No | — | The last 4 digits of the workers federal level taxpayer id number of the worker to search for. | | `employeeid` | string | No | — | The assigned workers employee ID. | | `from` | string | No | — | The beginning of the search date range using for when the worker was created. | | `to` | string | No | — | The ending of the search date range using for then the worker was created. | | `locationid` | string | No | — | The location id of the worker | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The id assigned to the company that workers are being requested for." }, "givenname": { "type": "string", "description": "The given or first name of the workers to search for." }, "familyname": { "type": "string", "description": "The family or last name of the workers to search for." }, "legallastfour": { "type": "string", "description": "The last 4 digits of the workers federal level taxpayer id number of the worker to search for." }, "employeeid": { "type": "string", "description": "The assigned workers employee ID." }, "from": { "type": "string", "description": "The beginning of the search date range using for when the worker was created." }, "to": { "type": "string", "description": "The ending of the search date range using for then the worker was created." }, "locationid": { "type": "string", "description": "The location id of the worker" } }, "required": [ "PCID", "companyId" ] } ``` *** ## paychex\_company\_update\_company\_custom\_field Custom Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | ID associated with desired company. | | `customFieldId` | string | Yes | — | ID associated with desired custom field. | | `booleanValue` | boolean | No | — | The value for BOOLEAN type (true / false) | | `categoryId` | string | No | — | The unique identifier that is autogenerated when creating a category | | `checkStub` | boolean | No | — | Where to indicate if the custom field is required on the worker's pay stub, where true = required and false = not required | | `customFieldName` | string | No | — | The name of the custom field | | `dateValue` | string | No | — | The value for DATE type , example : 2012-02-01T05:00:00Z | | `dropdown` | object\[] | No | — | The dropdown value | | `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 | | `links` | object\[] | No | — | The links value | | `maxTextLength` | number | No | — | The maximum allowed value for textValue | | `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" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "customFieldId": { "type": "string", "description": "ID associated with desired custom field." }, "booleanValue": { "type": "boolean", "description": "The value for BOOLEAN type (true / false)" }, "categoryId": { "type": "string", "description": "The unique identifier that is autogenerated when creating a category" }, "checkStub": { "type": "boolean", "description": "Where to indicate if the custom field is required on the worker's pay stub, where true = required and false = not required" }, "customFieldName": { "type": "string", "description": "The name of the custom field" }, "dateValue": { "type": "string", "description": "The value for DATE type , example : 2012-02-01T05:00:00Z" }, "dropdown": { "type": "array", "items": { "type": "object", "properties": { "dropdownId": { "type": "string", "description": "The unique identifier that is autogenerated when dropdown list is created" }, "dropdownValue": { "type": "string", "description": "The value for dropdown list" }, "dropdownDefault": { "type": "boolean", "description": "The default value for dropdown list" } } }, "description": "The dropdown value" }, "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" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" }, "maxTextLength": { "type": "number", "description": "The maximum allowed value for textValue" }, "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", "companyId", "customFieldId" ] } ``` *** ## paychex\_company\_update\_company\_custom\_fields\_category Custom Fields Category **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------ | | `companyId` | string | Yes | — | ID associated with desired company. | | `categoryId` | string | Yes | — | ID associated with desired category. | | `categoryName` | string | No | — | The name of the Category | | `links` | object\[] | No | — | The links value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "ID associated with desired company." }, "categoryId": { "type": "string", "description": "ID associated with desired category." }, "categoryName": { "type": "string", "description": "The name of the Category" }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" } }, "required": [ "PCID", "companyId", "categoryId" ] } ``` *** ## paychex\_company\_update\_company\_jobs Company Job **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | Yes | — | The ID of the company. | | `jobId` | string | Yes | — | The ID of the job. | | `effectiveDate` | string | No | — | Date which this pay component has started for the worker. | | `endDate` | string | No | — | The end date associated with this job. | | `jobCorrelationId` | string | No | — | Id that you define which is used for error handling/responses. | | `jobName` | string | No | — | The name of the job. | | `jobNumber` | object | No | — | Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments. | | `links` | object\[] | No | — | The links value | | `startDate` | string | No | — | The start date associated with this job. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "companyId": { "type": "string", "description": "The ID of the company." }, "jobId": { "type": "string", "description": "The ID of the job." }, "effectiveDate": { "type": "string", "description": "Date which this pay component has started for the worker." }, "endDate": { "type": "string", "description": "The end date associated with this job." }, "jobCorrelationId": { "type": "string", "description": "Id that you define which is used for error handling/responses." }, "jobName": { "type": "string", "description": "The name of the job." }, "jobNumber": { "type": "object", "description": "Data elements of a Job Number to show the segments and number.For segmentation this can be up to 3 different segments.", "properties": { "segment1": { "type": "string", "description": "This is segment 1 or the number associated to the job when segmentation is not used." }, "segment2": { "type": "string", "description": "This is segment 2." }, "segment3": { "type": "string", "description": "This is segment 3." } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "rel": { "type": "string", "description": "The rel value" }, "href": { "type": "string", "description": "The href value" }, "hreflang": { "type": "string", "description": "The hreflang value" }, "media": { "type": "string", "description": "The media value" }, "title": { "type": "string", "description": "The title value" }, "type": { "type": "string", "description": "The type value" }, "deprecation": { "type": "string", "description": "The deprecation value" }, "profile": { "type": "string", "description": "The profile value" }, "name": { "type": "string", "description": "The name value" } } }, "description": "The links value" }, "startDate": { "type": "string", "description": "The start date associated with this job." } }, "required": [ "PCID", "companyId", "jobId" ] } ```