PApaychex
Payroll

Company Pay Components

Array of pay components that are configured for a company. Pay components are earnings and deductions which are used for payroll.

get/companies/{companyId}/paycomponents

Request

Path parameters

companyIdstring required

The id assigned to the company that is being requested for.

Query parameters

effectonpaystring

The type of effect on pay that you are requested for.

asofstring

Returns all PayComponent's as of the date used in the request.

classificationtypestring

The category that this component falls into. (such as EARNINGS or SICK_PAY )

namestring

The name of a pay component that a company has.

Response

successful operation

Example response

{
  "content": {
    "componentId": "970000076689381",
    "code": "1",
    "name": "Hourly",
    "classificationType": "Regular",
    "description": "Use for regular pay.",
    "effectOnPay": "ADDITION",
    "startDate": "2016-01-01T00:00:00Z",
    "calculationType": "SCHEDULED_AMOUNT",
    "payRate": "7.25",
    "payHours": "4",
    "organization": {
      "organizationId": "970000055981384",
      "name": "2 Division B",
      "number": "2",
      "level": "Level 2"
    }
  }
}

Changes

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