BaseConcepts

Base Concepts

Languages

The Payroll Engine service supports all RFC 4646 languages, with English as the translation base. English identifiers are used for all object references between objects.

Audit Trail

For all central payroll data, the engine logs every change in an audit trail. This applies to all regulation objects and case data. The audit trail of case data also serves as the basis for calculating period values.

Data Types

The engine provides the following data types:

Data Type	JSON	C#	Domain
String	String	string
WebResource	String	string	RFC 1738
Date, DateTime	String	DateTime	ISO 8601
Integer	Integer	Int32	Signed 32-bit integer
Decimal, Money, Percent, Hour, Day, Week, Month, Year, Distance, NumericBoolean	Number	decimal	28 decimal digits, 6 fractional digits
Boolean	Boolean	bool
None	Null	null

Object Properties

Every API object has the following base properties:

Property	Description
Id	Unique identification — sequential number within its type
Created	Engine time of creation in UTC
Updated	Engine time of last modification in UTC
Status	Object status: active (default) or inactive

Object Attributes

Object attributes are user-defined data whose content has no influence on the engine's behavior. Attributes can be used for the following scenarios:

• References to external objects in surrounding systems
• Storage of additional data (when no time value or case value is appropriate)
• Control in client applications, e.g. controlling the input of case data
• Control and parameterization of scripting functions (collector or wage type)
• Storage of additional wage type results, e.g. reporting data

Attributes are managed in a key-value dictionary within the object. Some objects provide API endpoints to edit object attributes directly. In REST queries, attribute fields can also be used for filtering (see Attribute Queries).

Objects with Attributes

Object	Attribute	Audit
Tenant	✓
User	✓
Calendar	✓
Task	✓
Division	✓
Employee	✓
Payroll	✓
Payroll Layer	✓
Payrun Job	✓
Webhook	✓
Regulation	✓
Case	✓
Case Field	✓
Case Relation	✓
Collector	✓
Wage Type	✓
Report	✓	✓
Case Value	✓
Payroll Result	✓

See also

• Time Data
• Calendars
• Technical Integration