Add new payroll Gross up

post

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

Add new 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Company Id

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 to create a new Gross up record.

mode

int32

enum

required

Members:

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

Allowed:

payCode

int32

enum

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

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

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200Success