Payrolls

GET /api/tenants/{tenantId}/payrolls/{payrollId}/cases/available

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/docs/api/tenants/:tenantId/payrolls/:payrollId/cases/available/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantIdinteger required

payrollIdinteger required

Query parameters

userIdinteger required

caseType'Global' | 'National' | 'Company' | 'Employee' required

employeeIdinteger

caseNamesstring[]

clusterSetNamestring

culturestring

evaluationDatestring date-time

hiddenboolean

regulationDatestring date-time

Response

idinteger

status'Active' | 'Inactive'

createdstring date-time

updatedstring date-time

caseType'Global' | 'National' | 'Company' | 'Employee' required

namestring required

nameLocalizationsobject nullable

nameSynonymsstring[] nullable

descriptionstring nullable

descriptionLocalizationsobject nullable

defaultReasonstring nullable

defaultReasonLocalizationsobject nullable

baseCasestring nullable

overrideType'Active' | 'Inactive'

cancellationType'None' | 'Case'

hiddenboolean

availableExpressionstring nullable

buildExpressionstring nullable

validateExpressionstring nullable

lookupsstring[] nullable

availableActionsstring[] nullable

buildActionsstring[] nullable

validateActionsstring[] nullable

attributesobject nullable

clustersstring[] nullable

Changes

No recorded changes to this operation across all 20 revisions of this API.