Sign in
Payrolls

get/api/tenants/{tenantId}/payrolls/{payrollId}/casefields

Path parameters

tenantIdinteger required
payrollIdinteger required

Query parameters

caseFieldNamesstring[]
clusterSetNamestring
evaluationDatestring date-time
overrideType'Active' | 'Inactive'
regulationDatestring date-time

Response

OK

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

Changed in 3 of the 18 revisions of this API.1818

  • e70510c477002See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

  • b58fbaf73c7d16See the full diff
    • ●

      added the new CycleEnd enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleEnd enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleEndDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleEndDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleStart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleStart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleStartDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CycleStartDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodEnd enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodEnd enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodEndDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodEndDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodStart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodStart enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodStartDate enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PeriodStartDate enum value to the / response property for the response status

      response-property-enum-value-added

  • fd1b5146be4a18See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      removed the CycleEnd enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleEnd enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleEndDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleEndDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleStart enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleStart enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleStartDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CycleStartDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodEnd enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodEnd enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodEndDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodEndDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodStart enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodStart enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodStartDate enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PeriodStartDate enum value from the / response property for the response status

      response-property-enum-value-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog