Ason Payroll Integration API v1

Schemas

AccountAssignment

debitAccountNumber

string | null

creditAccountNumber

string | null

ActionInfo

Action info

name

string · minLength: 1 · required

The action name

functionType

string · enum

The payroll function type

Enum values:

None

CaseAvailable

CaseBuild

CaseValidate

CaseChange

Case

CollectorStart

CollectorApply

namespace

string | null

The action namespace

description

string | null

The action description

categories

array | null

The action categories

source

string · enum

The action source

Enum values:

Script

System

array | null

The action parameters

array | null

The action issues

ActionIssueInfo

Action issue info

name

string · minLength: 1 · required

The action name

message

string | null

The action issue message

parameterCount

integer · int32

The action issue description

ActionParameterInfo

Action parameter info

name

string · minLength: 1 · required

The action parameter name

description

string | null

The action parameter description

valueTypes

array | null

The action parameter types

valueSources

array | null

The action parameter source types

valueReferences

array | null

The action parameter reference types

ActionSource

string · enum

Enum values:

Script

System

The action source

AvailableCase

id

string · uuid

The case id (immutable)

name

string | null

The case name (immutable)

displayName

string | null

The localized case name (immutable)

nameSynonyms

array | null

Synonyms for the case name

description

string | null

The case description

array | null

The case fields

object | null

The case attributes

AvailableCaseField

id

string · uuid

The case field id (immutable)

name

string | null

The case field name (immutable)

displayName

string | null

The localized case field name (immutable)

description

string | null

AvailableRegulation

name

string | null

displayName

string | null

CalendarCalculationMode

string · enum

Enum values:

MonthCalendarDay

MonthAverageDay

MonthEffectiveWorkDay

MonthAverageWorkDay

WeekCalendarDay

The calculation mode for case value

Case

The regulation case API object

caseType

string · enum · required

The type of a case

Enum values:

Global

Company

Employee

name

string · minLength: 0 · maxLength: 128 · required

The case name (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized case names

nameSynonyms

array | null

Synonyms for the case name

description

string | null

The case description

object | null

The localized case descriptions

defaultReason

string | null

The default case change reason

object | null

The localized default case change reasons

baseCase

string | null · minLength: 0 · maxLength: 128

The base case name

array | null

The base case fields

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

cancellationType

string · enum

The cancellation type of a case

Enum values:

None

Case

periodInputMode

string · enum

The case period selection mode

Enum values:

Individual

Start

StartAndEnd

availableExpression

string | null

The expression used to build a case

buildExpression

string | null

The expression used to build a case

validateExpression

string | null

The case validate expression

lookups

array | null

The case lookups

availableActions

array | null

The case available actions

buildActions

array | null

The case build actions

validateActions

array | null

The case validate actions

object | null

Custom attributes

clusters

array | null

The case clusters

CaseCancellationType

string · enum

Enum values:

None

Case

The cancellation type of a case

CaseChange

Case change with multiple case values of one case type

userId

string · uuid · required

The change user id

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

employeeId

string | null · uuid

The employee id, mandatory for employee case changes (immutable)

divisionId

string | null · uuid

The division id (immutable) If present, this values overrides all case value divisions Ason.Payroll.Api.Model.CaseValue.DivisionId

correlationId

string | null · uuid

The correlation id of the case change

cancellationType

string · enum

The cancellation type of a case

Enum values:

None

Case

cancellationId

string | null · uuid

The cancellation case id (immutable)

cancellationDate

string | null · date-time

The cancellation date (immutable)

reason

string | null

The change reason

validationCaseName

string | null

The validation case name, triggers the case validation (optional)

forecast

string | null

The forecast name

array | null

The case values

object | null

Custom attributes

CaseChangeCaseValue

A case value from a case change used in company and employee case

caseFieldName

string · minLength: 0 · maxLength: 128 · required

The associated case field name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

caseChangeId

string · uuid

The case change id (immutable)

divisionId

string | null · uuid

The division id (immutable) Mandatory for case values with local value scope Ason.Payroll.Api.Model.CaseField.ValueScope

employeeId

string | null · uuid

The employee id, mandatory for employee case changes

caseName

string | null · minLength: 0 · maxLength: 128

The associated case name

object | null

The localized case names

displayCaseName

string | null

The localized case name

object | null

The localized case field names

displayCaseFieldName

string | null

The localized case field name

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

value

string | null

The case value (JSON format)

numericValue

number | null · double

The case numeric value

cancellationDate

string | null · date-time

Cancellation date

start

string | null · date-time

The starting date for the value

end

string | null · date-time

The ending date for the value

forecast

string | null · minLength: 0 · maxLength: 128

The forecast name

tags

array | null

The case value tags

object | null

Custom attributes

caseChangeCreated

string · date-time

The case change creation

userId

string · uuid

The change user id

userIdentifier

string | null · minLength: 0 · maxLength: 128

The user unique identifier

reason

string | null

The change reason

validationCaseName

string | null

The validation case name

cancellationType

string · enum

The cancellation type of a case

Enum values:

None

Case

cancellationId

string | null · uuid

The canceled case change id

correlationId

string · uuid

The case change correlation id

documentCount

integer · int32

The document count

array | null

The case value documents (immutable, set by the server)

CaseChangeSetup

Case change setup

object · required

Case setup

employeeId

string | null · uuid

The employee id, mandatory for employee case changes (immutable)

divisionId

string | null · uuid

The division id (immutable) If present, this values overrides all case value divisions Ason.Payroll.Api.Model.CaseValue.DivisionId

cancellationId

string | null · uuid

The case to cancel, root case name specifies the target case

forecast

string | null

The forecast name

created

string | null · date-time

Case change created date

reason

string | null

The change reason

start

string | null · date-time

The start date if the case is set to Ason.Payroll.CasePeriodInputMode.Start or Ason.Payroll.CasePeriodInputMode.StartAndEnd

end

string | null · date-time

The end date if the case is set to Ason.Payroll.CasePeriodInputMode.StartAndEnd

array | null

The case validation issues

object | null

Custom attributes

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

notify

boolean | null

If set to false, the case change won't trigger notifications.

CaseDocument

The case document API object

name

string · minLength: 1 · required

The document name

content

string · required

The document content

contentType

string · minLength: 0 · maxLength: 128 · required

The document content type

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

CaseDocumentReference

The case document reference API object

id

string · uuid

The document id

name

string | null

The document name

contentType

string | null

The document content type

CaseFieldCancellationMode

string · enum

Enum values:

TimeType

Keep

Reset

Invert

The cancellation mode for a regulation case field

CaseFieldDateType

string · enum

Enum values:

Day

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

The case field date type

CaseFieldReference

Case field reference

name

string | null

The case field name

order

integer | null · int32

The case field order

CaseFieldSet

The case field including the values

name

string · minLength: 1 · required

The case field name (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized case field names

description

string | null

The case field description

object | null

The localized case field descriptions

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

valueScope

string · enum

The scope for a payroll value

Enum values:

Local

Global

timeType

string · enum

The time period type for a regulation case field

Enum values:

Timeless

Moment

Period

ScaledPeriod

timeUnit

string · enum

The date type for a regulation case field

Enum values:

Day

HalfDay

Month

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

cancellationMode

string · enum

The cancellation mode for a regulation case field

Enum values:

TimeType

Keep

Reset

Invert

valueCreationMode

string · enum

The case value creation mode

Enum values:

Default

Always

OnChanges

Discard

optional

boolean

Optional case field

order

integer · int32

The case field order

startDateType

string · enum

The case field date type

Enum values:

Day

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

endDateType

string · enum

The case field date type

Enum values:

Day

Sunday

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

endMandatory

boolean

The end date mandatory state

defaultStart

string | null

The default start value of the case field (date or expression)

defaultEnd

string | null

The default end value of the case field (date or expression)

defaultValue

string | null

The default value of the case field (JSON format)

tags

array | null

The case field tags

valueTags

array | null

The case field tags

object

The lookup settings

clusters

array | null

The case field clusters

buildActions

array | null

The case field build actions

validateActions

array | null

The case field validate actions

object | null

Custom attributes

object | null

Custom value attributes

displayName

string | null · minLength: 0 · maxLength: 128

The case field display name

value

string | null

The case value (JSON format)

start

string | null · date-time

The starting date for the value

end

string | null · date-time

The ending date for the value

cancellationDate

string | null · date-time

Cancellation date

CaseFieldTimeType

string · enum

Enum values:

Timeless

Moment

Period

ScaledPeriod

The time period type for a regulation case field

CaseFieldTimeUnit

string · enum

Enum values:

Day

HalfDay

Month

The date type for a regulation case field

CaseFieldValue

Case field value

value

string · minLength: 1 · required

The case period value as JSON

caseFieldName

string | null

The case field name

object | null

The localized case field names

created

string · date-time

The created date

start

string | null · date-time

The period start date

end

string | null · date-time

The period end date

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

cancellationDate

string | null · date-time

Cancellation date

tags

array | null

The case value tags

object | null

Custom attributes

CaseIssueType

string · enum

Enum values:

Unknown

CaseInvalid

CaseUnknown

CaseFieldDuplicated

CaseValueIncomplete

CaseValueStartMissing

CaseValueStartInvalid

CaseValueEndInvalid

The type of a case issue

CasePeriodInputMode

string · enum

Enum values:

Individual

Start

StartAndEnd

The case period selection mode

CaseSet

The payroll case object, including case fields and related cases

caseType

string · enum · required

The type of a case

Enum values:

Global

Company

Employee

name

string · minLength: 0 · maxLength: 128 · required

The case name (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized case names

nameSynonyms

array | null

Synonyms for the case name

description

string | null

The case description

object | null

The localized case descriptions

defaultReason

string | null

The default case change reason

object | null

The localized default case change reasons

baseCase

string | null · minLength: 0 · maxLength: 128

The base case name

array | null

The base case fields

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

cancellationType

string · enum

The cancellation type of a case

Enum values:

None

Case

periodInputMode

string · enum

The case period selection mode

Enum values:

Individual

Start

StartAndEnd

availableExpression

string | null

The expression used to build a case

buildExpression

string | null

The expression used to build a case

validateExpression

string | null

The case validate expression

lookups

array | null

The case lookups

availableActions

array | null

The case available actions

buildActions

array | null

The case build actions

validateActions

array | null

The case validate actions

object | null

Custom attributes

clusters

array | null

The case clusters

displayName

string | null · minLength: 0 · maxLength: 128

The case display name

cancellationDate

string | null · date-time

Cancellation date

array | null

Derived case fields

CaseSetup

Case setup

caseName

string · minLength: 1 · required

The case name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

array | null

The case value setups

CaseType

string · enum

Enum values:

Global

Company

Employee

The type of a case

CaseValidationIssue

Represents an issue from the case validation

issueType

string · enum · required

The type of a case issue

Enum values:

Unknown

CaseInvalid

CaseUnknown

CaseFieldDuplicated

CaseValueIncomplete

CaseValueStartMissing

CaseValueStartInvalid

CaseValueEndInvalid

caseName

string · minLength: 0 · maxLength: 128 · required

Gets the name of the case

message

string · minLength: 1 · required

Gets the validation message

number

integer · int32

The issue number (negative issue type)

object | null

The localized case names

caseFieldName

string | null · minLength: 0 · maxLength: 128

Gets the name of the case field

object | null

The localized case field names

sourceCaseName

string | null · minLength: 0 · maxLength: 128

The relation source case name

object | null

The localized source case names

targetCaseName

string | null · minLength: 0 · maxLength: 128

The relation target case name

object | null

The localized target case names

CaseValue

The payroll case value API object (immutable)

caseFieldName

string · minLength: 0 · maxLength: 128 · required

The associated case field name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

caseChangeId

string · uuid

The case change id (immutable)

divisionId

string | null · uuid

The division id (immutable) Mandatory for case values with local value scope Ason.Payroll.Api.Model.CaseField.ValueScope

employeeId

string | null · uuid

The employee id, mandatory for employee case changes

caseName

string | null · minLength: 0 · maxLength: 128

The associated case name

object | null

The localized case names

displayCaseName

string | null

The localized case name

object | null

The localized case field names

displayCaseFieldName

string | null

The localized case field name

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

value

string | null

The case value (JSON format)

numericValue

number | null · double

The case numeric value

cancellationDate

string | null · date-time

Cancellation date

start

string | null · date-time

The starting date for the value

end

string | null · date-time

The ending date for the value

forecast

string | null · minLength: 0 · maxLength: 128

The forecast name

tags

array | null

The case value tags

object | null

Custom attributes

CaseValueCreationMode

string · enum

Enum values:

Default

Always

OnChanges

Discard

The case value creation mode

CaseValueSetup

The payroll case value setup API object (immutable)

caseFieldName

string · minLength: 0 · maxLength: 128 · required

The associated case field name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

caseChangeId

string · uuid

The case change id (immutable)

divisionId

string | null · uuid

The division id (immutable) Mandatory for case values with local value scope Ason.Payroll.Api.Model.CaseField.ValueScope

employeeId

string | null · uuid

The employee id, mandatory for employee case changes

caseName

string | null · minLength: 0 · maxLength: 128

The associated case name

object | null

The localized case names

displayCaseName

string | null

The localized case name

object | null

The localized case field names

displayCaseFieldName

string | null

The localized case field name

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

value

string | null

The case value (JSON format)

numericValue

number | null · double

The case numeric value

cancellationDate

string | null · date-time

Cancellation date

start

string | null · date-time

The starting date for the value

end

string | null · date-time

The ending date for the value

forecast

string | null · minLength: 0 · maxLength: 128

The forecast name

tags

array | null

The case value tags

object | null

Custom attributes

array | null

Case documents

ClusterSet

Cluster set

name

string | null

The filter name

includeClusters

array | null

The included clusters

excludeClusters

array | null

The excluded clusters

CollectType

string · enum

Enum values:

Sum

Min

Max

Average

Count

The collect type

Collector

The regulation collector API object

collectType

string · enum · required

The collect type

Enum values:

Sum

Min

Max

Average

Count

name

string · minLength: 0 · maxLength: 128 · required

The collector name (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized collector names

displayName

string | null

The localized collector name

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

collectorGroups

array | null

Associated collector groups

threshold

number | null · double

The threshold value

minResult

number | null · double

The minimum allowed value

maxResult

number | null · double

The maximum allowed value

startExpression

string | null

Expression used while the collector is started

applyExpression

string | null

Expression used while applying a value to the collector

endExpression

string | null

Expression used while the collector is ended

object | null

Custom attributes

Represents a column in a DataTable

name

string | null

Gets or sets the column name

expression

string | null

Column expression used to filter rows

valueType

string | null

Gets or sets the type of data stored in the column

valueBaseType

string | null

Gets or sets the base type of data stored in the column

DataRelation

Represents a data relation in a DataTable

name

string | null

Gets or sets the relation name

parentTable

string | null

Gets or sets the relation parent table name

parentColumn

string | null

Gets or sets the relation parent column names

childTable

string | null

Gets or sets the relation child table name

childColumn

string | null

Gets or sets the relation child column names

DataRow

Represents a row of data in a DataTable

values

array | null

Gets or sets the row values (JSON, type matching to the column)

DataTable

Represents one table of in-memory data

name

string | null

Gets or sets the table name

array | null

Gets the collection of columns that belong to this table

array | null

Gets the collection of rows that belong to this table

Division

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

DivisionScope

string · enum

Enum values:

All

Local

Global

GlobalAndLocal

The division scope

Document

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

name

string | null

The document name

content

string | null · byte

The document content

contentType

string | null

The document content type

object | null

Custom attributes

DocumentType

string · enum

Enum values:

Word

Excel

Pdf

Xml

XmlRaw

Csv

The document type

Employee

The employee API object

identifier

string · minLength: 0 · maxLength: 128 · required

The employee identifier

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the employee

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the employee

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

divisions

array | null

Employee division ids

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback is the division culture

object | null

Custom attributes

EmployeeControllingRecord

id

string · uuid

array | null

EmployeeMissingDataRecord

id

string · uuid

firstName

string | null

lastName

string | null

identifier

string | null

array | null

EmployeeSet

The employee API object

identifier

string · minLength: 0 · maxLength: 128 · required

The employee identifier

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the employee

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the employee

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

divisions

array | null

Employee division ids

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback is the division culture

object | null

Custom attributes

leavingDate

string | null · date-time

The employee leaving date

isEmployed

boolean

Current employment status.

EmployeeUpdate

The update employee api object

status

string · enum

The object status

Enum values:

Active

Inactive

identifier

string | null · maxLength: 128

The employee identifier

firstName

string | null · maxLength: 128

The first name of the employee

lastName

string | null · maxLength: 128

The last name of the employee

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

divisions

array | null

Employee division ids

culture

string | null · maxLength: 128

The culture including the calendar, fallback is the division culture

object | null

Custom attributes

Entry

employeeId

string · uuid

amount

number · double

File

name

string · minLength: 1 · required

The document name

content

string · minLength: 1 · required

The document content

contentType

string · minLength: 0 · maxLength: 128 · required

The document content type

FunctionType

string · enum

Enum values:

None

CaseAvailable

CaseBuild

CaseValidate

CaseChange

Case

CollectorStart

CollectorApply

The payroll function type

Language

string · enum

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

The payroll languages

LocalizedCase

id

string · uuid

name

string | null

displayName

string | null

clusters

array | null

LocalizedControllingCase

name

string | null

displayName

string | null

Lookup

The regulation lookup API object identified by his unique name. The lookup contains one or more columns and the ValueColumn indicates the column with the resulting value. ValueType specifies the type of the resulting value.

name

string · minLength: 0 · maxLength: 128 · required

The unique lookup name (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized lookup names

description

string | null

The lookup description

object | null

The localized lookup descriptions

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

rangeSize

number | null · double

The lookup range size

LookupData

Localized lookup for UI cases like list/grid selections

name

string · minLength: 0 · maxLength: 128 · required

The lookup name

object[] · required

The lookup values

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

rangeSize

number | null · double

The lookup range size

LookupSettings

The lookup settings

lookupName

string · minLength: 1 · required

The lookup name

valueFieldName

string | null

The lookup value field name

textFieldName

string | null

The lookup text/display field name

LookupValueData

Lookup value date in a specific language

key

string | null

The lookup key

value

string | null

The lookup value as JSON

rangeValue

number | null · double

The lookup range value

ObjectStatus

string · enum

Enum values:

Active

Inactive

The object status

OverrideType

string · enum

Enum values:

Active

Inactive

Override type for derivable object

PayoutEntry

Payout entry

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

payoutType

string · enum

The payout type

Enum values:

Wage

Garnishment

employeeId

string · uuid

The employee

amount

number · double

The payout amount

iban

string | null

The IBAN of the account to transfer the amount to.

bankName

string | null

The bank name.

PayoutSet

Payout

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

valueDate

string · date-time

The value date of the payout

accountIban

string | null

The bank account to settle the payout.

array | null

The payout entries.

object

PayoutType

string · enum

Enum values:

Wage

Garnishment

The payout type

Payroll

The payroll API object

name

string · minLength: 0 · maxLength: 128 · required

The payroll name

divisionId

string · uuid · required

The division id (immutable)

accountingStartDate

string · date-time · required

The payroll accounting start date

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized payroll names

description

string | null

The payroll description

object | null

The localized payroll descriptions

calendarCalculationMode

string · enum

The calculation mode for case value

Enum values:

MonthCalendarDay

MonthAverageDay

MonthEffectiveWorkDay

MonthAverageWorkDay

WeekCalendarDay

country

integer · int32

The ISO 3166-1 country code, 0 for undefined

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

transmissionStartDate

string | null · date-time

The transmission start date

array | null

Cluster sets

object | null

Custom attributes

PayrollCaseChange

id

string · uuid

caseName

string | null

created

string · date-time

cancellationId

string | null · uuid

cancellationDate

string | null · date-time

reason

string | null

array | null

object | null

PayrollCaseField

id

string · uuid

name

string | null

displayName

string | null

description

string | null

PayrollCaseValue

id

string · uuid

caseFieldName

string | null

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

value

string | null

numericValue

number | null · double

start

string | null · date-time

end

string | null · date-time

object | null

PayrollRegulations

countryRegulation

string | null

industries

array | null

erp

array | null

accountingDocument

string | null

accountingData

string | null

PayrollSimple

The simple payroll API object Used to create payrolls

name

string · minLength: 0 · maxLength: 128 · required

The payroll name

accountingStartDate

string · date-time · required

The payroll accounting start date

culture

string · minLength: 1 · required

The culture, fallback for employee culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

PayrunPeriodEntrySet

Payrun period entry set. Contains more information about the current entry from the payroll results.

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

employeeId

string · uuid

Employee id

payrunJobId

string | null · uuid

PayrunJob id

state

string · enum

Reflects the state of the payrun period entry

Enum values:

OutOfDate

Generating

Current

Error

openWagePayoutPreviousPeriod

number · double

The open wage payout from the previous period

openGarnishmentPayoutPreviousPeriod

number · double

The open garnishment payout from the previous period

identifier

string | null

Employee identifier

lastName

string | null

Employee last name

firstName

string | null

Employee first name

leavingDate

string | null · date-time

Employee leaving date

isEmployed

boolean

Employee employment status

grossWage

number · double

Gross wage

netWage

number · double

Net wage

offsetting

number · double

Offsetting

employerCost

number · double

Total cost for the Employer

retro

number · double

Corrections from retro calculations

garnishment

number · double

Garnishment

openWagePayout

number · double

Open amount to pay out

openGarnishmentPayout

number · double

Open garnishment to pay out

openPayout

number · double

Total amount to pay out

paidOut

number · double

Paid out

paidOutGarnishment

number · double

Paid out garnishment

hasWage

boolean

Indicates whether the payroll period entry set has a wage.

array | null

The documents of the entry

relevantEventCount

integer · int32

The count of the relevant event values in the period

PayrunPeriodEntryState

string · enum

Enum values:

OutOfDate

Generating

Current

Error

Reflects the state of the payrun period entry

PayrunPeriodProcessingStatus

string · enum

Enum values:

Unknown

Complete

ReadyToGenerate

Processing

Reflects the processing status of the payrun period

PayrunPeriodSet

Payrun period with the entries

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

periodStart

string · date-time

The period start

periodEnd

string · date-time

The period end

periodStatus

string · enum

Reflects the status of the payrun period

Enum values:

Open

Closed

Submitted

Forecast

documentsGeneratedAt

string | null · date-time

Timestamp of when the documents got generated

closedAt

string | null · date-time

Timestamp of when the payrun period got closed.

array | null

The period entries

processingStatus

string · enum

Reflects the processing status of the payrun period

Enum values:

Unknown

Complete

ReadyToGenerate

Processing

PayrunPeriodStatus

string · enum

Enum values:

Open

Closed

Submitted

Forecast

Reflects the status of the payrun period

ProblemDetails

type

string | null

title

string | null

status

Query result

count

integer · int64

The query result count

array | null

The query result items

RebaseAccountingStartDateRequest

Request for rebasing the accounting start date of a payroll.

accountingStartDate

string · date-time

The new accounting start date to set. This needs to be equal or greater than the current accounting start date.

ReportAttributeMode

string · enum

Enum values:

Json

Table

The case result kind

ReportParameter

The report parameter API object

name

string · minLength: 0 · maxLength: 128 · required

The report parameter name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

displayName

string | null

The localized parameter name

object | null

The localized parameter names

description

string | null

The report parameter description

displayDescription

string | null

The localized parameter description

object | null

The localized report parameter descriptions

mandatory

boolean

The parameter mandatory state

value

string | null

The parameter value (JSON)

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

order

integer · int32

The parameter order

parameterType

string · enum

The report value types

Enum values:

Value

Now

Today

TenantId

UserId

EmployeeId

RegulationId

PayrollId

object | null

Custom attributes

ReportParameterType

string · enum

Enum values:

Value

Now

Today

TenantId

UserId

EmployeeId

RegulationId

PayrollId

The report value types

ReportRequest

The report request API object

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

payrollId

string · uuid

The payroll id

object | null

The report parameters

ReportSet

The report set API object

name

string · minLength: 0 · maxLength: 128 · required

The payroll result report name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

displayName

string | null

The display name

object | null

The localized payroll result report names

description

string | null

The payroll result report description

displayDescription

string | null

The display description

object | null

The localized payroll result report descriptions

availableOutputs

array | null

A collection of available document output types for the report

Enum values:

Word

Excel

Pdf

Xml

XmlRaw

Csv

category

string | null

The report category

attributeMode

string · enum

The case result kind

Enum values:

Json

Table

object | null

The report queries, key is the query name and value the api operation name

array | null

The report data relations, based on the queries

buildExpression

string | null

The report build expression

startExpression

string | null

The report start expression

endExpression

string | null

The report end expression

object | null

Custom attributes

clusters

array | null

The wage type clusters

regulationId

string · uuid

The regulation id

array | null

The report parameters

array | null

The report templates

ReportTemplate

The report template API object

language

string · enum · required

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

content

string · minLength: 1 · required

The report content (client owned)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

contentType

string | null · minLength: 0 · maxLength: 128

The report content type

schemas

array | null

The report schema (client owned)

resource

string | null · minLength: 0 · maxLength: 256

The report external resource

object | null

Custom attributes

Script

The regulation script API object

name

string · minLength: 0 · maxLength: 128 · required

The script name (immutable)

value

string · minLength: 1 · required

The script script

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

functionTypes

array | null

The scripting function types as bitmask

Enum values:

None

CaseAvailable

CaseBuild

CaseValidate

CaseChange

Case

CollectorStart

CollectorApply

TaskSet

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

Tenant

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

User

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

UserMembership

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

UserMembershipInvitation

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

UserRole

$type

string · enum · required

Enum values:

Owner

Admin

SelfService

PayrollManager

None

UserRoleAdmin

UserRoleNone

UserRoleOwner

UserRolePayrollManager

UserRoleSelfService

ValueScope

string · enum

Enum values:

Local

Global

The scope for a payroll value

ValueType

string · enum

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

The payroll value types for cases

WageType

The regulation wage type API object

wageTypeNumber

number · double · required

The wage type number (immutable)

name

string · minLength: 0 · maxLength: 128 · required

The wage type name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

object | null

The localized wage type names

displayName

string | null

The localized wage type name

description

string | null

The wage type description

object | null

The localized wage type descriptions

overrideType

string · enum

Override type for derivable object

Enum values:

Active

Inactive

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

calendarCalculationMode

string · enum

The calculation mode for case value

Enum values:

MonthCalendarDay

MonthAverageDay

MonthEffectiveWorkDay

MonthAverageWorkDay

WeekCalendarDay

collectors

array | null

Associated collectors

collectorGroups

array | null

Associated collector groups

valueExpression

string | null

Expression: calculates of the wage type value

resultExpression

string | null

Expression: calculates of the wage type result attributes

object | null

Custom attributes

clusters

array | null

The wage type clusters

WageTypeSettings

object | null

Webhook

The Webhook API object

payloadUrl

string · uri · minLength: 1 · required

The URL to send the event payload to

object[] · required

The events that trigger the webhook

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

hasSecret

boolean

True if the webhook is configured with a secret

secret

string | null

The secret for the webhook. This property is only used when the client sets a secret.

object | null

The metadata to include in the payload

object | null

Custom attributes

WebhookEvent

$type

string · enum · required

Enum values:

CaseChangeAdded

TaskChanged

PayrunPeriodFinalized

PayrunPeriodClosed

PayoutCreated

PayoutCancellationRequested

WebhookEventCaseChangeAdded

WebhookEventPayoutCancellationRequested

WebhookEventPayoutCreated

WebhookEventPayrunPeriodClosed

WebhookEventPayrunPeriodFinalized

WebhookEventTaskChanged

WebhookMessage

The Webhook message API object

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

eventName

string | null

The webhook event name

payloadUrl

string | null

The webhook payload URL

requestDate

string · date-time

The request date

payload

string | null

The message payload

responseDate

string | null · date-time

The response date

responseStatus

integer | null · int32

The response HTTP status code

responseMessage

string | null

The response message

WebhookPayload

Base class for all webhook payloads

$type

string · enum · required

Enum values:

CaseChangeAdded

PayoutCreated

PayrunPeriodClosed

TaskChanged

tenantId

string · uuid

The id of the tenant that the event belongs to.

correlationId

string · uuid

The correlation id of the event.

timestamp

string · date-time

Timestamp in UTC when the event was created.

object | null

The metadata of the webhook.

WebhookPayloadCaseChangeAdded

Base class for all webhook payloads

WebhookPayloadPayoutCreated

Base class for all webhook payloads

WebhookPayloadPayrunPeriodClosed

Base class for all webhook payloads

WebhookPayloadTaskChanged

Base class for all webhook payloads