Show / Hide Table of Contents

Namespace PayrollEngine.Client.Scripting.Function

Classes

ActionValue

Action value

CaseAvailableFunction

Determines whether a case is available for input (default: true).

CaseBuildFunction

Populates case fields before the input form is displayed to the user.

CaseChangeFunction

Base class for case change functions that operate on a case being entered or modified.

CaseFunction

Base class for all case scripting functions.

CaseRelationBuildFunction

Populates target case fields based on source case values when a case relation is applied.

CaseRelationFunction

Base class for case relation functions that operate on a source/target case pair.

CaseRelationValidateFunction

Validates the combined state of source and target case fields within a case relation.

CaseValidateFunction

Validates case field values when the user submits the input form.

CaseValueColumn

Case value column

CollectorApplyFunction

Controls how a wage type value is applied to the collector, and can modify or veto the amount.

CollectorEndFunction

Executes when a collector is finalized in a payrun, after all wage type values have been applied.

CollectorFunction

Abstract base class for collector functions, providing access to collector state, statistics, result attributes, custom results, and retro payrun scheduling.

CollectorStartFunction

Executes when a collector is first activated in a payrun, before any wage type values are applied.

Function

Base class for any scripting function

LookupValueData

Represents the API LookupValueData object

PayrollFunction

Payroll function

PayrunEmployeeAvailableFunction

Determines whether an employee participates in the current payrun (default: true).

PayrunEmployeeEndFunction

Executes at the end of each employee's payrun processing, after all wage types and collectors have completed.

PayrunEmployeeStartFunction

Executes at the start of each employee's payrun processing, before any wage types are evaluated.

PayrunEndFunction

Executes once at the end of a payrun, after all employees have been processed.

PayrunFunction

Payrun function

PayrunStartFunction

Executes once at the start of a payrun, before any employee is processed.

PayrunWageTypeAvailableFunction

Determines whether a specific wage type is evaluated for an employee in the current payrun (default: true).

ReportBuildFunction

Configures the report before it is executed: populates parameter lists, sets defaults, and controls parameter visibility.

ReportEndFunction

Post-processes the assembled report data set after all queries have been executed.

ReportFunction

Abstract base class for report functions, providing access to the report name, parameters, attributes, API query execution, lookup resolution, and case value retrieval.

ReportStartFunction

Executes at the start of report data collection, after parameters are finalized and before the data set is assembled.

WageTypeFunction

Wage type function

WageTypeResultFunction

Wage type function

WageTypeValueFunction

Wage type function

Enums

ActionValueType

Action value type

☀
☾
Back to top Generated by DocFX