Payroll

Company Pay Period

A single pay period.

get/companies/{companyId}/payperiods/{payperiodId}

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/payperiods/:payperiodId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

companyIdstring required

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

payperiodIdstring required

The id assigned to the PayPeriod you are looking for.

Response

Pay Period successfully returned for given payPeriodId.

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.