Update Earnings (Extended)

patch

https://api.worklio.com/wep/companies/{companyId}/payroll2/{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.
Extended functionality: Supports Workers' Compensation Codes and more paylines on one pay stub.

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 (Pay Stub 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:

paylines

array of objects | null

Paylines

paylines

deductions

array of objects | null

Additional miscellaneous deductions.

deductions

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