Skip to content

Wage Types & Collectors

Processing Order

Wage types are typically executed in the following order:

  1. Income and benefits
  2. Gross salary
  3. Deductions and expenses
  4. Net salary
  5. Consolidated values (Collectors)

To simplify access to payroll results, step 5 additionally maps collector results as wage types.

Number Ranges

Wage Type Range Scope
1000 - 4999 Income and benefits
5000 - 5009 Gross salary
5010 - 6499 Deductions and expenses
6500 - 6599 Net salary
6600 - 9099 Consolidated values

Assignment Matrix

To document wage types and collectors, it is advisable to create an assignment matrix:

Wage Type # Wage Type Name Gross Salary Collector Withholding Tax Collector
1000 Monthly wage yes yes
... ... . .
1005 Hourly wage yes yes
... ... . .
1980 Further education yes no
... ... . .
5000 Gross salary no no
... ... . .
6500 Net salary no no
... ... . .
9070 Withholding tax no no

In this example, the withholding tax collector result is exposed as wage type 9070.

The matrix can be extended for special cases — additional clustering columns, or grouped collectors for complex scenarios.

Payrun with Multiple Calendars

The calculation of wage data is based on the calendar assigned to the employee, division or tenant. In situations where a payrun must handle different calendars, this can be configured per wage type:

Wage Type # Wage Type Name Calendar
1000 Monthly wage Monthly payroll calendar
1001 Bi-week wage Bi-week payroll calendar

Additional Payroll Results

Additional payroll results can be stored as:

  • Wage type result attributes — best performance
  • Custom wage type results — easy to query
  • Payrun results — for non-numerical or arbitrary data

Low-code example: set a custom attribute in the wage type value expression.

SetResultAttribute("MyAttribute", 2560)

Low-code example: add a custom result in the wage type value expression.

AddCustomResult("MySource", 9217)

No-code example: set a payrun result using a wage type value action.

^|MyPayrunResult = PeriodStartDate

Payroll Results

The results of the payrun are stored in the following objects:

Object Description
Collector Result The aggregated decimal result of a collector
Collector Custom Result User-defined collector result (decimal)
Payrun Result Payrun-specific result, including non-numerical values
Wage Type Result The wage type result (decimal) including custom attributes
Wage Type Custom Result User-defined wage type result (decimal)

Cluster sets in the payroll configuration control which results are generated (see Clusters).

Wage Type Custom Results are also generated automatically — one per case value time split — when clusterSetWageTypePeriod is configured on the payroll. See Wage Calculation Traceability.

See Also