Update an existing pay class.

put

https://api.hcssapps.com/e360/api/v1/payClasses/{id}

Equipment360 preserves the rates that historical time cards were costed with. Updating a
pay class therefore writes the new values to a brand new record, repoints employees and
job wage mappings at it, and retires the previous record through a soft delete. The
response contains the new record, so its id differs from the id supplied in the route.

Setting isDeleted to true retires the pay class. This is one-way: sending false does not
restore a retired pay class, matching the behaviour of the Equipment360 setup screen.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The pay class guid.

Body Params

The details of the pay class to update. Omitted fields keep their current value.

A representation of a Pay Class object to be updated by the API. Any field that is omitted
from the request - or sent as null - keeps its current value. Send an empty string or 0 to
clear a field.

code

string | null

The pay class code. Must be unique among the active pay classes of the setup library.
Cannot be set to an empty or whitespace only value.

description

string | null

The description. Send an empty string to clear it.

baseRate

double | null

The base hourly rate.

overtimeFactor

double | null

The multiplier applied to the base rate for overtime hours.

doubleTimeFactor

double | null

The multiplier applied to the base rate for double time hours.

taxPercentage

double | null

The tax percentage.

fringeWithOvertime

double | null

The fringe rate that is affected by overtime.

fringeWithoutOvertime

double | null

The fringe rate that is not affected by overtime.

isOverride

boolean | null

Whether this is an override pay class instead of a regular one.

isDeleted

boolean | null

Set to true to soft delete the pay class, which is the equivalent of the Remove button in
Equipment360. Any other field sent alongside it is ignored, matching the behaviour of the
setup screen, where removing a row discards its pending edits. This is one-way:
Equipment360 offers no way to restore a deleted pay class, so sending false has no effect
and a pay class that is already deleted can no longer be updated at all.

accountingCode

string | null

The accounting code. Send an empty string to clear it.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success