/
PA
payroll-engine
/
Payroll Engine Backend API v1
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 3w ago
View markdown
payroll-engine
Payroll Engine Backend API v1
post
/api/tenants/{tenantId}/payruns/jobs
v1
latest
OpenAPI 3.0.4
2026-07-17
316
155
717.9 KB
Administration
5
Calendars
9
Case fields
6
Case relations
7
Cases
7
Collectors
7
Company case changes
5
Company case documents
3
Company case values
4
Divisions
9
Employee case changes
5
Employee case documents
3
Employee case values
4
Employees
10
Global case changes
5
Global case documents
3
Global case values
4
Logs
5
Lookup values
7
Lookups
10
National case changes
5
National case documents
3
National case values
4
Payroll consolidated results
5
Payroll layers
9
Payroll results
11
Payrolls
33
Payrun jobs
13
get
/api/tenants/{tenantId}/payruns/jobs
post
/api/tenants/{tenantId}/payruns/jobs
options
/api/tenants/{tenantId}/payruns/jobs
get
/api/tenants/{tenantId}/payruns/jobs/employees/{employeeId}
get
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}
delete
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}
post
/api/tenants/{tenantId}/payruns/jobs/import
post
/api/tenants/{tenantId}/payruns/jobs/preview
get
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/status
post
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/status
get
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/attributes/{attributeName}
post
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/attributes/{attributeName}
delete
/api/tenants/{tenantId}/payruns/jobs/{payrunJobId}/attributes/{attributeName}
Payrun parameters
6
Payruns
7
Regulations
10
Report logs
5
Report parameters
6
Report templates
6
Reports
14
Scripts
6
Tasks
9
Tenants
13
Users
11
Wage types
7
Webhook messages
6
Webhooks
9
Payrun jobs
post
/api/tenants/{tenantId}/payruns/jobs
Path parameters
tenantId
integer
required
Request body
PayrunJobInvocation
required
id
integer
status
'Active'
|
'Inactive'
created
string
date-time
updated
string
date-time
payrunName
string
required
userIdentifier
string
required
payrunJobId
integer
parentJobId
integer
nullable
name
string
required
owner
string
nullable
retroJobs
RetroPayrunJob[]
nullable
tags
string[]
nullable
forecast
string
nullable
retroPayMode
'ValueChange'
|
'None'
jobResult
'Full'
|
'Incremental'
jobStatus
'Draft'
|
'Release'
|
'Process'
|
'Complete'
|
'Forecast'
|
'Abort'
|
'Cancel'
completedJobStatus
'Draft'
|
'Release'
|
'Process'
|
'Complete'
|
'Forecast'
|
'Abort'
|
'Cancel'
periodStart
string
date-time
required
evaluationDate
string
date-time
nullable
reason
string
required
storeEmptyResults
boolean
logLevel
'Verbose'
|
'Debug'
|
'Information'
|
'Warning'
|
'Error'
|
'Fatal'
employeeIdentifiers
string[]
nullable
attributes
object
nullable
Response
Accepted