---
title: "Worker Pay Rate"
method: PATCH
path: "/workers/{workerId}/compensation/payrates/{rateId}"
tags: ["Worker"]
---

# Worker Pay Rate

`PATCH /workers/{workerId}/compensation/payrates/{rateId}`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/compensation/payrates/:rateId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update a workers specific compensation rate.

## Path parameters

- `workerId` string, required
- `rateId` string, required

## Request body

- PayRateResource: Worker Pay Rate
  - `rateId` 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**
  - `startDate` string, date-time: The date when the pay rate is going to begin.
  - `rateNumber` string: The number of the rate. A worker can have up to 25 different rates.
  - `rateType` 'ANNUAL_SALARY' | 'PER_PAY_PERIOD_SALARY' | 'PIECEWORK_RATE' | 'DAILY_RATE' | 'HOURLY_RATE': Type of rate.
  - `description` string: Describes the rate for the worker. A maximum of 30 characters is allowed.
  - `amount` string: The currency amount which this rate is applied.
  - `standardHours` string: Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.
  - `standardOvertime` string: Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.
  - `default` boolean: If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1.
  - `effectiveDate` string: The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker).
  - `_links` Links

## Response `200`

Successful operation

- object
  - `content` PayRateResource: Worker Pay Rate
    - `rateId` 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**
    - `startDate` string, date-time: The date when the pay rate is going to begin.
    - `rateNumber` string: The number of the rate. A worker can have up to 25 different rates.
    - `rateType` 'ANNUAL_SALARY' | 'PER_PAY_PERIOD_SALARY' | 'PIECEWORK_RATE' | 'DAILY_RATE' | 'HOURLY_RATE': Type of rate.
    - `description` string: Describes the rate for the worker. A maximum of 30 characters is allowed.
    - `amount` string: The currency amount which this rate is applied.
    - `standardHours` string: Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.
    - `standardOvertime` string: Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.
    - `default` boolean: If this rate is the default one to apply on the worker. This data field is not available for an IN_PROGRESS worker and is considered RATE_1.
    - `effectiveDate` string: The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker).
    - `_links` Links
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `400`: Invalid request (API-4), Field too long (API-6), Invalid field (API-17), Invalid value (API-24), Invalid rate type (API-27), Invalid amount (API-28),Required field missing (API-46), The request cannot be performed since the worker is in a state which does not allow this action (API-19)
- `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
- `415`: Missing value (API-22)
- `423`: Client locked (API-10)
- `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)