API Reference also available as Swagger UI.
Get the payroll wage type master.
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
query Parameters
evaluationDateThe evaluation date (default: UTC now)
languageThe language
The payroll languages
regulationDateThe regulation date (default: UTC now)
Headers
Content-TypeThe request content type
Get the payroll wage type master. › Responses
Success
wageTypeNumberThe wage type number
nameThe wage type name
The localized wage type names
displayNameThe localized wage type name
descriptionThe wage type description
categoryThe wage type category
Associated collectors
isActiveIndicates if the wage type is active or not
isCopyableIndicates if the wage type is copyable or not
isLocalizableIndicates if the wage type is localizable by the user or not
isAccountingRelevantIndicates if the wage type is relevant for accounting or not. Wage types with this set to true need to have an account assignment, otherwise the open payrun period cannot be closed.
Represents the debit and credit account numbers assigned to a wage type.
activeControllingTriggersThe active controlling triggers
The available controlling triggers
controllingTriggerSelectionModeDefines the mode of selection for wage type controlling triggers.
Automatic: The controlling happens automatically based on predefined rules. The user cannot select a trigger.Single: One trigger can be selected.Multiple: Multiple triggers can be selected.
The wage type attributes. These are for internal use and may change at any time.
Localized properties of the wage type.
Copy wage type
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
query Parameters
copyFromWageTypeNumberThe wage type number to copy from
Headers
Content-TypeThe request content type
Copy wage type › Responses
Created
Updates payroll wage types.
path Parameters
tenantIdThe tenant id.
payrollIdThe payroll id.
Headers
Content-TypeThe request content type
Updates payroll wage types. › Request Body
wageTypeNumberThe number of the wage type to update.
Localized wage type names keyed by language code. Entries for all supported languages are required: "de", "en", "fr" and "it".
collectorsNames of the collectors that should be active. This should include the full list of the collectors (even collectors that are not changeable).
Represents the debit and credit account numbers assigned to a wage type.
activeControllingTriggersThe active controlling triggers for the wage type.
Updates payroll wage types. › Responses
Success
Activate wage type
A wage type cannot be deactivated.
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
wageTypeNumberThe wage type number to activate
Headers
Content-TypeThe request content type
Activate wage type › Responses
Success