Modify an existing earning.

put

https://api.greenshadesonline.com/payroll/earnings/{earningCode}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

earningCode

string

required

The earning to update.

Query Params

workspaceId

integer

required

Results are filtered by workspace Id

Body Params

string

code

string

length ≤ 50

displayName

string | null

description

string | null

group

string | null

startDate

date

endDate

date | null

schedulingOptions

object

Describe how often this code is paid and how those payments are scheduled.

calculationMethod

string

enum

Allowed:

taxType

string

enum

category

string

enum

workLocationCode

string

length ≤ 50

^[a-zA-Z0-9]+$

departmentCode

string

length ≤ 50

^[a-zA-Z0-9]+$

positionCode

string

length ≤ 50

^[a-zA-Z0-9]+$

amount

number

contributesToRegularPay

boolean

isReportedEarnings

boolean

accruesTimeOff

boolean

ffcraLeaveType

string

enum

For use in situations when category is "PaidTimeOff" and taxType is "FFCRALeave"

Allowed:

box12

string

enum

box14

string

length ≤ 15

shiftOptions

object | null

For use when category is "ShiftDifferential" or "ShiftDifferentialPremium"

maximums

array of objects

maximums

taxOptions

object

Provides basic taxability options for certain types of payroll codes.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

204

Success

Language

Credentials

OAuth2

Loading…

Response

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

*/*

400Bad Request

401Unauthorized

404Not Found