PApaychex
Worker

Worker Pay Components

Get all the the pay components for a specific "Active" worker.

get/workers/{workerId}/paycomponents

Request

Path parameters

workerIdstring required

ID associated with desired worker.

Query parameters

effectonpaystring

What the effect on pay will be (REDUCTION OR ADDITION), currently only reductions are available.

asofstring

Returns all pay components as of the date used in the request

namestring

The name of a pay component that a workers has.

componentidstring

The unique identifier of the pay component.

classificationtypestring

The classification type of a pay component that a worker has. (such as "DEDUCTION", or "REGULAR",)

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.