---
title: "Company Pay Component"
method: GET
path: "/companies/{companyId}/paycomponents/{paycomponentId}"
tags: ["Payroll"]
---

# Company Pay Component

`GET /companies/{companyId}/paycomponents/{paycomponentId}`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/paycomponents/{paycomponentId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/paycomponents/:paycomponentId/get.ts> (a function with typed inputs; its response is checked against the schema)

Pay component associated with the company.

## Path parameters

- `companyId` string, required
- `paycomponentId` string, required

## Query parameters

- `asof` string

## Response `200`

successful operation

- object
  - `content` PayComponentResource: The earnings to apply to the check. Each earning needs to define as one of the following allowed values
    - `componentId` string: The unique identifier used to identify a pay component.
    - `checkComponentId` string: The unique identifier associated for the pay component on this check.
    - `code` string: The Paychex standard code number for the Pay Component, can be two digit.
    - `name` string: Name given to the pay component.
    - `classificationType` string: The category that this component falls into.
    - `description` string: The description of the Pay Component.
    - `effectOnPay` 'ADDITION' | 'ADDITION_WITH_IN_OUT' | 'EMPLOYER_INFORMATIONAL' | 'REDUCTION': The effect that the pay component will have on the check amount.
    - `startDate` string, date-time: The date that the pay component is able to be applied on a check.
    - `endDate` string, date-time: The date that the pay component is not available to be applied on a check moving forward.
    - `appliesToWorkerTypes` string[]: List of workerTypes that the component can be applied to.
    - `jobId` string: This is used optionally for overriding a job when it needs to be different than the workers default. This option is only available when the client has job costing.
    - `laborAssignmentId` string: This is used optionally for overriding a labor assignment when it needs to be different than the workers assignment distribution. This option is only available when the client has labor assignment.
    - `calculationType` string: Calculation type used by the pay component.
    - `payRateId` string: Unique identifier for this workers pay rate **This ID will change if this is created for an IN_PROGRESS worker that is later completed within Flex**
    - `payRate` string: The rate amount that will be applied for this component. Used in conjunction with Hours or Units.
    - `payHours` string: The number of hours that will be applied for this component. Used in conjunction with rate.
    - `payUnits` string: The number of units that will be applied for this component. Used in conjunction with rate.
    - `payAmount` string: The flat amount to be applied for this component. Not used with Rate, Hours, or Units.
    - `organization` OrganizationResource: The state representation of Organizations within a company.
      - `organizationId` string: The unique identifier associated with this organizations representation.
      - `name` string: The name of the organization.
      - `number` string: The number assigned to the organization.
      - `level` string: The level number within the organizational structures hierarchy.
      - `links` Link[]
        - `rel` string
        - `href` string
        - `hreflang` string
        - `media` string
        - `title` string
        - `type` string
        - `deprecation` string
        - `profile` string
        - `name` string
    - `lineDate` string, date-time: This is used optionally for specifying a date that the pay component was generated on.
    - `memoed` boolean: This is used optionally for memoing the payHours or payUnits so that they are informational when using a payAmount.
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)