PApaychex
Worker

Worker Pay Component

Update a single pay component associated to the "Active" worker.

patch/workers/{workerId}/paycomponents/{workerComponentId}

Request

Path parameters

workerIdstring required

ID associated with desired worker.

workerComponentIdstring required

The id of a single pay component that a workers has.

Request body

workerComponentIdstring

The id of a single pay component that a workers has.

componentIdstring

The unique identifier of the pay component. This data field cannot be PATCHED.

namestring

Name of the pay component. This data field will be populated automatically based on componentId.

calculationType'FLAT_DOLLAR_AMOUNT:This is used for a specific dollar amount' | 'PERCENTAGE:This is used for when a Percentage will be used to calculate the amount and will need a calculationBaseId to specify what to apply against' | 'RATE_X_UNITS:This is used for apply the rate against units and will need a calculationBaseId to specify what to apply against' | 'RATE_X_HOURS:This is used for apply the rate against hours and will need a calculationBaseId to specify what to apply against.'

The type of calculation that will be applied for the pay component .

calculationBaseIdstring

This is required if you are not using a FLAT_DOLLAR_AMOUNT Calculation Type.

valuenumber

This is used to specify the value that is used against the calculationType.

startDatestring date-time

Date which this pay component will start to be applied during the payruns. This is an optional field that default to current datetime if not provided. This cannot be backdated but can be added to start in the future.

effectiveDatestring date-time

Date which this pay component has started for the worker.

endDatestring date-time

Date which this pay component has ended for the worker.

effectOnPaystring

What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available. This data field will be populated automatically based on componentId. This data field cannot be PATCHED

classificationTypestring

The category that this component falls into.

_linksLinks

Example request

{
  "workerComponentId": "970000223656831",
  "componentId": "970000180599325",
  "name": "Deduction - 1",
  "calculationBaseId": "00H2A1IUJE7MXV6TQ37U",
  "value": 5,
  "startDate": "2018-03-01T00:00:00Z",
  "effectOnPay": "REDUCTION",
  "frequency": {
    "applied": "BY_PAY_PERIOD",
    "occurrence": "QUARTERLY",
    "occurrenceIntervals": {
      "interval1": "2",
      "interval2": "Last"
    },
    "effectedChecks": "EVERY_CHECK"
  }
}

Response

Successful operation

Example response

{
  "content": {
    "workerComponentId": "970000223656831",
    "componentId": "970000180599325",
    "name": "Deduction - 1",
    "calculationBaseId": "00H2A1IUJE7MXV6TQ37U",
    "value": 5,
    "startDate": "2018-03-01T00:00:00Z",
    "effectOnPay": "REDUCTION",
    "frequency": {
      "applied": "BY_PAY_PERIOD",
      "occurrence": "QUARTERLY",
      "occurrenceIntervals": {
        "interval1": "2",
        "interval2": "Last"
      },
      "effectedChecks": "EVERY_CHECK"
    }
  }
}

Changes

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