/
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 50m ago · Updated 3w ago
View markdown
payroll-engine
Payroll Engine Backend API v1
get
/api/tenants/{tenantId}/payruns/{payrunId}
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
Payrun parameters
6
Payruns
7
get
/api/tenants/{tenantId}/payruns
post
/api/tenants/{tenantId}/payruns
options
/api/tenants/{tenantId}/payruns
get
/api/tenants/{tenantId}/payruns/{payrunId}
put
/api/tenants/{tenantId}/payruns/{payrunId}
delete
/api/tenants/{tenantId}/payruns/{payrunId}
put
/api/tenants/{tenantId}/payruns/{payrunId}/rebuild
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
Payruns
get
/api/tenants/{tenantId}/payruns/{payrunId}
Path parameters
tenantId
integer
required
payrunId
integer
required
Response
OK
Payrun
required
id
integer
status
'Active'
|
'Inactive'
created
string
date-time
updated
string
date-time
payrollId
integer
name
string
required
nameLocalizations
object
nullable
defaultReason
string
nullable
defaultReasonLocalizations
object
nullable
startExpression
string
nullable
employeeAvailableExpression
string
nullable
employeeStartExpression
string
nullable
employeeEndExpression
string
nullable
wageTypeAvailableExpression
string
nullable
endExpression
string
nullable
retroBackCycles
integer