PApaychex
Company

Company Job

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.

post/companies/{companyId}/jobs

Request

Path parameters

companyIdstring required

The ID of the company.

Request body

jobIdstring

The unique identifier associated with this job.

jobCorrelationIdstring

Id that you define which is used for error handling/responses.

jobNamestring

The name of the job.

startDatestring date-time

The start date associated with this job.

endDatestring date-time

The end date associated with this job.

Example request

{
  "jobId": "970001557916902",
  "jobName": "My job A",
  "startDate": "2018-12-20T00:00:00Z",
  "endDate": "2025-12-20T00:00:00Z",
  "jobNumber": {
    "segment1": "A1",
    "segment2": "A2",
    "segment3": "A3"
  }
}

Response

successful operation

Example response

{
  "content": {
    "jobId": "970001557916902",
    "jobName": "My job A",
    "startDate": "2018-12-20T00:00:00Z",
    "endDate": "2025-12-20T00:00:00Z",
    "jobNumber": {
      "segment1": "A1",
      "segment2": "A2",
      "segment3": "A3"
    }
  }
}

Changes

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