Pay Periods

Endpoint: https://api.paychex.com/companies/{companyId}/payperiods

Verbs Supported: GET

GET: A collection of pay periods that have been created for a companies payroll but not yet processed.

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.

Endpoint: https://api.paychex.com/companies/{companyId}/payperiods?from={searchStartDate}&to={searchEndDate}

Endpoint: https://api.paychex.com/companies/{companyId}/payperiods?from={searchStartDate}&to={searchEndDate}&status={status}

Verbs Supported: GET

GET: A collection of pay periods that have a start date and end date that fall into the search range provided.

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
searchStartDatedateThe beginning of the search date range using the Payperiod start date.
searchEndDatedateThe ending of the search date range using the Payperiod end date.
statusstringGet PayPeriods that are in a single specific status.

Endpoint: https://api.paychex.com/companies/{companyId}/payperiods/{payPeriodId}

Verbs Supported: GET

GET: A single pay period.

Request:

Element NameTypeDescription
companyIdstringThe id assigned to the company that is being requested for.
payPeriodIdstringThe id assigned to the PayPeriod you are looking for.

Response

Profile: Pay Period

The representational state of pay periods.
Element NameTypeDescription
payPeriodIdstringThe unique identifier used to identify a pay period.
intervalCodestringFrequency of the payroll period.
  • ANNUAL
  • BI_WEEKLY
  • MONTHLY
  • QUARTERLY
  • SEMI_ANNUAL
  • SEMI_MONTHLY
  • WEEKLY
statusstringThe current state of the associated pay period.
  • COMPLETED
  • COMPLETED_BY_MEC
  • ENTRY
  • INITIAL
  • PROCESSING
  • REISSUED
  • RELEASED
  • REVERSED
descriptionstringThe description of the Pay Period.
startDatedateThe start date associated with this pay period.
endDatedateThe end date associated with this pay period.
submitByDatedateThe date by which information for the pay run must be submitted in order to be guaranteed the information is included.
checkDatedateThe date on which the checks associated with this pay period can be cashed.
checkCountnumberNumber of checks that are included within the pay period.
{ 
  "content":  [  
    {   
      "payPeriodId":  "850000414358408",   
      "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":  0    
  },        
    {   
      "payPeriodId":  "850000524255195",   
      "intervalCode":  "BI_WEEKLY",   
      "status":  "ENTRY",   
      "description":  "Bi-weekly Payroll (1)",   
      "startDate":  "2017-09-09T00:00:00Z",   
      "endDate":  "2017-09-22T00:00:00Z",   
      "submitByDate":  "2017-09-27T00:00:00Z",   
      "checkDate":  "2017-09-29T00:00:00Z",   
      "checkCount":  1    
  }  
 ], 
  "links":  [  
    {   
      "rel":  "self",   
      "href":  "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/payperiods"    
  }  
 ]
}