Jobs

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

Verbs supported: GET

GET: Array of jobs set at the company level.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.


Response: Jobs Profile  

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

Verbs supported: GET

GET: Information about a single Job.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
jobIdstringThe ID of the job.

Response: Job Profile  

Object Components:

job Number: Data elements of a Job Number to show the segments and number. For segmentation this can be up to 3 different segments.

Element NameTypeDescription
segment1stringThis is segment 1 or the number associated to the job when segmentation is not used.
segment2stringThis is segment 2.
segment3stringThis is segment 3.

Response

Profile: Jobs

The state representation of Jobs within a company.
Element NameTypeDescription
jobIdstringThe unique identifier associated with this job.
jobNamestringThe name of the job.
jobNumberobjectJob can be broken down into segment(s) associated to the job. For a client not using segmentation the segment1 will be the number associated to the job.
startDatedateThe start date associated with this job.
endDatedateThe end date associated with this job.

 

{
  "content": [
    {
            "jobId": "970001557916902",
            "jobName": "My job A",
            "startDate": "2018-12-20T00:00:00Z",
            "endDate": "2025-12-20T00:00:00Z",
            "jobNumber": {
                "segment1": "A1",
                "segment2": "A2",
            }
        },
        {
            "jobId": "970001557916904",
            "jobName": "My job B",
            "startDate": "2018-12-20T00:00:00Z",
            "jobNumber": {
                "segment1": "B1"
            }
        }
  ]
}
{
  "content": [
    {
            "jobId": "970001557916902",
            "jobName": "My job A",
            "jobNumber": "3",
            "startDate": "2018-12-20T00:00:00Z",
            "endDate": "2025-12-20T00:00:00Z"
        },
        {
            "jobId": "970001557916904",
            "jobName": "My job b",
            "jobNumber": "4",
            "startDate": "2018-12-20T00:00:00Z"
        }
  ]
}