/
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
put
/api/tenants/{tenantId}/payrolls/{payrollId}
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
get
/api/tenants/{tenantId}/payrolls
post
/api/tenants/{tenantId}/payrolls
options
/api/tenants/{tenantId}/payrolls
get
/api/tenants/{tenantId}/payrolls/{payrollId}
put
/api/tenants/{tenantId}/payrolls/{payrollId}
delete
/api/tenants/{tenantId}/payrolls/{payrollId}
get
/api/tenants/{tenantId}/payrolls/{payrollId}/regulations
get
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/available
post
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/build/{caseName}
get
/api/tenants/{tenantId}/payrolls/{payrollId}/changes/values
get
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values
get
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/time
get
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/periods
get
/api/tenants/{tenantId}/payrolls/{payrollId}/cases
post
/api/tenants/{tenantId}/payrolls/{payrollId}/cases
post
/api/tenants/{tenantId}/payrolls/{payrollId}/cases/bulk
get
/api/tenants/{tenantId}/payrolls/{payrollId}/casefields
get
/api/tenants/{tenantId}/payrolls/{payrollId}/caserelations
get
/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypes
get
/api/tenants/{tenantId}/payrolls/{payrollId}/collectors
get
/api/tenants/{tenantId}/payrolls/{payrollId}/lookups
get
/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values
get
/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/data
get
/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values/data
get
/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/ranges
get
/api/tenants/{tenantId}/payrolls/{payrollId}/reports
get
/api/tenants/{tenantId}/payrolls/{payrollId}/reports/parameters
get
/api/tenants/{tenantId}/payrolls/{payrollId}/reports/templates
get
/api/tenants/{tenantId}/payrolls/{payrollId}/scripts
get
/api/tenants/{tenantId}/payrolls/{payrollId}/actions
get
/api/tenants/{tenantId}/payrolls/{payrollId}/attributes/{attributeName}
post
/api/tenants/{tenantId}/payrolls/{payrollId}/attributes/{attributeName}
delete
/api/tenants/{tenantId}/payrolls/{payrollId}/attributes/{attributeName}
Payrun jobs
13
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
Payrolls
put
/api/tenants/{tenantId}/payrolls/{payrollId}
Path parameters
tenantId
integer
required
payrollId
string
required
Request body
Payroll
required
id
integer
status
'Active'
|
'Inactive'
created
string
date-time
updated
string
date-time
name
string
required
nameLocalizations
object
nullable
description
string
nullable
descriptionLocalizations
object
nullable
divisionId
integer
required
clusterSetCase
string
nullable
clusterSetCaseField
string
nullable
clusterSetCollector
string
nullable
clusterSetCollectorRetro
string
nullable
clusterSetWageType
string
nullable
clusterSetWageTypeRetro
string
nullable
clusterSetCaseValue
string
nullable
clusterSetWageTypePeriod
string
nullable
clusterSets
ClusterSet[]
nullable
attributes
object
nullable
Response
OK
Payroll
required
id
integer
status
'Active'
|
'Inactive'
created
string
date-time
updated
string
date-time
name
string
required
nameLocalizations
object
nullable
description
string
nullable
descriptionLocalizations
object
nullable
divisionId
integer
required
clusterSetCase
string
nullable
clusterSetCaseField
string
nullable
clusterSetCollector
string
nullable
clusterSetCollectorRetro
string
nullable
clusterSetWageType
string
nullable
clusterSetWageTypeRetro
string
nullable
clusterSetCaseValue
string
nullable
clusterSetWageTypePeriod
string
nullable
clusterSets
ClusterSet[]
nullable
attributes
object
nullable