/
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 2h ago · Updated 3w ago
View markdown
payroll-engine
Payroll Engine Backend API v1
get
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}
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
get
/api/tenants/{tenantId}/regulations/{regulationId}/cases
post
/api/tenants/{tenantId}/regulations/{regulationId}/cases
options
/api/tenants/{tenantId}/regulations/{regulationId}/cases
get
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}
put
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}
delete
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}
put
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}/rebuild
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
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
Cases
get
/api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}
Path parameters
tenantId
integer
required
regulationId
integer
required
caseId
integer
required
Response
OK
Case
required
id
integer
status
'Active'
|
'Inactive'
created
string
date-time
updated
string
date-time
caseType
'Global'
|
'National'
|
'Company'
|
'Employee'
required
name
string
required
nameLocalizations
object
nullable
nameSynonyms
string[]
nullable
description
string
nullable
descriptionLocalizations
object
nullable
defaultReason
string
nullable
defaultReasonLocalizations
object
nullable
baseCase
string
nullable
baseCaseFields
CaseFieldReference[]
nullable
overrideType
'Active'
|
'Inactive'
cancellationType
'None'
|
'Case'
hidden
boolean
availableExpression
string
nullable
buildExpression
string
nullable
validateExpression
string
nullable
lookups
string[]
nullable
slots
CaseSlot[]
nullable
availableActions
string[]
nullable
buildActions
string[]
nullable
validateActions
string[]
nullable
attributes
object
nullable
clusters
string[]
nullable