PApaychex
Payroll

Company Pay Periods

Array of pay periods associated with the company.

get/companies/{companyId}/payperiods

Request

Path parameters

companyIdstring required

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

Query parameters

statusstring[]

Get PayPeriods that are in List of specific status.

fromstring

The beginning of the search date range using the Payperiod start date.

tostring

The ending of the search date range using the Payperiod end date.

Response

successful operation

Example response

{
  "content": {
    "payPeriodId": "850000414675408",
    "intervalCode": "BI_WEEKLY",
    "status": "INITIAL",
    "description": "Bi-weekly Payroll (1)",
    "startDate": "2016-02-27T00:00:00Z",
    "endDate": "2016-03-11T00:00:00Z",
    "submitByDate": "2016-03-18T00:00:00Z",
    "checkDate": "2016-03-18T00:00:00Z",
    "checkCount": 1,
    "originalPayPeriodID": "850000414358408"
  }
}

Changes

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