Sign in

v1

latestOpenAPI 3.0.42026-07-17316155717.9 KB
Report parameters

put/api/tenants/{tenantId}/regulations/{regulationId}/reports/{reportId}/parameters/{parameterId}

Path parameters

tenantIdinteger required
regulationIdinteger required
reportIdinteger required
parameterIdstring required

Request body

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

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