PApayroll-engine

Administration5

Calendars9

Case fields6

Case relations7

Cases7

Collectors7

Company case changes5

Company case documents3

Company case values4

Divisions9

Employee case changes5

Employee case documents3

Employee case values4

Employees10

Global case changes5

Global case documents3

Global case values4

Logs5

Lookup values7

Lookups10

National case changes5

National case documents3

National case values4

Payroll consolidated results5

Payroll layers9

Payroll results11

Payrolls33

Payrun jobs13

Payrun parameters6

Payruns7

Regulations10

Report logs5

Report parameters6

Report templates6

Reports14

Scripts6

Tasks9

Tenants13

Users11

Wage types7

Webhook messages6

Webhooks9

Case fields

POST /api/tenants/{tenantId}/regulations/{regulationId}/cases/{caseId}/fields

Changed on Mar 9, 2026

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/regulations/:regulationId/cases/:caseId/fields/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantIdinteger required

caseIdinteger required

regulationIdstring required

Request body

idinteger

status'Active' | 'Inactive'

createdstring date-time

updatedstring date-time

namestring required

nameLocalizationsobject nullable

descriptionstring nullable

descriptionLocalizationsobject nullable

valueType'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'

valueScope'Local' | 'Global'

timeType'Timeless' | 'Moment' | 'Period' | 'CalendarPeriod'

timeUnit'Day' | 'HalfDay' | 'Month'

periodAggregation'Summary' | 'Last' | 'First'

overrideType'Active' | 'Inactive'

cancellationMode'TimeType' | 'Previous' | 'Keep' | 'Reset' | 'Invert'

valueCreationMode'OnChanges' | 'Always' | 'Discard'

culturestring nullable

valueMandatoryboolean

orderinteger

startDateType'Day' | 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Month' | 'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December' | 'Year' | 'PeriodStart' | 'PeriodStartDate' | 'PeriodEnd' | 'PeriodEndDate' | 'CycleStart' | 'CycleStartDate' | 'CycleEnd' | 'CycleEndDate'

endDateType'Day' | 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Month' | 'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December' | 'Year' | 'PeriodStart' | 'PeriodStartDate' | 'PeriodEnd' | 'PeriodEndDate' | 'CycleStart' | 'CycleStartDate' | 'CycleEnd' | 'CycleEndDate'

endMandatoryboolean

defaultStartstring nullable

defaultEndstring nullable

defaultValuestring nullable

tagsstring[] nullable

clustersstring[] nullable

attributesobject nullable

valueAttributesobject nullable

Response

Created

idinteger

status'Active' | 'Inactive'

createdstring date-time

updatedstring date-time

namestring required

nameLocalizationsobject nullable

descriptionstring nullable

descriptionLocalizationsobject nullable

valueType'String' | 'Boolean' | 'Integer' | 'NumericBoolean' | 'Decimal' | 'DateTime' | 'None' | 'Date' | 'Weekday' | 'Month' | 'Year' | 'Money' | 'Percent' | 'WebResource'

valueScope'Local' | 'Global'

timeType'Timeless' | 'Moment' | 'Period' | 'CalendarPeriod'

timeUnit'Day' | 'HalfDay' | 'Month'

periodAggregation'Summary' | 'Last' | 'First'

overrideType'Active' | 'Inactive'

cancellationMode'TimeType' | 'Previous' | 'Keep' | 'Reset' | 'Invert'

valueCreationMode'OnChanges' | 'Always' | 'Discard'

culturestring nullable

valueMandatoryboolean

orderinteger

startDateType'Day' | 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Month' | 'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December' | 'Year' | 'PeriodStart' | 'PeriodStartDate' | 'PeriodEnd' | 'PeriodEndDate' | 'CycleStart' | 'CycleStartDate' | 'CycleEnd' | 'CycleEndDate'

endDateType'Day' | 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Month' | 'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December' | 'Year' | 'PeriodStart' | 'PeriodStartDate' | 'PeriodEnd' | 'PeriodEndDate' | 'CycleStart' | 'CycleStartDate' | 'CycleEnd' | 'CycleEndDate'

endMandatoryboolean

defaultStartstring nullable

defaultEndstring nullable

defaultValuestring nullable

tagsstring[] nullable

clustersstring[] nullable

attributesobject nullable

valueAttributesobject nullable

Changes

Mar 9, 2026642427b60b7a Revision changes
- warning
  added the new 8192.00 enum value to the //////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the //////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////// response property for the response status
- warning
  added the new 8192.00 enum value to the /////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ///////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////////// response property for the response status
- warning
  added the new 8192.00 enum value to the ////////// response property for the response status
Jan 7, 2026e70510c47700 Revision changes
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status

Operation history (5 revisions)