Jobs

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

Verbs supported: GET& POST

GET: Array of jobs set at the company level.

POST: Add a company level job. If a client has their job numbering structured in 2-3 separate 'segments', you may need to first do a GET on the jobsegements endpoint, so you can see how many segments and the character length of each segment, as well as the name of those segments, which you will need to have before you POST.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.

 

Response: Jobs Profile  

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

Verbs supported: GET& PATCH

GET: Information about a single Job.

PATCH: Update 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"
        }
  ]
}

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

Verbs supported: GET

GET: Retrieve job segment structure setup for this client. This endpoint is only available if the client has their job numbering set up in '2-3 separate 'segments'. The response will give you back the exact character lengths and the segment names so you are able to POST.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
{
    "metadata": {
        "contentItemCount": 3
    },
    "content": [
        {
            "segmentNumber": 1,
            "name": "Location Code",
            "segmentLength": 2
        },
        {
            "segmentNumber": 2,
            "name": "Service Code",
            "segmentLength": 4
        },
        {
            "segmentNumber": 3,
            "name": "Client Code",
            "segmentLength": 10
        }
    ]
}