PApaychex
Worker

Worker Pay Rate

Update a workers specific compensation rate.

patch/workers/{workerId}/compensation/payrates/{rateId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

rateIdstring required

The id of a single workers compensation rate.

Request body

rateIdstring

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

startDatestring date-time

The date when the pay rate is going to begin.

rateNumberstring

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.

descriptionstring

Describes the rate for the worker. A maximum of 30 characters is allowed.

amountstring

The currency amount which this rate is applied.

standardHoursstring

Default standard hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.

standardOvertimestring

Default over time hours that this rate is used with a pay frequency. This data field is not available for an IN_PROGRESS worker.

defaultboolean

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.

effectiveDatestring

The date when the pay rate becomes effective for the worker (can be used only in POST/PATCH for an active worker).

_linksLinks

Example request

{
  "rateId": "970000054610137",
  "rateNumber": "RATE_1",
  "rateType": "RATE_1",
  "description": "Security2",
  "amount": "40.2",
  "standardHours": "25.25",
  "standardOvertime": "3.25",
  "default": true
}

Response

Successful operation

Example response

{
  "content": {
    "rateId": "970000054610137",
    "rateNumber": "RATE_1",
    "rateType": "RATE_1",
    "description": "Security2",
    "amount": "40.2",
    "standardHours": "25.25",
    "standardOvertime": "3.25",
    "default": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.