---
title: "GET /api/tenants/{tenantId}/payrolls/{payrollId}/casefields"
method: GET
path: "/api/tenants/{tenantId}/payrolls/{payrollId}/casefields"
tags: ["Payrolls"]
---

# GET /api/tenants/{tenantId}/payrolls/{payrollId}/casefields

`GET /api/tenants/{tenantId}/payrolls/{payrollId}/casefields`

## Path parameters

- `tenantId` integer, required
- `payrollId` integer, required

## Query parameters

- `caseFieldNames` string[]
- `clusterSetName` string
- `evaluationDate` string, date-time
- `overrideType` 'Active' | 'Inactive'
- `regulationDate` string, date-time

## Response `200`

OK

- CaseField[]
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, 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'
  - `culture` string, nullable
  - `valueMandatory` boolean
  - `order` integer
  - `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'
  - `endMandatory` boolean
  - `defaultStart` string, nullable
  - `defaultEnd` string, nullable
  - `defaultValue` string, nullable
  - `tags` string[], nullable
  - `lookupSettings` LookupSettings
    - `lookupName` string, required
    - `valueFieldName` string, nullable
    - `textFieldName` string, nullable
  - `clusters` string[], nullable
  - `attributes` object, nullable
  - `valueAttributes` object, nullable

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1.md) · [All operations](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payroll-engine/payroll-engine-backend-api-v1/versions/34e260deaa2c/schema)