GET a single Job Code

get https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/{companyId}/jobs/{jobCode}

Summary Description

The GET Single Job Code API endpoint allows users to fetch specific Job Code details from a client's Paylocity instance. To use this endpoint, the Paylocity Company ID and Job Code must be specified

Use Cases

This API endpoint will allow an API user to retrieve a Job Code record for a specific company ID and Job Code ID

Response

Response body

object

companyId

string | null

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity

code

string | null

A Job Code may contain up to 10 alpha-numeric characters. Spaces or special characters are not allowed

description

string | null

The Job Code description may contain up to 40 alpha-numeric characters. Spaces or special characters are not allowed

isActive

boolean | null

Active (Yes/No). The job code is currently active or inactive

isCertified

boolean | null

Certified Job (Yes/No). This is a certified job code as per the CMS PBJ Report (Centers for Medicare and Medicaid Services Payroll Based Journal) job costing report by industry

payEntry

object

Override Pay Entry Only

shift

string | null

This field is used to enter an override company-defined shift code to be charged by the employee

rateCode

string | null

The employee’s pay rate. If no rate is entered, the employees base rate will be used

rate

double | null

The rate of pay for the job code

addingRateConstant

double | null

Rate + or + Is employee pay rate + the SD Schedule Differential plus or times the bonus

multiplyingRateConstant

double | null

Rate X or + Is employee pay rate X the SD Schedule Differential plus or times the bonus

workerComputedCode

string | null

The company defined workers comp code for work performed by the employee

tax

object

State Tax

address

object

Address

line1

string | null

The address where the job code will be used

line2

string | null

The address where the job code will be used

city

string | null

The city where the job code will be used

state

string | null

The state where the job code will be used

zip

string | null

The zip code where the job code will be used

county

string | null

The county where the job code will be used

country

string | null

The country where the job code will be used

payrollBasedJournal

object

CMS/PBJ Data Only

jobTitleCode

string | null

This is a Job Title Code for which the certified job code CMS PBJ Report (Centers for Medicare and Medicaid Services Payroll Based Journal) will be utilized to calculate labor costs

facilityId

string | null

This is a Facility id for which the certified job code CMS PBJ Report (Centers for Medicare and Medicaid Services Payroll Based Journal) will be utilized to calculate labor costs

stateId

string | null

This is a State ID for which the certified job code CMS PBJ Report (Centers for Medicare and Medicaid Services Payroll Based Journal) will be utilized to calculate labor costs

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://dc1demogwext.paylocity.com/apiHub/payroll/v1/companies/companyId/jobs/jobCode \
3
     --header 'accept: application/json'


xxxxxxxxxx
40
}
1
{
2
  "companyId": "string",
3
  "code": "string",
4
  "description": "string",
5
  "isActive": true,
6
  "isCertified": true,
7
  "payEntry": {
8
    "shift": "string",
9
    "rateCode": "string",
10
    "rate": 0,
11
    "addingRateConstant": 0,
12
    "multiplyingRateConstant": 0,
13
    "workerComputedCode": "string",
14
    "tax": {
15
      "state": "string",
16
      "local1": "string",
17
      "local2": "string",
18
      "local3": "string",
19
      "additionalProp": {}
20
    },
21
    "additionalProp": {}
22
  },
23
  "address": {
24
    "line1": "string",
25
    "line2": "string",

200Success