Guides
Signup For Free

Paychex API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Paychex API as part of the HRIS category

Add In Progress Workers to a Company

  • ID: create_employee
  • Operation: write
  • Entities:
  • Summary: This API allows you to add one or more workers to a specific company with an IN_PROGRESS status. The workers will be pre-populated within Paychex Flex and require completion to be fully available. Required fields include givenName, familyName, and workerType. When adding multiple workers, a workerCorrelationId is needed for each worker. The API accepts various worker details such as employmentType, hireDate, exemptionType, sex, and more. The response includes the worker's unique identifier, employment details, and communication links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Checks by Pay Period and User

  • ID: delete_checks_by_pay_period_and_user
  • Operation: write
  • Entities: pay period, user, check
  • Summary: The 'Delete Checks by Pay Period and User' API allows users to delete checks associated with a specific pay period and user. It requires two query parameters: 'payperiodid', which is a string representing the ID of the desired pay period, and 'deletebyuserid', a boolean that must be set to 'true'. Upon successful deletion, the API returns a 204 status code indicating a successful operation. If the request is invalid, an error response is returned with details about the error, including an error code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Field at Company Level

  • ID: delete_custom_field_at_company_level
  • Operation: write
  • Entities: custom field, company
  • Summary: This API deletes a custom field at the company level. It requires two path parameters: 'companyId', which is the ID associated with the desired company, and 'customfieldid', which is the ID associated with the desired custom field. The API does not require any headers, query parameters, or request body. A successful operation returns a 204 status code with no content. If there is an error, the response body will contain an array of error objects, each with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Fields Category

  • ID: delete_custom_fields_category
  • Operation: write
  • Entities: custom field category, company
  • Summary: The Delete Custom Fields Category API allows you to delete a custom fields category at the company level. It requires the company ID and category ID as path parameters. The API returns a 204 status code for a successful operation. If there is an error, such as authentication failure, it returns an error object with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete In-progress Worker

  • ID: delete_in_progress_worker
  • Operation: write
  • Entities: error, worker
  • Summary: This API is used to delete an in-progress worker from the system. The request requires a path parameter 'workerId', which is the ID associated with the desired worker to be deleted. If the deletion is successful, a 204 status code is returned with no content. If there is an error, the response will include an error object with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Pay Component of a Check

  • ID: delete_pay_component_of_a_check
  • Operation: write
  • Entities: pay component, error, check
  • Summary: This API deletes a single pay component from an individual unprocessed check. It requires two path parameters: 'checkId', which is the ID associated with the desired check, and 'checkComponentId', which is the ID associated with an earning of this check. Upon successful deletion, the API returns a 204 status code indicating a successful operation. If the request is invalid, it returns an error response with details about the error, including an error code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Unprocessed Worker Check

  • ID: delete_unprocessed_worker_check
  • Operation: write
  • Entities: pay period, check, worker
  • Summary: This API allows the removal of a specific unprocessed check for a worker. It requires the worker's ID and the external check ID as path parameters. Upon successful deletion, it returns a response with details about the worker, the check, and associated pay components such as earnings, deductions, informational, and taxes. The response also includes optional fields like checkCorrelationId and blockAutoDistribution for error handling and distribution control.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Webhook

  • ID: delete_webhook
  • Operation: write
  • Entities: webhook, application
  • Summary: The Delete Webhook API allows the calling application to delete a specific webhook by its ID. The API requires the 'hookId' as a path parameter, which is mandatory. Upon successful deletion, the API returns a 204 status code indicating that the webhook was successfully deleted. If there are any errors, such as authentication issues, the API returns an error object with details including an error code, description, and resolution steps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Worker Communication Item

  • ID: delete_worker_communication_item
  • Operation: write
  • Entities: link, communication, worker
  • Summary: The Remove Worker Communication Item API allows you to delete a specific communication item from a worker's profile, provided the worker is in an 'Active' or 'In-progress' state. The API requires two path parameters: 'workerId', which is the unique identifier for the worker, and 'communicationId', which is the unique identifier for the communication item to be removed. Upon successful deletion, the API returns a response with details of the communication item that was removed, including its type, usage type, and associated URI. The response also includes a link to the deleted communication item.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Worker Compensation Pay Rate

  • ID: delete_worker_compensation_pay_rate
  • Operation: write
  • Entities: compensation rate, worker
  • Summary: This API endpoint allows the removal of a compensation rate from a worker. It requires two path parameters: 'workerId', which is the ID associated with the desired worker, and 'rateId', which is the ID of the worker's compensation rate to be removed. Upon successful deletion, the API returns a 204 status code. If the request is invalid, an error response is provided with details about the error, including an error code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Worker Contact

  • ID: delete_worker_contact
  • Operation: write
  • Entities: contact, worker
  • Summary: The Delete Worker Contact API allows you to delete a worker contact by specifying the contactId in the path parameters. The API requires two path parameters: workerId, which is the ID associated with the desired worker, and contactId, which is the ID associated with the desired worker contact. Upon successful deletion, the API returns a 204 status code indicating a successful operation. If the request is invalid, an error response is returned with details about the error, including an error code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Worker Custom Field

  • ID: delete_worker_custom_field
  • Operation: write
  • Entities: custom field, worker
  • Summary: The Delete Worker Custom Field API allows you to delete a custom field at the worker level. It requires two path parameters: 'workerId', which is the ID associated with the desired worker, and 'workerCustomFieldId', which is the ID associated with the desired worker custom field. The API uses the DELETE method and returns a 204 status code for a successful operation. If the request is invalid, it returns an error object with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Direct Deposit Deletion

  • ID: delete_worker_direct_deposit
  • Operation: write
  • Entities: direct deposit, worker
  • Summary: This API endpoint allows the deletion of a single direct deposit for an 'Active' worker. It requires the worker's ID and the direct deposit ID as path parameters. An optional query parameter 'effectivitydate' can be provided to specify the effectivity date. Upon successful deletion, a 204 status code is returned. If the request is invalid, an error response is provided with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Federal Tax Deletion

  • ID: delete_worker_federal_tax
  • Operation: write
  • Entities: federal tax, worker
  • Summary: This API endpoint is used to remove the federal tax setup for an 'In-progress' worker. It requires the worker's ID as a path parameter. Upon successful deletion, it returns a 204 status code indicating that the worker's federal tax setup has been successfully deleted. If the request is invalid, it returns an error message with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove Worker Pay Component

  • ID: delete_worker_pay_component
  • Operation: write
  • Entities: pay component, worker
  • Summary: The Remove Worker Pay Component API allows you to delete a specific pay component from an active worker's profile. It requires two path parameters: 'workerId', which is the ID of the worker, and 'workerComponentId', which is the ID of the pay component to be removed. The API returns a 204 status code for a successful operation. If the request is invalid, it returns an error object with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Combined Employee Compensation Information

  • ID: get_all_compensation_information_for_an_employee
  • Operation: read
  • Entities:
  • Summary: This API configuration fetches a combined list of employee compensation information by utilizing three different APIs: 'get_worker_pay_component', 'get_worker_compensation_pay_rates', and 'get_worker_compensation_pay_standards'. The input requires the worker's ID as a path parameter and optionally accepts a date as a query parameter to return data as of that date. The combined output includes details such as pay component ID, name, calculation type, value, start and end dates, effect on pay, classification type, rate ID, rate type, description, amount, standard hours, pay frequency, overtime factor, calculated pay period, and calculated annual salary. The response also includes links for each component and rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Direct Deposits Retrieval

  • ID: get_bank_accounts_for_employee
  • Operation: read
  • Entities:
  • Summary: This API retrieves an array of direct deposits for an active worker specified by the workerId path parameter. The API supports optional query parameters such as effectivitydate and asof to filter the results based on specific dates. The response includes details of each direct deposit such as directDepositId, startDate, paymentType, accountType, value, routingNumber, accountNumber, priority, and links to the direct deposit resources.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Companies List

  • ID: get_companies_list
  • Operation: read
  • Entities: legal id, company, communication
  • Summary: The Get Companies List API retrieves an array of companies that the application has been granted access to. The API uses an optional query parameter 'displayid' to filter the companies by their client account number. The response includes details such as the company ID, display ID, legal name, legal ID, communications, and links related to each company. The response is returned in JSON format with metadata indicating the number of content items.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Calculation Bases

  • ID: get_company_calculation_bases
  • Operation: read
  • Entities: pay component, company, calculation base
  • Summary: The Get Company Calculation Bases API retrieves an array of calculation bases used with worker pay components that are not FLAT_DOLLAR_AMOUNT. This allows you to determine what to apply the calculation against when determining the amount during the pay run. The API requires a path parameter 'companyId' which is the ID of the company. The response includes a list of calculation bases, each with a unique ID and name, and a self-referential link to the resource.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Checks

  • ID: get_company_checks
  • Operation: read
  • Entities: pay period, company, check
  • Summary: The Get Company Checks API retrieves checks for a specific company within a processed or unprocessed pay period. It requires the company ID as a path parameter and the pay period ID as a query parameter. Optional query parameters include offset, limit, and filter by user ID. The response includes details about each check, such as worker ID, paycheck ID, pay period ID, earnings, deductions, check date, informational components, taxes, and links. The earnings section provides detailed information about pay components, including pay rate, hours, units, and organization details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Contact Types

  • ID: get_company_contact_types
  • Operation: read
  • Entities: contact type, relationship type, company
  • Summary: The 'Get Company Contact Types' API retrieves information about contact types that the application has been granted access to for a specific company. The API requires a path parameter 'companyId' which is the ID associated with the desired company. The response includes a list of contact types, each with a unique 'contactTypeId' and 'contactTypeName', as well as associated 'relationshipTypes' which detail various relationship types such as 'Spouse', 'Parent', 'Sibling', etc. The response also includes an array of 'links' related to the contact types.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Information

  • ID: get_company_information
  • Operation: read
  • Entities: legal id, company, communication
  • Summary: This API retrieves information about a single company that the application has access to. It requires the 'companyId' as a path parameter, which is a unique identifier for the company. The response includes details such as the company's legal name, display ID, legal ID, communications, and related links. The response is returned in the 'application/vnd.paychex.company.v1+json' format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Job Details

  • ID: get_company_job_details
  • Operation: read
  • Entities: job segment, job, company
  • Summary: This API retrieves detailed information about a specific job within a company. It requires the company ID and job ID as path parameters. Optionally, a query parameter 'asof' can be used to specify the date for which the job details are requested. The response includes the job's unique identifier, correlation ID, name, start and end dates, and additional job number segmentation details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Company Job Segments

  • ID: get_company_job_segments
  • Operation: read
  • Entities: segment, job, company
  • Summary: This API retrieves the job segment structure setup for a specified company. It is available only if the client's job numbering is set up in 2-3 separate segments. The request requires the company ID as a path parameter. The response includes the segment number, segment name, and segment length for each segment, allowing the client to understand the job segment structure and prepare for further operations such as POST.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Job Titles

  • ID: get_company_job_titles
  • Operation: read
  • Entities: worker, company, job title
  • Summary: The Get Company Job Titles API retrieves an array of job titles set at the company level which a worker could be assigned. It requires the company ID as a path parameter. The response includes a list of job titles with details such as jobTitleId, title, startDate, endDate, and links. The response is returned in the application/vnd.paychex.company.jobtitles.v1+json format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Jobs

  • ID: get_company_jobs
  • Operation: read
  • Entities: job, company
  • Summary: The Get Company Jobs API retrieves an array of jobs set at the company level. It requires the company ID as a path parameter and optionally accepts a query parameter 'asof' to filter jobs as of a specific date. The response includes details such as job ID, job name, start and end dates, and job number segments.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Company Labour Assignment Retrieval

  • ID: get_company_labour_assignment
  • Operation: read
  • Entities: organization, labor assignment, company
  • Summary: This API retrieves information about a single labor assignment for a specified company. It requires the company ID and labor assignment ID as path parameters. An optional query parameter 'asof' can be used to specify the date for which the labor assignment information is requested. The response includes details such as the labor assignment ID, name, start and end dates, organization ID, position ID, and location ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Company Labour Assignments

  • ID: get_company_labour_assignments
  • Operation: read
  • Entities: position, labor assignment, company
  • Summary: The Company Labour Assignments API retrieves an array of labor assignments set at the company level. It requires the company ID as a path parameter and optionally accepts a query parameter 'asof' to filter assignments as of a specific date. The response includes details such as laborAssignmentId, name, startDate, endDate, organizationId, positionId, and locationId for each labor assignment.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Location Information

  • ID: get_company_location_information
  • Operation: read
  • Entities: location, address, company
  • Summary: This API retrieves information about a specific location associated with a company. It requires the company ID and location ID as path parameters. Optionally, a query parameter 'asof' can be provided to get the location details as of a specific date. The response includes details such as the location ID, name, address, and the dates when the location was moved in or out.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Locations

  • ID: get_company_locations
  • Operation: read
  • Entities: location, address, company
  • Summary: The Get Company Locations API retrieves an array of locations set at the company level. It requires the companyId as a path parameter to identify the company. Optionally, a query parameter 'asof' can be used to specify the date for which the locations should be returned. The response includes a list of locations with details such as locationId, name, address, and the dates when the location was moved in or out.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Information

  • ID: get_company_of_employee
  • Operation: read
  • Entities:
  • Summary: This API retrieves information about a single company that the application has access to. It requires the 'companyId' as a path parameter, which is a unique identifier for the company. The response includes details such as the company's legal name, display ID, legal ID, communications, and related links. The response is returned in the 'application/vnd.paychex.company.v1+json' format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Organization Details

  • ID: get_company_organization_details
  • Operation: read
  • Entities: organization, link, company
  • Summary: This API retrieves detailed information about a specific organization within a company. It requires the company ID and organization ID as path parameters. Optionally, a query parameter 'asof' can be used to specify the date for which the organization details are required. The response includes the organization's ID, name, number, level, and related links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Organizations

  • ID: get_company_organizations
  • Operation: read
  • Entities: organization, link, company
  • Summary: The Get Company Organizations API retrieves an array of organizations set at the company level. It requires the company ID as a path parameter and optionally accepts a query parameter 'asof' to return organizations as of a specific date. The response includes metadata about the number of organizations returned and a list of organization objects, each containing details such as organizationId, name, number, level, and related links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Pay Component Details

  • ID: get_company_pay_component_details
  • Operation: read
  • Entities: pay component, worker type, company
  • Summary: This API retrieves the details of a specific pay component associated with a company. It requires the company ID and pay component ID as path parameters. Optionally, a query parameter 'asof' can be used to specify the date for which the pay component details are required. The response includes details such as component ID, name, classification type, description, effect on pay, applicable worker types, and more. The response also includes links related to the pay component.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Company Pay Components Retrieval

  • ID: get_company_pay_components
  • Operation: read
  • Entities: pay component, worker type, company
  • Summary: The Company Pay Components Retrieval API allows users to retrieve an array of pay components configured for a specific company. These components include earnings and deductions used for payroll. The API requires a path parameter 'companyId' to specify the company. Optional query parameters include 'effectonpay', 'asof', 'classificationtype', and 'name' to filter the results. The response includes details such as componentId, name, classificationType, description, effectOnPay, startDate, endDate, and appliesToWorkerTypes, among others. The API returns a successful operation with a 200 status code and provides a list of pay components and their details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Pay Frequencies

  • ID: get_company_pay_frequencies
  • Operation: read
  • Entities: pay component frequency, pay frequency, company
  • Summary: The Get Company Pay Frequencies API retrieves an array of pay frequencies that workers may be paid on for a specified company. The endpoint requires a path parameter 'companyId' which is the ID of the company. Optionally, a query parameter 'payfrequency' can be provided to filter the results by a specific frequency. The response includes a list of pay frequencies, each with details about how the pay component is applied, its occurrence, and intervals. The response also includes metadata about the number of content items and links for navigation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Pay Period

  • ID: get_company_pay_period
  • Operation: read
  • Entities: pay period, company, payroll
  • Summary: The Get Company Pay Period API retrieves details of a specific pay period for a given company. It requires the companyId and payperiodId as path parameters. The response includes detailed information about the pay period such as its unique identifier, frequency, status, description, start and end dates, submission and check dates, check count, and original pay period ID if applicable. The response also includes metadata and links related to the pay period.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Pay Periods

  • ID: get_company_pay_periods
  • Operation: read
  • Entities: pay period, company
  • Summary: The Get Company Pay Periods API retrieves an array of pay periods associated with a specified company. The API requires a path parameter 'companyId' to identify the company. Optional query parameters include 'status' to filter pay periods by specific statuses, 'from' to specify the start date of the search range, and 'to' to specify the end date of the search range. The response includes metadata about the number of pay periods returned, and a list of pay periods with details such as payPeriodId, intervalCode, status, description, startDate, endDate, submitByDate, checkDate, checkCount, and originalPayPeriodID if applicable. The response also includes links for navigation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Worker Status

  • ID: get_company_worker_status
  • Operation: read
  • Entities: worker status, status type, company
  • Summary: The Get Company Worker Status API retrieves information about a single worker status for a specified company. It requires two path parameters: 'companyId', which is the ID of the company, and 'workerStatusId', which is the ID of the worker status. The response includes details such as the workerStatusId, statusType, statusReason, and any related links. The response is returned in JSON format with a content type of application/vnd.paychex.company.workerstatus.v1+json.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Worker Statuses

  • ID: get_company_worker_statuses
  • Operation: read
  • Entities: worker status, link, company
  • Summary: The Get Company Worker Statuses API retrieves an array of statuses set at the company level which a worker could be assigned. It requires the company ID as a path parameter. The response includes a list of worker statuses, each with a unique identifier, status type, and status reason. The response is in JSON format and includes metadata about the number of items returned, as well as links for navigation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Workers

  • ID: get_company_workers
  • Operation: read
  • Entities: supervisor, company, worker
  • Summary: The Get Company Workers API retrieves an array of workers (employees and contractors) associated with a specific company. The API requires a path parameter 'companyId' to identify the company. It supports various query parameters for filtering, such as 'givenname', 'familyname', 'legallastfour', 'employeeid', 'from', 'to', and 'locationid'. The response includes detailed information about each worker, such as 'workerId', 'employeeId', 'workerType', 'employmentType', 'exemptionType', 'birthDate', 'sex', 'ethnicityCode', 'hireDate', and more. The API returns a JSON response with metadata and content containing worker details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Field Information

  • ID: get_custom_field_information
  • Operation: read
  • Entities: custom field, category, company
  • Summary: This API retrieves information about a single custom field for a specified company. It requires two path parameters: 'companyId', which is the ID associated with the desired company, and 'customFieldId', which is the ID associated with the desired custom field. The response includes details such as the custom field's ID, name, category ID, whether it is required, if it appears on the check stub, if it is editable by the employee, the type of the field, and its value depending on the type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Fields Categories

  • ID: get_custom_fields_categories
  • Operation: read
  • Entities: category, company
  • Summary: This API retrieves an array of custom fields categories configured at the company level. It requires the company ID as a path parameter to identify the desired company. The response includes a list of categories, each with a unique category ID and name. The response is structured with metadata indicating the number of content items and an array of category objects.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Fields Category

  • ID: get_custom_fields_category
  • Operation: read
  • Entities: custom field category, company
  • Summary: This API retrieves information about a single CustomFieldsCategory for a specified company. It requires two path parameters: 'companyId', which is the ID associated with the desired company, and 'categoryId', which is the ID associated with the desired category. The response includes the category's unique identifier and name, along with any associated links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Custom Fields Configured at Company Level

  • ID: get_custom_fields_configured_at_company_level
  • Operation: read
  • Entities: custom field, category, company
  • Summary: This API retrieves an array of custom fields configured at the company level for a specified company ID. The request requires a path parameter 'companyId' which is the ID associated with the desired company. The response includes details about each custom field such as its ID, name, category ID, whether it is required, if it appears on the check stub, if it is editable by the employee, its type, and its value depending on the type. The types can be DROPDOWN, TEXT, BOOLEAN, DATE, or NUMERIC with various formats. The response is returned in JSON format with a content type of application/vnd.paychex.company.customfields.v1+json.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Pay Components

  • ID: get_deductions_for_employee
  • Operation: read
  • Entities:
  • Summary: The Get Worker Pay Components API retrieves all pay components for a specific 'Active' worker. It requires the workerId as a path parameter. Optional query parameters include effectonpay, asof, name, componentid, and classificationtype to filter the results. The response includes details of each pay component such as workerComponentId, componentId, name, calculationType, value, startDate, effectOnPay, checkLimit, frequency, and links to related resources.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Information

  • ID: get_employee_details_by_employee_identifier
  • Operation: read
  • Entities:
  • Summary: This API retrieves information about a unique worker (employee or contractor) that the application has access to within the Paychex Flex payroll system. The API requires a path parameter 'workerId' which is the ID associated with the desired worker. The response includes detailed information about the worker such as workerId, employeeId, workerType, employmentType, exemptionType, birthDate, sex, ethnicityCode, hireDate, clockId, name, legalId, laborAssignmentId, locationId, jobId, job, organization, supervisor, currentStatus, communications, links, and workerCorrelationId. The workerType can be EMPLOYEE, CONTRACTOR, or INDEPENDENT_CONTRACTOR, and the employmentType can be FULL_TIME or PART_TIME.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Title Information

  • ID: get_job_title_information
  • Operation: read
  • Entities: link, company, job title
  • Summary: This API retrieves information about a specific job title within a company. It requires the company ID and the worker job title ID as path parameters. The response includes details such as the job title ID, name, start date, end date, and related links. The API returns a successful operation with a 200 status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Webhooks

  • ID: get_list_webhooks
  • Operation: read
  • Entities: domain, webhook, company
  • Summary: The List Webhooks API allows the calling application to retrieve all the webhooks that have been set up. It uses the GET method and the endpoint is https://api.paychex.com/management/hooks. The API does not require any input parameters in the headers, path, query, or body. Upon a successful call, it returns a 200 status code with a response body containing an array of webhook objects. Each webhook object includes details such as hookId, companyId, uri, authType, createdDate, and domains.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Specific Webhook by ID

  • ID: get_specific_webhook_by_id
  • Operation: read
  • Entities: domain, webhook, company
  • Summary: This API retrieves a specific webhook for the calling application by its unique identifier (hookId). The request requires the hookId as a path parameter. Upon a successful request, it returns details about the webhook, including its hookId, companyId, URI, authentication type, creation date, and associated domains.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Federal Tax Details

  • ID: get_w4_details_of_employee
  • Operation: read
  • Entities:
  • Summary: This API retrieves the federal tax setup details for a worker who is either 'Active' or 'In-progress'. The request requires a path parameter 'workerId' which is the ID associated with the desired worker. The response includes details such as the tax ID, filing status, multiple jobs indicator, dependents amount, other income, deductions amount, extra withholding amount, and whether federal taxes should be withheld.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Webhook Domains

  • ID: get_webhook_domains
  • Operation: read
  • Entities: domain, application type
  • Summary: The Get Webhook Domains API retrieves a list of available domains for webhooks based on the application type. It uses the GET method and the endpoint is https://api.paychex.com/management/domains. The API does not require any headers, path parameters, query parameters, or request body. Upon a successful request, it returns a 200 status code with a JSON array in the response body, containing a list of domain strings such as 'WRKR_TAX', 'CLT_ORG', etc.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Assignment Distributions

  • ID: get_worker_assignment_distributions
  • Operation: read
  • Entities: worker, job, assignment distribution
  • Summary: The Get Worker Assignment Distributions API retrieves an array of assignments that are used for auto distribution assigned to a specific worker. The API requires the worker's ID as a path parameter. Upon a successful request, it returns a list of assignment distributions, each containing a job ID, labor assignment ID, and the allocation value as a percentage.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Worker Check Details

  • ID: get_worker_check_details
  • Operation: read
  • Entities: worker, check, earning
  • Summary: This API retrieves a specific unprocessed or processed check for a worker using the worker's ID and the check's ID. The request requires two path parameters: 'workerId' and 'externalCheckId', both of which are mandatory. The response includes detailed information about the check, such as the worker ID, paycheck ID, pay period ID, earnings, deductions, informational components, and taxes associated with the check. The response is structured in a JSON format, providing comprehensive details about each component of the check.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Checks

  • ID: get_worker_checks
  • Operation: read
  • Entities: pay period, check, worker
  • Summary: The Get Worker Checks API retrieves checks for a specific worker within a processed or unprocessed pay period. It requires the worker's ID as a path parameter and the pay period ID as a query parameter. An optional query parameter allows filtering by user ID. The response includes detailed information about the checks, such as pay period ID, paycheck ID, worker ID, check date, net pay, check type, check number, earnings, deductions, informational components, and taxes. Each component includes details like component ID, name, classification type, effect on pay, and amount. The API returns a list of checks with associated metadata and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Communication Details

  • ID: get_worker_communication_details
  • Operation: read
  • Entities: link, communication, worker
  • Summary: The Get Worker Communication Details API retrieves a single communication item for a specified worker. It requires two path parameters: 'workerId', which is the ID assigned to the worker, and 'communicationId', which is the ID of the specific communication item. The response includes details such as the communication ID, type, usage type, URI, and links. The communication type can be one of several predefined types, such as EMAIL or PHONE, and the usage type indicates whether the communication method is for business or personal use.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Communications

  • ID: get_worker_communications
  • Operation: read
  • Entities: link, communication, worker
  • Summary: The Get Worker Communications API retrieves information about 'Active' or 'In-progress' worker communications. It requires a path parameter 'workerId' which is the ID assigned to the worker whose communications are being requested. The response includes a list of communication items, each with details such as communicationId, type, usageType, and contact information like dialCountry, dialArea, dialNumber, and uri. The response also includes links for each communication item and overall links for the communications resource.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Compensation Details

  • ID: get_worker_compensation_details
  • Operation: read
  • Entities: pay rate, compensation, worker
  • Summary: The Worker Compensation Details API retrieves information about a worker's compensation using the worker's ID. The API requires a path parameter 'workerId' which is a string representing the ID of the worker whose compensation details are to be fetched. The response includes an array of compensation details and links to related resources such as pay rates and pay standards.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Compensation Pay Rates

  • ID: get_worker_compensation_pay_rates
  • Operation: read
  • Entities: pay rate, compensation, worker
  • Summary: This API retrieves information about a worker's compensation rates. It requires the worker's ID as a path parameter and optionally accepts a date as a query parameter to return all pay rates as of that date. The response includes details such as rate ID, start date, rate number, rate type, description, amount, standard hours, standard overtime, and whether the rate is default. The response also includes links for each rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Compensation Pay Standards

  • ID: get_worker_compensation_pay_standards
  • Operation: read
  • Entities: worker, compensation, pay standard
  • Summary: This API retrieves the compensation pay standards for a specific worker identified by the workerId path parameter. The response includes details such as the pay frequency, default overtime factor, calculated pay period, calculated annual salary, and calculated annual salary from historical data. The payFrequency can be one of the following: WEEKLY, BI_WEEKLY, SEMI_MONTHLY, or MONTHLY. The API returns a JSON response with the compensation details and a self-referential link.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Contact by Contact ID

  • ID: get_worker_contact_by_contact_id
  • Operation: read
  • Entities: contact, relationship, worker
  • Summary: This API retrieves a specific contact for a worker using the contactId. It requires two path parameters: workerId, which is the ID associated with the desired worker, and contactId, which is the ID of the specific contact. The response includes details about the contact such as contactId, contactType, and relationship information, including communication details like phone, postal address, and email.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Contacts

  • ID: get_worker_contacts
  • Operation: read
  • Entities: contact, relationship, worker
  • Summary: The Get Worker Contacts API retrieves all contacts associated with a specified worker. The API requires a path parameter 'workerId' which is the ID of the worker whose contacts are to be retrieved. The response includes a list of contacts, each with a unique 'contactId', 'contactType', and 'relationship' details. The 'relationship' object contains information about the relationship type, whether it is primary, and details about the person or entity associated with the contact. The response also includes communication details such as phone numbers, postal addresses, and email addresses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker's Custom Field by ID

  • ID: get_worker_custom_field_by_id
  • Operation: read
  • Entities: custom field, worker custom field, worker
  • Summary: This API retrieves a worker's custom field by the specified workerCustomFieldId. It requires the workerId and workerCustomFieldId as path parameters. Optionally, a query parameter 'asof' can be used to specify the date for which the custom field should be returned. The response includes details about the custom field such as its ID, type, value, and other attributes like whether it is required, editable by the employee, or shown on the check stub.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker's Custom Fields

  • ID: get_worker_custom_fields
  • Operation: read
  • Entities: dropdown list, custom field, worker
  • Summary: This API retrieves the custom fields associated with a specific worker identified by the workerId path parameter. The request can include an optional query parameter 'asof' to specify the date for which the custom fields should be returned. The response includes a list of custom fields with details such as workerCustomFieldId, customFieldId, type, and values specific to the type of custom field (e.g., textValue, booleanValue, etc.). Additional metadata about the number of custom fields returned is also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Direct Deposit Details

  • ID: get_worker_direct_deposit_details
  • Operation: read
  • Entities: direct deposit, worker
  • Summary: This API retrieves the details of a specific direct deposit for an active worker. It requires the worker's ID and the direct deposit ID as path parameters. Optionally, an effectivity date can be provided as a query parameter. The response includes details such as the direct deposit ID, start date, payment type, account type, value, routing number, account number, priority, and related links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Direct Deposits Retrieval

  • ID: get_worker_direct_deposits
  • Operation: read
  • Entities: direct deposit, link, worker
  • Summary: This API retrieves an array of direct deposits for an active worker specified by the workerId path parameter. The API supports optional query parameters such as effectivitydate and asof to filter the results based on specific dates. The response includes details of each direct deposit such as directDepositId, startDate, paymentType, accountType, value, routingNumber, accountNumber, priority, and links to the direct deposit resources.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Federal Tax Details

  • ID: get_worker_federal_tax_details
  • Operation: read
  • Entities: federal tax, worker
  • Summary: This API retrieves the federal tax setup details for a worker who is either 'Active' or 'In-progress'. The request requires a path parameter 'workerId' which is the ID associated with the desired worker. The response includes details such as the tax ID, filing status, multiple jobs indicator, dependents amount, other income, deductions amount, extra withholding amount, and whether federal taxes should be withheld.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Information

  • ID: get_worker_information
  • Operation: read
  • Entities: organization, job, worker
  • Summary: This API retrieves information about a unique worker (employee or contractor) that the application has access to within the Paychex Flex payroll system. The API requires a path parameter 'workerId' which is the ID associated with the desired worker. The response includes detailed information about the worker such as workerId, employeeId, workerType, employmentType, exemptionType, birthDate, sex, ethnicityCode, hireDate, clockId, name, legalId, laborAssignmentId, locationId, jobId, job, organization, supervisor, currentStatus, communications, links, and workerCorrelationId. The workerType can be EMPLOYEE, CONTRACTOR, or INDEPENDENT_CONTRACTOR, and the employmentType can be FULL_TIME or PART_TIME.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Worker Pay Component

  • ID: get_worker_pay_component
  • Operation: read
  • Entities: calculation type, pay component, worker
  • Summary: This API retrieves a specific pay component for an 'Active' worker using the worker's ID and the pay component ID. The API requires two path parameters: 'workerId' and 'workerComponentId', both of which are mandatory. An optional query parameter 'asof' can be used to specify the date for which the pay component should be returned. The response includes details such as the component ID, name, calculation type, value, start and end dates, effect on pay, classification type, and related links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Pay Components

  • ID: get_worker_pay_components
  • Operation: read
  • Entities: deduction, pay component, worker
  • Summary: The Get Worker Pay Components API retrieves all pay components for a specific 'Active' worker. It requires the workerId as a path parameter. Optional query parameters include effectonpay, asof, name, componentid, and classificationtype to filter the results. The response includes details of each pay component such as workerComponentId, componentId, name, calculationType, value, startDate, effectOnPay, checkLimit, frequency, and links to related resources.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Worker Pay Rate

  • ID: get_worker_pay_rate
  • Operation: read
  • Entities: pay rate, compensation, worker
  • Summary: The Worker Pay Rate API retrieves a single compensation rate for a specified worker. It requires the worker's ID and the rate ID as path parameters. An optional query parameter 'asof' can be used to specify the date for which the compensation rate is returned. The response includes details such as the rate ID, start date, rate number, rate type, amount, and whether it is the default rate. The response also includes links related to the rate.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Worker Statuses

  • ID: get_worker_statuses
  • Operation: read
  • Entities: status, company, worker
  • Summary: The Retrieve Worker Statuses API allows clients to fetch the full list of statuses for a specific worker, including past, present, and future statuses. The API requires a path parameter 'workerId' which is the ID associated with the desired worker. The response includes a list of status objects, each containing details such as 'workerStatusId', 'statusType', 'statusReason', 'effectiveDate', and 'order'. The 'workerStatusId' is omitted if no matching company worker status exists. The 'order' field indicates the sequence of statuses if multiple statuses share the same effective date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Time Off Balances

  • ID: get_worker_time_off_balances
  • Operation: read
  • Entities: balance, policy, worker
  • Summary: This API retrieves an array of time off balances for a worker, categorized by each policy type of time off. The endpoint requires the worker's ID as a path parameter. The response includes details such as the policy ID, type, name, balance, and measurement type (HOURS or UNITS) for each time off policy. This data is available only if the client has the Time Off Accrual product.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Batch Update Worker Pay Components

  • ID: patch_batch_update_worker_pay_components
  • Operation: write
  • Entities: worker pay component, pay component, worker
  • Summary: This API allows for batch updating of pay components associated with an 'Active' worker. The PATCH request is sent to the endpoint with the worker's ID as a path parameter. The request body contains an array of pay components, each with a workerComponentId, componentId, and value. The response returns the updated pay components with details such as name, calculationType, value, startDate, effectOnPay, checkLimit, frequency, and links. The API is useful for updating multiple pay components for a worker in a single request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Custom Fields Category at Company Level

  • ID: patch_custom_fields_category_at_company_level
  • Operation: write
  • Entities: custom field category, link, company
  • Summary: This API allows updating a custom fields category at the company level. It requires the company ID and category ID as path parameters. The request body can include the category name and an array of link objects. Upon a successful operation, it returns the updated category details including the autogenerated category ID and the category name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Company Job

  • ID: patch_update_company_job
  • Operation: write
  • Entities: job, company
  • Summary: The Update Company Job API allows you to update details of a specific job within a company. You need to provide the company ID and job ID as path parameters. The request body can include job details such as jobCorrelationId, jobName, startDate, endDate, effectiveDate, links, and jobNumber. The response returns the updated job details including jobId, jobName, startDate, and jobNumber.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Custom Fields at Company Level

  • ID: patch_update_custom_fields_at_company_level
  • Operation: write
  • Entities: custom field, company
  • Summary: This API allows updating custom fields at the company level. It requires the company ID and custom field ID as path parameters. The request body includes details such as the custom field name, category ID, whether the field is required, if it should appear on the check stub, if it is editable by the employee, the type of the field, and its value. The response returns the updated custom field details including its ID, name, category ID, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Pay Component on Unprocessed Check

  • ID: patch_update_pay_component_on_unprocessed_check
  • Operation: write
  • Entities: pay component, check, worker
  • Summary: This API allows updating a single pay component on an individual unprocessed check. It requires the checkId and checkComponentId as path parameters to identify the specific check and component. The request body includes details about the pay component such as name, classification type, effect on pay, and other optional fields like jobId, laborAssignmentId, and pay details. The response returns the updated pay component details including componentId, checkComponentId, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Contact

  • ID: patch_update_worker_contact
  • Operation: write
  • Entities: contact, communication, worker
  • Summary: The Update Worker Contact API allows you to update a contact for a specific worker. A contact can represent either a person or an entity, but not both. Each contact must have at least one communication method, such as telecom, postal, or email. Person contacts can have multiple communications for each type to support both BUSINESS and PERSONAL categories. Exactly one contact must be marked as primary for each type. When a new contact is set as primary, the previous primary contact is updated to not primary. Postal contacts can switch between street addresses and PO boxes by setting either streetLineOne or postOfficeBox, but not both. The API requires the workerId and contactId as path parameters. The request body can include the contactId, contactType, and relationship details. The response will return the updated contact details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Custom Field

  • ID: patch_update_worker_custom_field
  • Operation: write
  • Entities: custom field, worker
  • Summary: This API allows updating a custom field at the worker level. It requires the worker ID and the worker custom field ID as path parameters. The request body can include various attributes of the custom field such as customFieldId, dropdownId, dropdownValue, and others. The response returns the updated custom field details including workerCustomFieldId, customFieldId, dropdownId, dropdownValue, and customFieldName.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Details

  • ID: patch_update_worker_details
  • Operation: write
  • Entities: organization, job, worker
  • Summary: The Update Worker Details API allows you to modify the details of a specific worker (employee or contractor) that your application has access to. The API endpoint requires a path parameter 'workerId' to identify the worker. The request body can include various fields such as 'employeeId', 'employmentType', 'birthDate', 'sex', 'clockId', 'name', 'job', 'organization', and 'currentStatus'. Some fields like 'workerType', 'exemptionType', 'ethnicityCode', 'hireDate', 'legalId', 'laborAssignmentId', 'locationId', 'jobId', and 'communications' cannot be updated for active workers. The response returns the updated worker details including 'workerId', 'employeeId', 'workerType', 'employmentType', 'exemptionType', 'workState', 'birthDate', 'sex', 'ethnicityCode', 'hireDate', 'clockId', 'name', 'legalId', 'laborAssignmentId', 'locationId', 'job', 'organization', 'supervisor', 'currentStatus', and 'links'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Communication

  • ID: patch_worker_communication
  • Operation: write
  • Entities: link, communication, worker
  • Summary: The Update Worker Communication API allows you to update specific communication details for a worker identified by workerId and communicationId. The API supports updating fields such as streetLineOne, streetLineTwo, city, postalCode, and countryCode. Some fields like type, usageType, and postOfficeBox cannot be patched. The response returns the updated communication details including the communicationId, type, usageType, and address details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Compensation Pay Rate

  • ID: patch_worker_compensation_pay_rate
  • Operation: write
  • Entities: pay rate, compensation, worker
  • Summary: This API allows updating a specific compensation rate for a worker. The PATCH request requires the workerId and rateId as path parameters. The request body includes details such as startDate, rateNumber, rateType, description, amount, standardHours, standardOvertime, default, effectiveDate, and links. The response returns the updated pay rate details including rateId, startDate, rateNumber, rateType, description, amount, standardHours, standardOvertime, default, effectiveDate, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Direct Deposit

  • ID: patch_worker_direct_deposit
  • Operation: write
  • Entities: direct deposit, financial institution, worker
  • Summary: The Update Worker Direct Deposit API allows you to update a single direct deposit for an 'Active' worker. The API requires the workerId and directDepositId as path parameters. Optionally, you can provide an effectivity date as a query parameter. The request body can include the paymentType, accountType, value, routingNumber, accountNumber, and priority, although some fields cannot be patched. The response returns the updated direct deposit details, including the directDepositId, startDate, paymentType, accountType, value, routingNumber, accountNumber, priority, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Direct Deposits

  • ID: patch_worker_direct_deposits
  • Operation: write
  • Entities: direct deposit, payment, worker
  • Summary: This API allows updating multiple direct deposits for an 'Active' worker at once. The PATCH request is sent to the endpoint with the worker's ID as a path parameter. The request can include an optional query parameter 'effectivitydate' to specify the effectivity date. The request body contains an array of direct deposit objects, each with properties such as 'directDepositId', 'value', 'paymentType', and 'accountType'. Some fields like 'startDate', 'accountType', 'routingNumber', 'accountNumber', and 'priority' cannot be patched. The response returns a list of updated direct deposit objects with details like 'directDepositId', 'startDate', 'paymentType', 'accountType', 'value', 'routingNumber', 'accountNumber', 'priority', and 'links'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Federal Tax Setup

  • ID: patch_worker_federal_tax_setup
  • Operation: write
  • Entities: federal tax, worker, filing status
  • Summary: This API updates the federal tax setup for a worker who is either 'Active' or 'In-progress'. The API requires the worker's ID as a path parameter. The request body can include details such as filing status, multiple jobs indicator, dependents amount, other income, deductions amount, extra withholding amount, and whether federal taxes should be withheld. The response returns the updated federal tax details including a tax ID, filing status, and other tax-related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Pay Component

  • ID: patch_worker_pay_component
  • Operation: write
  • Entities: check limit, pay component, worker
  • Summary: This API allows updating a single pay component associated with an 'Active' worker. It requires the workerId and workerComponentId as path parameters. The request body includes details such as calculationType, calculationBaseId, value, startDate, endDate, effectiveDate, checkLimit, and frequency. The response returns the updated pay component details including workerComponentId, componentId, name, calculationType, calculationBaseId, value, startDate, effectiveDate, endDate, effectOnPay, classificationType, checkLimit, frequency, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Check for Workers in a Company

  • ID: post_add_check_for_workers
  • Operation: write
  • Entities: pay period, check, worker
  • Summary: This API allows you to add a check for one or more workers within a company for an available pay period. The API requires the company ID as a path parameter. The request body includes details such as worker ID, pay period ID, check correlation ID, block auto distribution flag, earnings, deductions, check date, informational components, taxes, and links. The response returns the worker ID, paycheck ID, pay period ID, check correlation ID, earnings, deductions, and links related to the check.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add a Check to a Worker for an Unprocessed Pay Period

  • ID: post_add_check_to_worker
  • Operation: write
  • Entities: pay period, check, worker
  • Summary: This API allows you to add a check to a worker for an unprocessed pay period. It requires the worker's ID as a path parameter and a request body containing the pay period ID, earnings, and optionally deductions, informational, and tax components. The response includes the worker ID, paycheck ID, pay period ID, and details of the earnings, deductions, informational, and tax components applied to the check.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add a Company Level Job

  • ID: post_add_company_level_job
  • Operation: write
  • Entities: job segment, job, company
  • Summary: This API allows you to add a company level job for a specified company. The endpoint requires the company ID as a path parameter. The request body can include details such as jobCorrelationId, jobName, startDate, endDate, links, and jobNumber. The jobNumber can have up to 3 segments. The response returns a jobId, jobName, startDate, and jobNumber, among other details. This API is useful for clients who need to manage job numbering with multiple segments.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Direct Deposit to Active Worker

  • ID: post_add_direct_deposit_to_active_worker
  • Operation: write
  • Entities: direct deposit, financial institution, worker
  • Summary: This API allows you to add a direct deposit to an 'Active' worker. The API requires the worker's ID as a path parameter. The request body must include details such as paymentType, accountType, value, routingNumber, accountNumber, and priority. The response returns the details of the direct deposit added, including the directDepositId, startDate, paymentType, accountType, value, routingNumber, accountNumber, priority, and links to the resource.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Federal Tax Setup for Worker

  • ID: post_add_federal_tax_setup_for_worker
  • Operation: write
  • Entities: federal tax, worker
  • Summary: This API adds a federal tax setup for a worker who is either 'Active' or 'In-progress'. The API requires the worker's ID as a path parameter. The request body includes details such as filing status, multiple jobs indicator, dependents amount, other income, deductions amount, extra withholding amount, and whether taxes should be withheld. The response returns a tax ID and echoes back the submitted tax setup details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add In Progress Workers to a Company

  • ID: post_add_in_progress_workers
  • Operation: write
  • Entities: company, communication, worker
  • Summary: This API allows you to add one or more workers to a specific company with an IN_PROGRESS status. The workers will be pre-populated within Paychex Flex and require completion to be fully available. Required fields include givenName, familyName, and workerType. When adding multiple workers, a workerCorrelationId is needed for each worker. The API accepts various worker details such as employmentType, hireDate, exemptionType, sex, and more. The response includes the worker's unique identifier, employment details, and communication links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Pay Component to Unprocessed Check

  • ID: post_add_pay_component_to_unprocessed_check
  • Operation: write
  • Entities: pay component, check, worker
  • Summary: This API allows you to add a new pay component to an individual unprocessed check. The API requires a path parameter 'checkId' which is the ID associated with the desired check. The request body can include various details about the pay component such as 'name', 'classificationType', 'effectOnPay', 'payAmount', and more. The response includes details about the worker, paycheck, pay period, and the earnings applied to the check. It also provides links for further actions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Pay Component to Worker

  • ID: post_add_pay_component_to_worker
  • Operation: write
  • Entities: pay component, worker
  • Summary: This API allows you to add a single pay component to an 'Active' worker. The pay component can be of type Addition or Reduction and is used to apply recurring pay components on a worker's check based on the specified frequency. The API requires the workerId as a path parameter and a detailed request body that includes the componentId, calculationType, value, and other optional fields like startDate, endDate, and effectiveDate. The response returns the details of the added pay component including its workerComponentId, componentId, name, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Webhook

  • ID: post_add_webhook
  • Operation: write
  • Entities: domain, authentication, webhook
  • Summary: The Add Webhook API allows the calling application to register a new webhook. The request requires a valid URI for the webhook to receive events, an optional company ID to specify which company will receive notifications, and a required authentication object that varies based on the authentication type. The domains parameter is required and specifies the list of domains to register to. Upon successful creation, the API returns a response containing the webhook's unique identifier, company ID, URI, authentication type, creation date, and the list of domains the webhook is registered to.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Worker Communication

  • ID: post_add_worker_communication
  • Operation: write
  • Entities: link, communication, worker
  • Summary: This API allows you to add a single communication to an 'Active' or 'In-progress' worker. The API requires the worker's ID as a path parameter. The request body must include details about the communication such as type, usage type, and address information. The response returns the communication details including a unique communication ID and links related to the communication.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Worker Contacts

  • ID: post_add_worker_contacts
  • Operation: write
  • Entities: contact, relationship, worker
  • Summary: The Add Worker Contacts API allows you to add one or more contacts to a worker. Each contact can represent either a person or an entity, but not both. A contact must have at least one form of communication, such as telecom, postal, or email. Person contacts can have multiple communications for each type to support both BUSINESS and PERSONAL usage. Exactly one contact must be marked as primary for each contact type. If multiple contacts are posted for the same type and there are no existing contacts of that type, the first contact in the list will be made primary unless another is explicitly marked as primary. When a new contact is made primary, the previous primary contact will be marked as not primary. The API requires the workerId as a path parameter and a request body containing the contact details, including contactType and relationship. The response includes the contactId, contactType, and relationship details, along with metadata about the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Worker Pay Rate

  • ID: post_add_worker_pay_rate
  • Operation: write
  • Entities: pay rate, compensation, worker
  • Summary: This API allows you to add a single compensation rate to a worker who is either 'Active' or 'In-progress'. The API requires the worker's ID as a path parameter. The request body must include the rate number, rate type, and amount, while other fields such as start date, description, standard hours, and effective date are optional. The response returns the details of the newly added pay rate, including a unique rate ID, start date, rate number, rate type, amount, and any associated links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Bearer Token

  • ID: post_create_bearer_token
  • Operation: write
  • Entities: response, token, credential
  • Summary: The Create Bearer Token API is used to request a Bearer token that will serve as an access token for making calls to resources. The API requires the credentials to be sent within the body of the request using the application/x-www-form-urlencoded format. The request body must include 'grant_type' set to 'client_credentials', 'client_id' which is the application's API key, and 'client_secret' which is the application's corresponding secret. Upon a successful request, the API returns a JSON response containing the 'access_token', 'expires_in' which indicates the number of seconds before the token expires, 'scope' which will always be 'oob', and 'token_type' which will always be 'Bearer'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Custom Fields at Company Level

  • ID: post_create_custom_fields_at_company_level
  • Operation: write
  • Entities: custom field, company
  • Summary: This API allows the creation of custom fields at the company level. It requires the company ID as a path parameter. The request body can include various attributes such as customFieldName, categoryId, required, checkStub, employeeEditable, type, booleanValue, dateValue, textValue, maxTextLength, numericValue, and dropdown. The response returns the details of the created custom field, including its unique identifier, name, category ID, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Custom Fields Category

  • ID: post_create_custom_fields_category
  • Operation: write
  • Entities: custom field category, link, company
  • Summary: This API endpoint allows the creation of a Custom Fields Category at the company level. It requires the company ID as a path parameter and a request body containing the category name. Upon successful creation, it returns a 201 status code with a response body that includes the autogenerated category ID, the category name, and any associated links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Worker Custom Field

  • ID: post_create_worker_custom_field
  • Operation: write
  • Entities: custom field, worker
  • Summary: This API allows the creation of a custom field at the worker level. It requires the worker ID as a path parameter. The request body can include various attributes such as customFieldId, dropdownId, dropdownValue, and others to define the custom field's properties. The response returns the details of the created custom field, including its unique identifier and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Post Notification Callback

  • ID: post_notification_callback
  • Operation: write
  • Entities: notification, company, worker
  • Summary: The Post Notification Callback API allows you to send a notification callback to a specified endpoint. The request body must include details such as companyId, workerId, asOfDate, domains, action, notificationType, and notificationId. The API processes the callback and returns a status indicating whether the callback was successfully processed or if retries will be performed due to processing failures. A 2XX response indicates successful processing, while 4XX and 5XX responses indicate failures with retries.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete In-progress Worker

  • ID: terminate_employee
  • Operation: write
  • Entities:
  • Summary: This API is used to delete an in-progress worker from the system. The request requires a path parameter 'workerId', which is the ID associated with the desired worker to be deleted. If the deletion is successful, a 204 status code is returned with no content. If there is an error, the response will include an error object with a code, description, and resolution.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Direct Deposit

  • ID: update_bank_account_for_employee
  • Operation: write
  • Entities:
  • Summary: The Update Worker Direct Deposit API allows you to update a single direct deposit for an 'Active' worker. The API requires the workerId and directDepositId as path parameters. Optionally, you can provide an effectivity date as a query parameter. The request body can include the paymentType, accountType, value, routingNumber, accountNumber, and priority, although some fields cannot be patched. The response returns the updated direct deposit details, including the directDepositId, startDate, paymentType, accountType, value, routingNumber, accountNumber, priority, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Batch Update Worker Compensation and Pay Components

  • ID: update_compensation_information_for_an_employee
  • Operation: write
  • Entities:
  • Summary: This API allows for batch updating of a worker's compensation pay rate and pay components. The PATCH request requires the workerId and rateId as path parameters. The request body includes details for updating the compensation such as startDate, rateNumber, rateType, description, amount, standardHours, standardOvertime, default, effectiveDate, and links. Additionally, it allows updating multiple pay components with details such as workerComponentId, componentId, and value. The response returns the updated compensation and pay components with details including rateId, startDate, rateNumber, rateType, description, amount, standardHours, standardOvertime, default, effectiveDate, links, and pay component details such as name, calculationType, value, startDate, effectOnPay, checkLimit, frequency, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Pay Component

  • ID: update_deduction
  • Operation: write
  • Entities:
  • Summary: This API allows updating a single pay component associated with an 'Active' worker. It requires the workerId and workerComponentId as path parameters. The request body includes details such as calculationType, calculationBaseId, value, startDate, endDate, effectiveDate, checkLimit, and frequency. The response returns the updated pay component details including workerComponentId, componentId, name, calculationType, calculationBaseId, value, startDate, effectiveDate, endDate, effectOnPay, classificationType, checkLimit, frequency, and links.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Details

  • ID: update_employee_details
  • Operation: write
  • Entities:
  • Summary: The Update Worker Details API allows you to modify the details of a specific worker (employee or contractor) that your application has access to. The API endpoint requires a path parameter 'workerId' to identify the worker. The request body can include various fields such as 'employeeId', 'employmentType', 'birthDate', 'sex', 'clockId', 'name', 'job', 'organization', and 'currentStatus'. Some fields like 'workerType', 'exemptionType', 'ethnicityCode', 'hireDate', 'legalId', 'laborAssignmentId', 'locationId', 'jobId', and 'communications' cannot be updated for active workers. The response returns the updated worker details including 'workerId', 'employeeId', 'workerType', 'employmentType', 'exemptionType', 'workState', 'birthDate', 'sex', 'ethnicityCode', 'hireDate', 'clockId', 'name', 'legalId', 'laborAssignmentId', 'locationId', 'job', 'organization', 'supervisor', 'currentStatus', and 'links'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Federal Tax Setup

  • ID: update_w4_details_of_employee
  • Operation: write
  • Entities:
  • Summary: This API updates the federal tax setup for a worker who is either 'Active' or 'In-progress'. The API requires the worker's ID as a path parameter. The request body can include details such as filing status, multiple jobs indicator, dependents amount, other income, deductions amount, extra withholding amount, and whether federal taxes should be withheld. The response returns the updated federal tax details including a tax ID, filing status, and other tax-related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago