Payrolls

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

Request

Path parameters

tenantIdinteger required
payrollIdinteger required

Query parameters

evaluationDatestring date-time
regulationDatestring date-time
reportNamesstring[]

Response

OK

idinteger
status'Active' | 'Inactive'
createdstring date-time
updatedstring date-time
namestring required
nameLocalizationsobject nullable
descriptionstring nullable
descriptionLocalizationsobject nullable
mandatoryboolean
hiddenboolean
valuestring nullable
valueType'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'
parameterType'Value' | 'Now' | 'Today' | 'TenantId' | 'UserId' | 'EmployeeId' | 'RegulationId' | 'PayrollId' | 'PayrunId' | 'ReportId' | 'WebhookId'
overrideType'Active' | 'Inactive'
attributesobject nullable

Changes

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