PApaychex
Worker

Worker Pay Component

Retrieve a specific pay component that a "Active" worker has.

get/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 "Active" worker has.

Query parameters

asofstring

Returns pay component as of the date used in the request

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.