Start Named Payroll

Start payroll based on named policy.
Returns status data about run for UI rendering.
Call is idempotent - in case that payroll already running, you will get same status entity with information about currently running payroll.

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

string
required

Payroll Policy name. DEFAULT is reserved for Default payroll policy used by Start Default Payroll endpoint.

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