Update Earnings

patch

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

Update Earnings item.
Items vales must follow Setup settings (for example - there is difference between different wage types) you should call Earnings Setup endpoint first.

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

ID of Company

runId

int32

required

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

paystubId

int32

required

Earnings ID. ID is returned from Get list of Earnings endpoint.

Body Params

paymentMethod

int32

enum

Members:

0 - NetPayAlloc ( Payment method is defined by net pay allocation on employee. )
1 - Check ( Check. )

Allowed:

rate

double | null

Pay rate. Used as multiplier for hourly earning items.

salaryWithHours

object

hourly

object

overtime

object

sickTime

object

pto

object

bonus

object

commission

object

other

object

contractor1099

object

reimbursement

object

unitsWithHours

object

additionalEarnings

array of objects | null

Additional earnings. Earnings items must be setup via API or Support.

additionalEarnings

deductions

array of objects | null

Additional miscellaneous deductions.

deductions

locationId

int32 | null

ID of Work Location. Work Locations can be retrieved and managed by Worklocations endpoints.

divisionId

int32 | null

ID of Division. RESERVED FOR FUTURE USE, NOT SUPPORTED NOW!

jobCosting

object

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

Language

Credentials

Bearer

jwt

Loading…

Response

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

application/json

text/json

text/plain

200Success