# Paychex — HRIS API: overview

> Canonical URL: https://developers.apideck.com/apis/hris/paychex/overview

Paychex is a provider of payroll, human resource, and benefits outsourcing solutions for small- to medium-sized businesses.
- Status: live
- Authentication: oauth2

- **apideck credentials available:** false
- **sandbox note:** Request it through the Developer Partner programme; Paychex provides it once approved.
- **consumer access level:** Super Admin or Security Admin in Paychex Flex (permission to manage connected applications).
- **difficulty reason:** Consumer Creates the App Credentials by Hand in Paychex Flex
- **external guides:**   - **source:** Paychex
  - **url:** https://developer.paychex.com/client
  - **title:** Paychex client process
  - **source:** Paychex
  - **title:** Paychex API documentation
  - **url:** https://developer.paychex.com/documentation
- **sandbox url:** https://developer.paychex.com/partner
- **apideck credentials note:** Each Paychex client connects with its own app credentials.
- **environment notes:**   - **description:** Paychex production at api.paychex.com, called with the app the consumer creates in Paychex Flex.
  - **environment:** Production
  - **environment:** Test (N1)
  - **description:** Paychex runs a separate test (N1) server at api.n1.paychex.com.
- **webhooks:** Virtual webhooks - employee created and updated events
- **important to know:** After connecting, the consumer must grant their company access to the credentials in Paychex. Until then the company list stays empty and the Company field cannot be selected.
- **authentication note:** Client ID and secret pasted in Vault; no OAuth sign-in.
- **responsibility matrix:**   - **area:** Enable the connector
  - **customer:** ✓ In the Apideck Dashboard
  - **consumer:** ✓ (Super Admin or Security Admin)
  - **area:** Create an app in Paychex Flex
  - **consumer:** ✓
  - **area:** Grant the app access to the company
  - **area:** Enter Client ID and secret in Vault
  - **customer:** Implement Vault
  - **consumer:** ✓
  - **area:** Store credentials, request tokens and route calls
  - **apideck:** ✓
- **supported resource categories:**   - **resources:** employees
direct-deposits
bank-accounts
communication
custom-fields
  - **name:** People
  - **name:** Company Structure
  - **resources:** companies
departments
  - **name:** Payroll
  - **resources:** pay-standards
- **partnership portal name:** Paychex Developer Partner programme
- **account type required:** A Paychex Flex client company.
- **partnership note:** Joining gives a Paychex-provided sandbox and a production key and secret.
- **partnership url:** https://developer.paychex.com/partner
- **partnership required:** false
- **sandbox available:** true
- **difficulty:** moderate

## Supported resources

- **downstream id:** workers
- **custom field support:** true
- **status:** live
- **id:** employees
- **name:** Employees
- **downstream name:** Workers
- **name:** Companies
- **custom field support:** false
- **id:** companies
- **downstream id:** companies
- **downstream name:** Companies
- **status:** live
- **downstream name:** Organizations
- **id:** departments
- **custom field support:** false
- **status:** live
- **name:** Departments
- **downstream id:** organizations

An omitted operation list does not establish operation support. Verify the selected operation in the coverage matrix.

[API reference](https://developers.apideck.com/apis/hris/reference.md) · [Coverage matrix](https://developers.apideck.com/apis/hris/coverage)