Payrolls

GET /api/tenants/{tenantId}/payrolls/{payrollId}/reports

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/reports/get.ts
A function with typed inputs. Its response is checked against the schema.

tenantIdinteger required

payrollIdinteger required

clusterSetNamestring

evaluationDatestring date-time

overrideType'Active' | 'Inactive'

regulationDatestring date-time

reportNamesstring[]

userType'Employee' | 'User' | 'TenantAdministrator' | 'SystemAdministrator'

idinteger

status'Active' | 'Inactive'

createdstring date-time

updatedstring date-time

namestring required

nameLocalizationsobject nullable

descriptionstring nullable

descriptionLocalizationsobject nullable

categorystring nullable

attributeMode'Json' | 'Table'

userType'Employee' | 'User' | 'TenantAdministrator' | 'SystemAdministrator'

reportIsolation'None' | 'Global' | 'Company' | 'Division' | 'Employee'

queriesobject nullable

buildExpressionstring nullable

startExpressionstring nullable

endExpressionstring nullable

overrideType'Active' | 'Inactive'

attributesobject nullable

clustersstring[] nullable

regulationIdinteger

Apr 1, 202634e260deaa2c Revision changes
- info
  added the optional property / to the response with the status
Mar 12, 20258f09691a3e2e Revision changes
- info
  added the new optional query request parameter userType
- info
  added the optional property / to the response with the status