Compensation

Endpoint: https://api.paychex.com/workers/{workerId}/compensation

Verbs supported: GET

GET: Information about a workers compensation.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.

Response:

VerbProfileDescription
GEThttp://api.paychex.com/profiles/payroll/compensation/v1Default compensation profile which provides links to pay standards and pay rates.
GEThttp://api.paychex.com/profiles/payroll/compensation/standards_rates/v1Full compensation profile: Includes: Default compensation profile, pay rates, and pay standards.
{
  "content": [],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation"
    },
    {
      "rel": "payRates",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates"
    },
    {
      "rel": "payStandards",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/paystandards"
    }
  ]
}

Compensation - Pay Standards

Endpoint: https://api.paychex.com/workers/{workerId}/compensation/paystandards

Verbs supported: GET

GET: Information about a workers compensation pay standards.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.

Response:

VerbDescription
GETWorkers pay standards profile.

Response

Profile: Workers pay standards

The representational state of the workers pay standards.
Element NameTypeDescription
payFrequencystringHow often a worker is paid.
  • WEEKLY
  • BI_WEEKLY
  • SEMI-MONTHLY
  • MONTHLY
overtimeFactordecimalDefault overtime factor that would be applied for overtime work completed.
calculatedPayPerioddecimalCalculated amount of compensation based on rate defaults.
calculatedAnnualSalarydecimalCalculated amount of compensation based on calculatedPayPeriod and payFrequency
{
  "content": [
    {
      "payFrequency": "MONTHLY",
      "overtimeFactor": "1.5",
      "calculatedPayPeriod": "1704.10",
      "calculatedAnnualSalary": "20449.20"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/paystandards"
    }
  ]
}

Compensation - Pay Rates

Endpoint: https://api.paychex.com/workers/{workerId}/compensation/payrates

Verbs supported: GET & POST

GET: Information about a workers compensation rates.

POST: Add a single compensation rate to the worker.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.

Response:

VerbDescription
GETWorkers compensation pay rates profile.
POSTThe single newly added workers compensation rate.

Endpoint:  https://api.paychex.com/workers/{workerId}/compensation/payrates/{rateId}

Verbs supported: GET & PATCH & DELETE

GET: A workers single compensation rate.

PATCH: Update a workers specific compensation rate.

DELETE: Remove a compensation rate from a worker.

Request:

Element NameTypeDescription
workerId stringThe id assigned to the worker that workers are being requested for.
compensationIdstringThe id of a single workers compensation rate.

Response:

VerbDescription
GETA single compensation pay rate.
PATCHWorkers single compensation rate.
DELETEStatus of the request.

 

Response

Profile: Workers pay rates

The representational state of the workers pay rate(s).
Element NameTypeDescriptionSupports PATCH
rateIdstringUnique identifier for this workers pay rate. 
startDateDateDate when the rate is going to begin. 
endDateDateA future date when the rate is going to end. 
rateNumbernumberThe number of the rate. A worker can have up to 5 different rates. 
rateTypestringType of rate.
  • ANNUAL_SALARY
  • PER_PAY_PERIOD_SALARY
  • PIECEWORK_RATE
  • DAILY_RATE
  • HOURLY_RATE
 
descriptionstringDescribes the rate for the worker. 
amountdecimalThe currency amount which this rate is applied.x
standardHoursdecimalDefault standard hours that this rate is used with a pay frequency.x
standardOvertimedecimalDefault over time hours that this rate is used with a pay frequency.x
defaultbooleanIf this rate is the default one to apply on the worker. 
{
  "content": [
    {
      "rateId": "970000054610137",
      "rateNumber": "RATE_1",
      "rateType": "HOURLY_RATE",
      "description": "Security2",
      "amount": "40.20",
      "standardHours": "25.25",
      "standardOvertime": "3.25",
      "default": true,
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610137"
        }
      ]
    },
    {
      "rateId": "970000054610138",
      "rateNumber": "RATE_2",
      "rateType": "HOURLY_RATE",
      "description": "Update Rate",
      "amount": "43.22",
      "standardHours": "10.00",
      "standardOvertime": "5.00",
      "default": false,
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610138"
        }
      ]
    },
    {
      "rateId": "970000054610139",
      "rateNumber": "RATE_3",
      "rateType": "HOURLY_RATE",
      "amount": "30.15",
      "standardHours": "5.00",
      "standardOvertime": "1.00",
      "default": false,
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610139"
        }
      ]
    },
    {
      "rateId": "970000054610140",
      "rateNumber": "RATE_4",
      "rateType": "HOURLY_RATE",
      "description": "This is for dancing",
      "amount": "21.22",
      "standardHours": "5.00",
      "default": false,
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates/970000054610140"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/compensation/payrates"
    }
  ]
}