Start Void Payroll

Start void payroll.
Returns status data about run for UI rendering.
Call is NOT idempotent - you can start as much void 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

ID of Company

Body Params
int32 | null

Year where voiding payrolls belongs to

date-time | null
required

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

date-time | null
required

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

date-time | null
required

Pay Date Data type is validated and must be Number

boolean | null

Reissue voided checks

int32 | null

Payroll ID for full payroll void

paystubs
array of objects | null

List of Employees and their paystubs for void

paystubs
Headers
string
Defaults to 1.0

The requested 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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain