Update payroll Gross up

patch https://api.worklio.com/wep/companies/{companyId}/payroll/{runId}/paystubs/{paystubId}/grossup

Update paystub Gross up in payroll run.

This endpoint can be called only by System and Admin level users and can be called only for payrolls on Timesheet step.

Employee call will return Forbidden result even for Employee own company.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

ID of Company

runId

int32

required

Payroll Run ID. ID is returned from Start Default Payroll or Start Named Payroll endpoint.

paystubId

int32

required

Paystub Id

Body Params

Data for updating Gross up record.

mode

int32

required

Members:

1 - Bonus ( Gross up bonus amount. )
2 - WholeCheck ( Gross up whole check. )

payCode

int32

required

Members:

0 - AdditionalEarnings ( Additional pay codes earnings. )
1 - Bonus ( Bonus included in a regular payroll. )
2 - Commission ( Commission paid on a regular payroll. )
3 - Overtime ( Overtime paid at defined times the average hourly rate. )
4 - OtherFlatAmount ( Other flat amount earnings. )
5 - PaidTimeOff ( Time off pay for use with both hourly and salaried employees. )
6 - Hourly ( Pay based on hours worked. )
7 - SalaryWithHours ( Salary amounts recorded with hours worked. )
8 - SickTime ( Sick time. )
9 - Contractor1099 ( Non-taxable amounts paid to non-employee contractors. )
10 - Reimbursement ( Reimbursements for various types of expense. )
13 - UnitsWithHours ( Pay based on units with hours worked recorded. )

additionalPayCode

string | null

Additional pay code for AdditionalEarnings type.

divisionId

int32 | null

Division Id.

workLocationId

int32 | null

required

Work Location Id. Use 0 for 'Works From Home'. Work Locations can be retrieved and managed by Worklocations endpoints.

wcCode

string | null

Workers' Compensation Code.

jobCosting

object

amount

double | null

required

Guaranteed net amount.

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

Response

Language

Credentials

Bearer

jwt


xxxxxxxxxx
12
1
curl --request PATCH \
2
     --url https://api.worklio.com/wep/companies//payroll//paystubs//grossup \
3
     --header 'accept: application/json' \
4
     --header 'api-version: 1.0' \
5
     --header 'content-type: application/*+json' \
6
     --header 'x-api-version: 1.0' \
7
     --data '
8
{
9
  "mode": 1,
10
  "payCode": 0
11
}
12
'

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

application/json

text/json

text/plain

200Success