Pay Components

These endpoints are for the pay components on the company level! For pay components on a worker, look under 'worker' then 'pay components' on the left navigation.

Endpoint:
https://api.paychex.com/companies/{companyId}/paycomponents

Verbs Supported: GET

GET: Array of pay components that are configured for a company. Pay components are earnings and deductions which are used for payroll.

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.

Endpoint: https://api.paychex.com/companies/{companyId}/paycomponents?effectonpay={effectOnPay}

Verbs Supported: GET

GET: Array of pay components that are configured for a company by their effect on pay.

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
effectOnPaystringThe type of effect on pay that you are requested for.

*******************NEW as of 12/4/2019 *****************

Endpoint: https://api.paychex.com/companies/{companyId}/paycomponents?classificationtype={XYZ}

Verbs supported: GET

GET: Retrieve an array of specific pay components that a company has, by classification types (such as ‘"DEDUCTION")

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
classificationtypestringThe category that this component falls into. (such as " EARNINGS " or  " SICK_PAY ")

Endpoint: https://api.paychex.com/workers/{workerId}/paycomponents?name={xyz}

Verbs supported: GET

GET: Retrieve an array of specific pay components that a company has, by it’s name (This can be any name of the pay component that client has created)

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
namestringThe name of a pay component that a company has.

Endpoint: https://api.paychex.com/workers/{workerId}/paycomponents?componentid={componentid}

Verbs supported: GET

GET: Retrieve an array of specific pay components that a company has, by it’s unique ID

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
componentIDstringThe unique identifier used to identify a pay component.

Response

Profile: Pay Components

The representational state of pay components.
Element NameTypeDescription
componentIdstringThe unique identifier used to identify a pay component.
namestringName given to the pay component.
classificationTypestringThe category that this component falls into.
  • _1099
  • _1099_MISC
  • _401K
  • _403_B_
  • _408K_SEP
  • _414H
  • _457_PLAN_CONTRIBUTIONS
  • _457_PLAN_DISTRIBUTIONS
  • _501C_TRUST
  • CAFETERIA_PLANS
  • DEDUCTION
  • DRAW
  • EARNINGS
  • EDUCATIONAL_ASSISTANCE
  • FEDERAL_HEALTH_SAVINGS_ACCOUNT
  • FEDERAL_MEDICAL_SAVINGS_ACCOUNT
  • FRINGE_BENEFITS
  • GARNISHMENTS
  • INFORMATIONAL
  • IRA
  • IRC_105
  • IRC_106
  • IRC_129_CAFETERIA
  • IRC_129_FRINGE
  • IRC_137_ADOPTION_ASSISTANCE
  • IRC_137_FRINGE_BENEFITS
  • IRC_79_GROUP_TERM_LIFE_INSURANCE
  • MISCELLANEOUS
  • MOVING_EXPENSES
  • NON_QUALIFIED_DEFERRED_COMPENSATION_CONTRIBUTIONS
  • NON_QUALIFIED_DEFERRED_COMPENSATION_DISTRIBUTIONS
  • PRIVATE_DISABILITY
  • REGULAR
  • REIMBURSEMENT
  • RETIREMENT
  • SICK_PAY
  • STOCK_OPTIONS
  • SUPPLEMENTAL
  • TIPS
  • TRANSPORTATION_BENEFIT
  • UNION_DUES
descriptionstringThe description of the Pay Component.
codestringThe Paychex standard code number for the Pay Component, can be two digit.
effectOnPaystringThe effect that the pay component will have on the check amount.
  • ADDITION: Adds to pay
  • REDUCTION: Reduces pay
  • EMPLOYER_INFORMATIONAL: No effect on pay
  • ADDITION_WITH_IN_OUT: Adds to pay for tax calculations, but is subtracted from net
startDatedateThe date that the pay component is able to be applied on a check.
endDatedateThe date that the pay component is not available to be applied on a check moving forward.
appliesToWorkerTypesarrayList of workerTypes that the component can be applied to.
{
    "content": [        
        {
            "componentId": "970000054609778",
            "name": "Salary",
            "classificationType": "REGULAR",
            "description": "Use for regular pay.",
            "code": "1",
            "effectOnPay": "ADDITION",
            "startDate": "2016-01-01T00:00:00Z",
            "appliesToWorkerTypes": [
                "EMPLOYEE"
            ]
        },
        {
            "componentId": "970000054609741",
            "name": "Hourly",
            "classificationType": "REGULAR",
            "description": "Use for regular pay.",
            "code": "1",
            "effectOnPay": "ADDITION",
            "startDate": "2016-01-01T00:00:00Z",
            "appliesToWorkerTypes": [
                "EMPLOYEE"
            ]
        },
        {
            "componentId": "970000076689326",
            "name": "Old regular pay",
            "classificationType": "REGULAR",
            "description": "Use for regular pay.",
            "code": "1",
            "effectOnPay": "ADDITION",
            "startDate": "2017-01-01T00:00:00Z",
            "endDate": "2017-12-31T00:00:00Z",
            "appliesToWorkerTypes": [
                "EMPLOYEE"
            ]
        },
        {
            "componentId": "970000079956947",
            "name": "Deduction",
            "classificationType": "DEDUCTION",
            "description": "Use for any normal employee deduction.",
            "code": "12",
            "effectOnPay": "REDUCTION",
            "startDate": "2017-03-02T00:00:00Z",
            "appliesToWorkerTypes": [
                "INDEPENDENT_CONTRACTOR",
                "EMPLOYEE"
            ]
        },
        {
            "componentId": "970000054609852",
            "code": "3",
            "name": "Vacation",
            "classificationType": "REGULAR",
            "description": "Use for vacation pay.",
            "effectOnPay": "ADDITION",
            "startDate": "2016-01-01T00:00:00Z",
            "appliesToWorkerTypes": [
                "EMPLOYEE"
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/paycomponents"
        }
    ]
}