Skip to content

PayrunModel

Jani Giannoudis edited this page Jan 21, 2026 · 1 revision

Payrun Model

The creation of Payrun objects requires that the case model is available. The following procedure is recommended for modelling.

  1. Determination of output values
    • Payslip data
    • Data required by law (monthly, annual)
    • Data for peripheral systems such as financial accounting
  2. Split the output values to
    • Wage type: The calculation step for an output value
    • Collector: Aggregation values based on wage types
  3. Determination of wage types with processing order
  4. Determination of collectors and assignment to wage types
  5. Determination of clusters and assignment to wage types (optional)

Wage Types and Collectors

The wage types are usually 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 the use of payroll results, step 5 additionally maps the collector results as wage types.

The next step is to determine the wage type 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

To record wage types and collectors, it is advisable to create an assignment matrix. The following example shows such a 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 result is listed by the withholding tax collector as wage type 9070.

The table can be expanded for special cases:

  • Additional clustering columns
  • Collectors can be grouped for complex scenarios

Sub Wage Types

Wage types are calculated in numerical order, which allows you to define sub-wage types.

In the following example, sub wage type 1000.1 calculates the year-to-date value of wage type 1000.

Wage type # Wage type name Calculation formula
1000 Monthly wage ...
1000.1 Monthly wage yar-to-date total of wage type 1000 from all cycle periods

Sub wage types with complex data queries can be excluded using clustering.

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 take different calendars into account, this can vary per wage type.

Wage type # Wage type name Calendar
1000 Monthly wage Month payroll calendar
1001 Bi-Week wage Bi-Week payroll calendar

Additional Payroll Results

Additional payroll results can be stored as:

  • Wage type result attributes for good performance
  • Custom wage type result for easy evaluation access
  • Payrun result to store other, including non-numerical results

Low-code example of how to set a custom attribute used in the wage type value expression.

SetResultAttribute("MyAttribute", 2560)

Low-code example of how to add a custom result used in the wage type value expression.

AddCustomResult("MySource", 9217)

No-code example of how to set a payrun result used in the wage type value action.

^|MyPayrunResult = PeriodStartDate

Next steps

Clone this wiki locally