Start Bonus Payroll

post

https://api.worklio.com/wep/companies/{companyId}/payroll/bonus

Start bonus payroll.
Returns status data about run for UI rendering.
Call is NOT idempotent - you can start as much bonus payrolls as you want.

runId from returned entity is used for all calls for that payroll. Including status, timesheet updates and all operations.
Warnings are info only and payroll can continue.
Errors are blocking, and payroll will NOT CONTINUE.

This endpoint can be called only by System and Admin level users.

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

Path Params

companyId

int32

required

ID of Company

Body Params

startDate

date-time | null

required

Pay Period Start Date Data type is validated and must be Number

endDate

date-time | null

required

Pay Period End Date Data type is validated and must be Number

payDate

date-time | null

required

Pay Date Data type is validated and must be Number

month

int32 | null

1 to 12

Month

payrollInMonth

int32 | null

Payroll In Month

includeFlatAmountDeductions

boolean | null

Include Flat Amount Deductions

includeArrears

boolean | null

Include Arrears

includeScheduledPay

boolean | null

Include Scheduled Pay

includeTimeOffAccruals

boolean | null

Include Time Off Accruals

sendPaydayAnnouncementEmail

boolean | null

Send Payday Announcement Email

employeeIDs

array of int32s | null

List of Employee IDs

employeeIDs

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

Response

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

application/json

text/json

text/plain

200Success