Ason Payroll Integration API

Payrolls

Endpointhttps://sandbox-api.asonpayroll.com

API Reference also available as Swagger UI.

Get available payroll regulations

GET

https://sandbox-api.asonpayroll.com

/api/regulations/available

Get available payroll regulations › query Parameters

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Get available payroll regulations › Headers

Content-Type

string · required

The request content type

Default: application/json

Get available payroll regulations › Responses

200

Success

object[]

name

string | null

displayName

string | null

array | null

GET/api/regulations/available

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/regulations/available \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "name": "name",
    "displayName": "displayName",
    "industries": [
      {
        "name": "name",
        "displayName": "displayName"
      }
    ],
    "erp": [
      {
        "name": "name",
        "displayName": "displayName"
      }
    ],
    "accountingDocument": [
      {
        "name": "name",
        "displayName": "displayName"
      }
    ],
    "accountingData": [
      {
        "name": "name",
        "displayName": "displayName"
      }
    ]
  }
]

application/json

Query payrolls

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls

Query payrolls › path Parameters

tenantId

string · uuid · required

The tenant id

Query payrolls › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Query payrolls › Headers

Content-Type

string · required

The request content type

Default: application/json

Query payrolls › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

GET/api/tenants/{tenantId}/payrolls

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls \
  --header 'Content-Type: application/json'

Example Responses

{
  "count": 0,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "nameLocalizations": {
        "key": "string"
      },
      "description": "description",
      "descriptionLocalizations": {
        "key": "string"
      },
      "divisionId": "00000000-0000-0000-0000-000000000000",
      "calendarCalculationMode": "MonthCalendarDay",
      "country": 0,
      "language": "English",
      "accountingStartDate": "2024-08-25T15:00:00Z",
      "transmissionStartDate": "2024-08-25T15:00:00Z",
      "clusterSets": [
        {
          "name": "name",
          "includeClusters": [
            "string"
          ],
          "excludeClusters": [
            "string"
          ]
        }
      ],
      "attributes": {
        "key": {}
      }
    }
  ]
}

application/json

Add a new payroll

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls

Add a new payroll › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new payroll › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new payroll › Request Body

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

Add a new payroll › Responses

Created

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

POST/api/tenants/{tenantId}/payrolls

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

application/json

Get a payroll

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}

Get a payroll › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get a payroll › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a payroll › Responses

Success

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId \
  --header 'Content-Type: application/json'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

application/json

Update a payroll

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}

Update a payroll › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Update a payroll › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a payroll › Request Body

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

Update a payroll › Responses

Success

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

PUT/api/tenants/{tenantId}/payrolls/{payrollId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

application/json

Add a new payroll

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/simple

Add a new payroll › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new payroll › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new payroll › Request Body

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

Add a new payroll › Responses

Created

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

POST/api/tenants/{tenantId}/payrolls/simple

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/simple \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "culture": "culture"
}
'

Example Request Body

{
  "name": "name",
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "culture": "culture"
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "calendarCalculationMode": "MonthCalendarDay",
  "country": 0,
  "language": "English",
  "accountingStartDate": "2024-08-25T15:00:00Z",
  "transmissionStartDate": "2024-08-25T15:00:00Z",
  "clusterSets": [
    {
      "name": "name",
      "includeClusters": [
        "string"
      ],
      "excludeClusters": [
        "string"
      ]
    }
  ],
  "attributes": {
    "key": {}
  }
}

application/json

Rebases the accounting start date of the payroll. This deletes all payrunperiods and reopens one with the new accounting start date. This can only be done if the payroll is not live.

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}:rebaseAccountingStartDate

Rebases the accounting start date of the payroll. This deletes all payrunperiods and reopens one with the new accounting start date. This can only be done if the payroll is not live. › path Parameters

tenantId

string · uuid · required

The id of the tenant.

payrollId

string · uuid · required

The id of the payroll.

Rebases the accounting start date of the payroll. This deletes all payrunperiods and reopens one with the new accounting start date. This can only be done if the payroll is not live. › Headers

Content-Type

string · required

The request content type

Default: application/json

Rebases the accounting start date of the payroll. This deletes all payrunperiods and reopens one with the new accounting start date. This can only be done if the payroll is not live. › Request Body

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.

Rebases the accounting start date of the payroll. This deletes all payrunperiods and reopens one with the new accounting start date. This can only be done if the payroll is not live. › Responses

Success

No data returned

POST/api/tenants/{tenantId}/payrolls/{payrollId}:rebaseAccountingStartDate

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId:rebaseAccountingStartDate \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountingStartDate": "2024-08-25T15:00:00Z"
}
'

Example Request Body

{
  "accountingStartDate": "2024-08-25T15:00:00Z"
}

Example Responses

No example specified for this content type

Get payroll regulations

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/regulations

Get payroll regulations › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll regulations › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll regulations › Responses

Success

countryRegulation

string | null

industries

array | null

erp

array | null

accountingDocument

string | null

accountingData

string | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/regulations

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/regulations \
  --header 'Content-Type: application/json'

Example Responses

{
  "countryRegulation": "countryRegulation",
  "industries": [
    "string"
  ],
  "erp": [
    "string"
  ],
  "accountingDocument": "accountingDocument",
  "accountingData": "accountingData"
}

application/json

Set payroll regulations. The country regulation can only be set once. Industry and ERP regulations can not be removed once added.

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/regulations

Set payroll regulations. The country regulation can only be set once. Industry and ERP regulations can not be removed once added. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Set payroll regulations. The country regulation can only be set once. Industry and ERP regulations can not be removed once added. › Headers

Content-Type

string · required

The request content type

Default: application/json

Set payroll regulations. The country regulation can only be set once. Industry and ERP regulations can not be removed once added. › Request Body

countryRegulation

string | null

industries

array | null

erp

array | null

accountingDocument

string | null

accountingData

string | null

Set payroll regulations. The country regulation can only be set once. Industry and ERP regulations can not be removed once added. › Responses

Success

No data returned

PUT/api/tenants/{tenantId}/payrolls/{payrollId}/regulations

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/regulations \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryRegulation": "countryRegulation",
  "industries": [
    "string"
  ],
  "erp": [
    "string"
  ],
  "accountingDocument": "accountingDocument",
  "accountingData": "accountingData"
}
'

Example Request Body

{
  "countryRegulation": "countryRegulation",
  "industries": [
    "string"
  ],
  "erp": [
    "string"
  ],
  "accountingDocument": "accountingDocument",
  "accountingData": "accountingData"
}

Example Responses

No example specified for this content type

Get active and available case sets

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets

Get active and available case sets › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get active and available case sets › query Parameters

caseType

string · enum · required

The type of a case

Enum values:

Global

Company

Employee

employeeId

string · uuid

The employee id

caseNames

string[]

clusterSetName

string

evaluationDate

string · date-time

The evaluation date

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

regulationDate

string · date-time

The regulation date

Get active and available case sets › Headers

Content-Type

string · required

The request content type

Default: application/json

Get active and available case sets › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets

curl --request GET \
  --url 'https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/sets?caseType=%3Cstring%3E' \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "displayName": "displayName",
    "nameSynonyms": [
      "string"
    ],
    "description": "description",
    "caseFields": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "displayName": "displayName",
        "description": "description"
      }
    ],
    "attributes": {
      "key": {}
    }
  }
]

application/json

Add case change

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets

Request body contains the case change

Add case change › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Add case change › query Parameters

language

string · enum

The requested language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Add case change › Headers

Content-Type

string · required

The request content type

Default: application/json

Add case change › Request Body

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.

Add case change › Responses

Created

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

POST/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/sets \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "cancellationId": "00000000-0000-0000-0000-000000000000",
  "forecast": "forecast",
  "created": "2024-08-25T15:00:00Z",
  "reason": "reason",
  "case": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseName": "caseName",
    "values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "caseChangeId": "00000000-0000-0000-0000-000000000000",
        "divisionId": "00000000-0000-0000-0000-000000000000",
        "employeeId": "00000000-0000-0000-0000-000000000000",
        "caseName": "caseName",
        "caseNameLocalizations": {
          "key": "string"
        },
        "displayCaseName": "displayCaseName",
        "caseFieldName": "caseFieldName",
        "caseFieldNameLocalizations": {
          "key": "string"
        },
        "displayCaseFieldName": "displayCaseFieldName",
        "valueType": "String",
        "value": "value",
        "numericValue": 0,
        "cancellationDate": "2024-08-25T15:00:00Z",
        "start": "2024-08-25T15:00:00Z",
        "end": "2024-08-25T15:00:00Z",
        "forecast": "forecast",
        "tags": [
          "string"
        ],
        "attributes": {
          "key": {}
        },
        "documents": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "status": "Active",
            "created": "2024-08-25T15:00:00Z",
            "updated": "2024-08-25T15:00:00Z",
            "name": "name",
            "content": "content",
            "contentType": "contentType"
          }
        ]
      }
    ]
  },
  "start": "2024-08-25T15:00:00Z",
  "end": "2024-08-25T15:00:00Z",
  "issues": [
    {
      "issueType": "Unknown",
      "number": 0,
      "caseName": "caseName",
      "caseNameLocalizations": {
        "key": "string"
      },
      "caseFieldName": "caseFieldName",
      "caseFieldNameLocalizations": {
        "key": "string"
      },
      "sourceCaseName": "sourceCaseName",
      "sourceCaseNameLocalizations": {
        "key": "string"
      },
      "targetCaseName": "targetCaseName",
      "targetCaseNameLocalizations": {
        "key": "string"
      },
      "message": "message"
    }
  ],
  "attributes": {
    "key": {}
  },
  "language": "English",
  "notify": true
}
'

Example Request Body

{
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "cancellationId": "00000000-0000-0000-0000-000000000000",
  "forecast": "forecast",
  "created": "2024-08-25T15:00:00Z",
  "reason": "reason",
  "case": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseName": "caseName",
    "values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "caseChangeId": "00000000-0000-0000-0000-000000000000",
        "divisionId": "00000000-0000-0000-0000-000000000000",
        "employeeId": "00000000-0000-0000-0000-000000000000",
        "caseName": "caseName",
        "caseNameLocalizations": {
          "key": "string"
        },
        "displayCaseName": "displayCaseName",
        "caseFieldName": "caseFieldName",
        "caseFieldNameLocalizations": {
          "key": "string"
        },
        "displayCaseFieldName": "displayCaseFieldName",
        "valueType": "String",
        "value": "value",
        "numericValue": 0,
        "cancellationDate": "2024-08-25T15:00:00Z",
        "start": "2024-08-25T15:00:00Z",
        "end": "2024-08-25T15:00:00Z",
        "forecast": "forecast",
        "tags": [
          "string"
        ],
        "attributes": {
          "key": {}
        },
        "documents": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "status": "Active",
            "created": "2024-08-25T15:00:00Z",
            "updated": "2024-08-25T15:00:00Z",
            "name": "name",
            "content": "content",
            "contentType": "contentType"
          }
        ]
      }
    ]
  },
  "start": "2024-08-25T15:00:00Z",
  "end": "2024-08-25T15:00:00Z",
  "issues": [
    {
      "issueType": "Unknown",
      "number": 0,
      "caseName": "caseName",
      "caseNameLocalizations": {
        "key": "string"
      },
      "caseFieldName": "caseFieldName",
      "caseFieldNameLocalizations": {
        "key": "string"
      },
      "sourceCaseName": "sourceCaseName",
      "sourceCaseNameLocalizations": {
        "key": "string"
      },
      "targetCaseName": "targetCaseName",
      "targetCaseNameLocalizations": {
        "key": "string"
      },
      "message": "message"
    }
  ],
  "attributes": {
    "key": {}
  },
  "language": "English",
  "notify": true
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "correlationId": "00000000-0000-0000-0000-000000000000",
  "cancellationType": "None",
  "cancellationId": "00000000-0000-0000-0000-000000000000",
  "cancellationDate": "2024-08-25T15:00:00Z",
  "reason": "reason",
  "validationCaseName": "validationCaseName",
  "forecast": "forecast",
  "values": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "caseChangeId": "00000000-0000-0000-0000-000000000000",
      "divisionId": "00000000-0000-0000-0000-000000000000",
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "caseName": "caseName",
      "caseNameLocalizations": {
        "key": "string"
      },
      "displayCaseName": "displayCaseName",
      "caseFieldName": "caseFieldName",
      "caseFieldNameLocalizations": {
        "key": "string"
      },
      "displayCaseFieldName": "displayCaseFieldName",
      "valueType": "String",
      "value": "value",
      "numericValue": 0,
      "cancellationDate": "2024-08-25T15:00:00Z",
      "start": "2024-08-25T15:00:00Z",
      "end": "2024-08-25T15:00:00Z",
      "forecast": "forecast",
      "tags": [
        "string"
      ],
      "attributes": {
        "key": {}
      }
    }
  ],
  "attributes": {
    "key": {}
  }
}

application/json

Build case with fields

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets/{caseName}

Request body contains array of case values (optional)

Build case with fields › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

caseName

string · required

The case name

Build case with fields › query Parameters

employeeId

string · uuid

The employee id

clusterSetName

string

evaluationDate

string · date-time

The evaluation date

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

regulationDate

string · date-time

The regulation date

Build case with fields › Headers

Content-Type

string · required

The request content type

Default: application/json

Build case with fields › Request Body

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.

Build case with fields › Responses

Success

The payroll case object, including case fields

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

POST/api/tenants/{tenantId}/payrolls/{payrollId}/cases/sets/{caseName}

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/sets/:caseName \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "cancellationId": "00000000-0000-0000-0000-000000000000",
  "forecast": "forecast",
  "created": "2024-08-25T15:00:00Z",
  "reason": "reason",
  "case": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseName": "caseName",
    "values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "caseChangeId": "00000000-0000-0000-0000-000000000000",
        "divisionId": "00000000-0000-0000-0000-000000000000",
        "employeeId": "00000000-0000-0000-0000-000000000000",
        "caseName": "caseName",
        "caseNameLocalizations": {
          "key": "string"
        },
        "displayCaseName": "displayCaseName",
        "caseFieldName": "caseFieldName",
        "caseFieldNameLocalizations": {
          "key": "string"
        },
        "displayCaseFieldName": "displayCaseFieldName",
        "valueType": "String",
        "value": "value",
        "numericValue": 0,
        "cancellationDate": "2024-08-25T15:00:00Z",
        "start": "2024-08-25T15:00:00Z",
        "end": "2024-08-25T15:00:00Z",
        "forecast": "forecast",
        "tags": [
          "string"
        ],
        "attributes": {
          "key": {}
        },
        "documents": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "status": "Active",
            "created": "2024-08-25T15:00:00Z",
            "updated": "2024-08-25T15:00:00Z",
            "name": "name",
            "content": "content",
            "contentType": "contentType"
          }
        ]
      }
    ]
  },
  "start": "2024-08-25T15:00:00Z",
  "end": "2024-08-25T15:00:00Z",
  "issues": [
    {
      "issueType": "Unknown",
      "number": 0,
      "caseName": "caseName",
      "caseNameLocalizations": {
        "key": "string"
      },
      "caseFieldName": "caseFieldName",
      "caseFieldNameLocalizations": {
        "key": "string"
      },
      "sourceCaseName": "sourceCaseName",
      "sourceCaseNameLocalizations": {
        "key": "string"
      },
      "targetCaseName": "targetCaseName",
      "targetCaseNameLocalizations": {
        "key": "string"
      },
      "message": "message"
    }
  ],
  "attributes": {
    "key": {}
  },
  "language": "English",
  "notify": true
}
'

Example Request Body

{
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "divisionId": "00000000-0000-0000-0000-000000000000",
  "cancellationId": "00000000-0000-0000-0000-000000000000",
  "forecast": "forecast",
  "created": "2024-08-25T15:00:00Z",
  "reason": "reason",
  "case": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseName": "caseName",
    "values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "caseChangeId": "00000000-0000-0000-0000-000000000000",
        "divisionId": "00000000-0000-0000-0000-000000000000",
        "employeeId": "00000000-0000-0000-0000-000000000000",
        "caseName": "caseName",
        "caseNameLocalizations": {
          "key": "string"
        },
        "displayCaseName": "displayCaseName",
        "caseFieldName": "caseFieldName",
        "caseFieldNameLocalizations": {
          "key": "string"
        },
        "displayCaseFieldName": "displayCaseFieldName",
        "valueType": "String",
        "value": "value",
        "numericValue": 0,
        "cancellationDate": "2024-08-25T15:00:00Z",
        "start": "2024-08-25T15:00:00Z",
        "end": "2024-08-25T15:00:00Z",
        "forecast": "forecast",
        "tags": [
          "string"
        ],
        "attributes": {
          "key": {}
        },
        "documents": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "status": "Active",
            "created": "2024-08-25T15:00:00Z",
            "updated": "2024-08-25T15:00:00Z",
            "name": "name",
            "content": "content",
            "contentType": "contentType"
          }
        ]
      }
    ]
  },
  "start": "2024-08-25T15:00:00Z",
  "end": "2024-08-25T15:00:00Z",
  "issues": [
    {
      "issueType": "Unknown",
      "number": 0,
      "caseName": "caseName",
      "caseNameLocalizations": {
        "key": "string"
      },
      "caseFieldName": "caseFieldName",
      "caseFieldNameLocalizations": {
        "key": "string"
      },
      "sourceCaseName": "sourceCaseName",
      "sourceCaseNameLocalizations": {
        "key": "string"
      },
      "targetCaseName": "targetCaseName",
      "targetCaseNameLocalizations": {
        "key": "string"
      },
      "message": "message"
    }
  ],
  "attributes": {
    "key": {}
  },
  "language": "English",
  "notify": true
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "caseType": "Global",
  "name": "name",
  "nameLocalizations": {
    "key": "string"
  },
  "nameSynonyms": [
    "string"
  ],
  "description": "description",
  "descriptionLocalizations": {
    "key": "string"
  },
  "defaultReason": "defaultReason",
  "defaultReasonLocalizations": {
    "key": "string"
  },
  "baseCase": "baseCase",
  "baseCaseFields": [
    {
      "name": "name",
      "order": 0
    }
  ],
  "overrideType": "Active",
  "cancellationType": "None",
  "periodInputMode": "Individual",
  "availableExpression": "availableExpression",
  "buildExpression": "buildExpression",
  "validateExpression": "validateExpression",
  "lookups": [
    "string"
  ],
  "availableActions": [
    "string"
  ],
  "buildActions": [
    "string"
  ],
  "validateActions": [
    "string"
  ],
  "attributes": {
    "key": {}
  },
  "clusters": [
    "string"
  ],
  "displayName": "displayName",
  "cancellationDate": "2024-08-25T15:00:00Z",
  "fields": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "nameLocalizations": {
        "key": "string"
      },
      "description": "description",
      "descriptionLocalizations": {
        "key": "string"
      },
      "valueType": "String",
      "valueScope": "Local",
      "timeType": "Timeless",
      "timeUnit": "Day",
      "overrideType": "Active",
      "cancellationMode": "TimeType",
      "valueCreationMode": "Default",
      "optional": true,
      "order": 0,
      "startDateType": "Day",
      "endDateType": "Day",
      "endMandatory": true,
      "defaultStart": "defaultStart",
      "defaultEnd": "defaultEnd",
      "defaultValue": "defaultValue",
      "tags": [
        "string"
      ],
      "valueTags": [
        "string"
      ],
      "lookupSettings": {
        "lookupName": "lookupName",
        "valueFieldName": "valueFieldName",
        "textFieldName": "textFieldName"
      },
      "clusters": [
        "string"
      ],
      "buildActions": [
        "string"
      ],
      "validateActions": [
        "string"
      ],
      "attributes": {
        "key": {}
      },
      "valueAttributes": {
        "key": {}
      },
      "displayName": "displayName",
      "value": "value",
      "start": "2024-08-25T15:00:00Z",
      "end": "2024-08-25T15:00:00Z",
      "cancellationDate": "2024-08-25T15:00:00Z"
    }
  ]
}

application/json

Query payroll case change values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/changes/values

Query payroll case change values › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Query payroll case change values › query Parameters

caseType

string · enum · required

The case type

The type of a case

Enum values:

Global

Company

Employee

divisionId

string · uuid

The division id

employeeId

string · uuid

The employeeId id, mandatory for employee case

clusterSetName

string

The cluster set name

evaluationDate

string · date-time

The evaluation date

excludeGlobal

boolean

Exclude global changes

filter

string

The OData filter expression (with support for attribute fields)

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

orderBy

string

The OData order-by expression (with support for attribute fields)

regulationDate

string · date-time

The regulation date

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

substituteLookupCodes

boolean

Substitute the lookup codes in case values with the lookup values

top

integer · int64

The number of items in the queried collection

Query payroll case change values › Headers

Content-Type

string · required

The request content type

Default: application/json

Query payroll case change values › Responses

Success

object[]

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)

GET/api/tenants/{tenantId}/payrolls/{payrollId}/changes/values

curl --request GET \
  --url 'https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/changes/values?caseType=%3Cstring%3E' \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseChangeId": "00000000-0000-0000-0000-000000000000",
    "divisionId": "00000000-0000-0000-0000-000000000000",
    "employeeId": "00000000-0000-0000-0000-000000000000",
    "caseName": "caseName",
    "caseNameLocalizations": {
      "key": "string"
    },
    "displayCaseName": "displayCaseName",
    "caseFieldName": "caseFieldName",
    "caseFieldNameLocalizations": {
      "key": "string"
    },
    "displayCaseFieldName": "displayCaseFieldName",
    "valueType": "String",
    "value": "value",
    "numericValue": 0,
    "cancellationDate": "2024-08-25T15:00:00Z",
    "start": "2024-08-25T15:00:00Z",
    "end": "2024-08-25T15:00:00Z",
    "forecast": "forecast",
    "tags": [
      "string"
    ],
    "attributes": {
      "key": {}
    },
    "caseChangeCreated": "2024-08-25T15:00:00Z",
    "userId": "00000000-0000-0000-0000-000000000000",
    "userIdentifier": "userIdentifier",
    "reason": "reason",
    "validationCaseName": "validationCaseName",
    "cancellationType": "None",
    "cancellationId": "00000000-0000-0000-0000-000000000000",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "documentCount": 0,
    "documents": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "contentType": "contentType"
      }
    ]
  }
]

application/json

Get case values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values

Get case values › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get case values › query Parameters

employeeId

string · uuid

The employee id, mandatory for employee case

caseFieldNames

string[]

The case field names (default: all)

endDate

string · date-time

The time period end date

startDate

string · date-time

The time period start date

Get case values › Headers

Content-Type

string · required

The request content type

Default: application/json

Get case values › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/values \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "caseFieldName": "caseFieldName",
    "caseFieldNameLocalizations": {
      "key": "string"
    },
    "created": "2024-08-25T15:00:00Z",
    "start": "2024-08-25T15:00:00Z",
    "end": "2024-08-25T15:00:00Z",
    "valueType": "String",
    "value": "value",
    "cancellationDate": "2024-08-25T15:00:00Z",
    "tags": [
      "string"
    ],
    "attributes": {
      "key": {}
    }
  }
]

application/json

Get payroll case values from a specific time moment

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/time

Get payroll case values from a specific time moment › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll case values from a specific time moment › query Parameters

employeeId

string · uuid

The employee id, mandatory for employee case

caseFieldNames

string[]

The case field names (default: all)

caseType

string · enum

The case type

The type of a case

Enum values:

Global

Company

Employee

evaluationDate

string · date-time

The evaluation date (default: valueDate)

includeTimeTypes

string[]

Only include the provided time types (default: all)

Enum values:

Timeless

Moment

Period

ScaledPeriod

language

string · enum

The language (default: english)

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

regulationDate

string · date-time

The regulation date (default: valueDate)

substituteLookupCodes

boolean

Substitutes the lookup codes with the localization (default: false)

Default: false

valueDate

string · date-time

The moment of the value (default: UTC now)

Get payroll case values from a specific time moment › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll case values from a specific time moment › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/time

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/values/time \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseChangeId": "00000000-0000-0000-0000-000000000000",
    "divisionId": "00000000-0000-0000-0000-000000000000",
    "employeeId": "00000000-0000-0000-0000-000000000000",
    "caseName": "caseName",
    "caseNameLocalizations": {
      "key": "string"
    },
    "displayCaseName": "displayCaseName",
    "caseFieldName": "caseFieldName",
    "caseFieldNameLocalizations": {
      "key": "string"
    },
    "displayCaseFieldName": "displayCaseFieldName",
    "valueType": "String",
    "value": "value",
    "numericValue": 0,
    "cancellationDate": "2024-08-25T15:00:00Z",
    "start": "2024-08-25T15:00:00Z",
    "end": "2024-08-25T15:00:00Z",
    "forecast": "forecast",
    "tags": [
      "string"
    ],
    "attributes": {
      "key": {}
    }
  }
]

application/json

Get payroll case values count

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/count

Get payroll case values count › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll case values count › query Parameters

employeeId

string · uuid

The employee id, mandatory for employee case

caseFieldNames

string[]

The case field names (default: all)

caseType

string · enum

The case type

The type of a case

Enum values:

Global

Company

Employee

evaluationDate

string · date-time

The evaluation date (default: valueDate)

minCount

integer · int32

Only return caseFields with the provided min count

regulationDate

string · date-time

The regulation date (default: valueDate)

Get payroll case values count › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll case values count › Responses

Success

integer · int32

GET/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/count

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/values/count \
  --header 'Content-Type: application/json'

Example Responses

{
  "key": 0
}

application/json

Get available case period values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/periods

Get available case period values › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get available case period values › query Parameters

caseFieldNames

string[] · required

The case field names

startDate

string · date-time · required

The time period start date

endDate

string · date-time · required

The time period end date

employeeId

string · uuid

The employee id, mandatory for employee case

evaluationDate

string · date-time

Creation date filter (default: UTC now)

regulationDate

string · date-time

The regulation date (default: UTC now)

Get available case period values › Headers

Content-Type

string · required

The request content type

Default: application/json

Get available case period values › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/cases/values/periods

curl --request GET \
  --url 'https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/cases/values/periods?caseFieldNames=%3Cvalue%3E&startDate=%3Cstring%3E&endDate=%3Cstring%3E' \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "caseFieldName": "caseFieldName",
    "caseFieldNameLocalizations": {
      "key": "string"
    },
    "created": "2024-08-25T15:00:00Z",
    "start": "2024-08-25T15:00:00Z",
    "end": "2024-08-25T15:00:00Z",
    "valueType": "String",
    "value": "value",
    "cancellationDate": "2024-08-25T15:00:00Z",
    "tags": [
      "string"
    ],
    "attributes": {
      "key": {}
    }
  }
]

application/json

Get payroll employees

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/employees

Get payroll employees › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll employees › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Get payroll employees › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll employees › Responses

Success

object[]

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.

GET/api/tenants/{tenantId}/payrolls/{payrollId}/employees

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/employees \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "identifier": "identifier",
    "firstName": "firstName",
    "lastName": "lastName",
    "language": "English",
    "divisions": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "culture": "culture",
    "attributes": {
      "key": {}
    },
    "leavingDate": "2024-08-25T15:00:00Z",
    "isEmployed": true
  }
]

application/json

Get payroll employee

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/employees/{employeeId}

Get payroll employee › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

employeeId

string · uuid · required

The employee id

Get payroll employee › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll employee › Responses

Success

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.

GET/api/tenants/{tenantId}/payrolls/{payrollId}/employees/{employeeId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/employees/:employeeId \
  --header 'Content-Type: application/json'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "culture": "culture",
  "attributes": {
    "key": {}
  },
  "leavingDate": "2024-08-25T15:00:00Z",
  "isEmployed": true
}

application/json

deprecated

Get the payroll wage type master. Filters the wage types based on setting them active / inactive in the case management.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster

Get the payroll wage type master. Filters the wage types based on setting them active / inactive in the case management. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get the payroll wage type master. Filters the wage types based on setting them active / inactive in the case management. › query Parameters

evaluationDate

string · date-time

The evaluation date (default: UTC now)

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

regulationDate

string · date-time

The regulation date (default: UTC now)

Get the payroll wage type master. Filters the wage types based on setting them active / inactive in the case management. › Headers

Content-Type

string · required

The request content type

Default: application/json

Get the payroll wage type master. Filters the wage types based on setting them active / inactive in the case management. › Responses

Success

object[]

The 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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/wagetypemaster \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "wageTypeNumber": 0,
    "name": "name",
    "nameLocalizations": {
      "key": "string"
    },
    "displayName": "displayName",
    "description": "description",
    "descriptionLocalizations": {
      "key": "string"
    },
    "overrideType": "Active",
    "valueType": "String",
    "calendarCalculationMode": "MonthCalendarDay",
    "collectors": [
      "string"
    ],
    "collectorGroups": [
      "string"
    ],
    "valueExpression": "valueExpression",
    "resultExpression": "resultExpression",
    "attributes": {
      "key": {}
    },
    "clusters": [
      "string"
    ]
  }
]

application/json

deprecated

Get the payroll wage type master settings.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster/settings

Get the payroll wage type master settings. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get the payroll wage type master settings. › Headers

Content-Type

string · required

The request content type

Default: application/json

Get the payroll wage type master settings. › Responses

Success

object | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster/settings

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/wagetypemaster/settings \
  --header 'Content-Type: application/json'

Example Responses

{
  "accountAssignments": {
    "key": {
      "debitAccountNumber": "debitAccountNumber",
      "creditAccountNumber": "creditAccountNumber"
    }
  },
  "payrollControlling": {
    "key": [
      "string"
    ]
  }
}

application/json

deprecated

Sets the payroll wage type master settings.

PATCH

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster/settings

Sets the payroll wage type master settings. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Sets the payroll wage type master settings. › Headers

Content-Type

string · required

The request content type

Default: application/json

Sets the payroll wage type master settings. › Request Body

object | null

Sets the payroll wage type master settings. › Responses

Success

object | null

PATCH/api/tenants/{tenantId}/payrolls/{payrollId}/wagetypemaster/settings

curl --request PATCH \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/wagetypemaster/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountAssignments": {
    "key": {
      "debitAccountNumber": "debitAccountNumber",
      "creditAccountNumber": "creditAccountNumber"
    }
  },
  "payrollControlling": {
    "key": [
      "string"
    ]
  }
}
'

Example Request Body

{
  "accountAssignments": {
    "key": {
      "debitAccountNumber": "debitAccountNumber",
      "creditAccountNumber": "creditAccountNumber"
    }
  },
  "payrollControlling": {
    "key": [
      "string"
    ]
  }
}

Example Responses

{
  "accountAssignments": {
    "key": {
      "debitAccountNumber": "debitAccountNumber",
      "creditAccountNumber": "creditAccountNumber"
    }
  },
  "payrollControlling": {
    "key": [
      "string"
    ]
  }
}

application/json

Get payroll lookups

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/lookups

Get payroll lookups › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll lookups › query Parameters

evaluationDate

string · date-time

The evaluation date (default: UTC now)

lookupNames

string[]

The lookup names filter (default is all)

overrideType

string · enum

The override type filter (default: active)

Override type for derivable object

Enum values:

Active

Inactive

regulationDate

string · date-time

The regulation date (default: UTC now)

Get payroll lookups › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll lookups › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/lookups

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/lookups \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "name": "name",
    "nameLocalizations": {
      "key": "string"
    },
    "description": "description",
    "descriptionLocalizations": {
      "key": "string"
    },
    "overrideType": "Active",
    "rangeSize": 0
  }
]

application/json

Get payroll lookup values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values

Get payroll lookup values › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll lookup values › query Parameters

evaluationDate

string · date-time

The evaluation date (default: UTC now)

language

string · enum

The content language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

lookupNames

string[]

The lookup names

regulationDate

string · date-time

The regulation date (default: UTC now)

Get payroll lookup values › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll lookup values › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/lookups/values \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "name": "name",
    "language": "English",
    "values": [
      {
        "key": "key",
        "value": "value",
        "rangeValue": 0
      }
    ],
    "rangeSize": 0
  }
]

application/json

Get payroll lookup value data

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values/data

Get payroll lookup value data › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll lookup value data › query Parameters

lookupName

string · required

The lookup name

evaluationDate

string · date-time

The evaluation date (default: UTC now)

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

lookupKey

string

The lookup key, optionally with range value

rangeValue

number · double

The lookup range value

regulationDate

string · date-time

The regulation date (default: UTC now)

Get payroll lookup value data › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll lookup value data › Responses

Success

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/lookups/values/data

curl --request GET \
  --url 'https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/lookups/values/data?lookupName=%3Cstring%3E' \
  --header 'Content-Type: application/json'

Example Responses

{
  "key": "key",
  "value": "value",
  "rangeValue": 0
}

application/json

Get payroll reports

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/reports

Get payroll reports › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll reports › query Parameters

clusterSetName

string

The cluster set name

evaluationDate

string · date-time

The evaluation date (default: UTC now)

overrideType

string · enum

The override type filter (default: active)

Override type for derivable object

Enum values:

Active

Inactive

regulationDate

string · date-time

The regulation date (default: UTC now)

reportNames

string[]

The report names filter (Default is all)

Get payroll reports › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll reports › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/reports

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/reports \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "name": "name",
    "displayName": "displayName",
    "nameLocalizations": {
      "key": "string"
    },
    "description": "description",
    "displayDescription": "displayDescription",
    "descriptionLocalizations": {
      "key": "string"
    },
    "availableOutputs": [
      "Word"
    ],
    "category": "category",
    "attributeMode": "Json",
    "queries": {
      "key": "string"
    },
    "relations": [
      {
        "name": "name",
        "parentTable": "parentTable",
        "parentColumn": "parentColumn",
        "childTable": "childTable",
        "childColumn": "childColumn"
      }
    ],
    "buildExpression": "buildExpression",
    "startExpression": "startExpression",
    "endExpression": "endExpression",
    "attributes": {
      "key": {}
    },
    "clusters": [
      "string"
    ],
    "regulationId": "00000000-0000-0000-0000-000000000000",
    "parameters": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "name": "name",
        "displayName": "displayName",
        "nameLocalizations": {
          "key": "string"
        },
        "description": "description",
        "displayDescription": "displayDescription",
        "descriptionLocalizations": {
          "key": "string"
        },
        "mandatory": true,
        "value": "value",
        "valueType": "String",
        "order": 0,
        "parameterType": "Value",
        "attributes": {
          "key": {}
        }
      }
    ],
    "templates": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "language": "English",
        "content": "content",
        "contentType": "contentType",
        "schemas": [
          "string"
        ],
        "resource": "resource",
        "attributes": {
          "key": {}
        }
      }
    ]
  }
]

application/json

Build a report set

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/reports/{reportId}/build

Build a report set › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

reportId

string · uuid · required

The id of the report

Build a report set › query Parameters

language

string · enum

The language the report definition should be returned in

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Build a report set › Headers

Content-Type

string · required

The request content type

Default: application/json

Build a report set › Request Body

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

Build a report set › Responses

Success

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

POST/api/tenants/{tenantId}/payrolls/{payrollId}/reports/{reportId}/build

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/reports/:reportId/build \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "English",
  "payrollId": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  }
}
'

Example Request Body

{
  "language": "English",
  "payrollId": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  }
}

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "description": "description",
  "displayDescription": "displayDescription",
  "descriptionLocalizations": {
    "key": "string"
  },
  "availableOutputs": [
    "Word"
  ],
  "category": "category",
  "attributeMode": "Json",
  "queries": {
    "key": "string"
  },
  "relations": [
    {
      "name": "name",
      "parentTable": "parentTable",
      "parentColumn": "parentColumn",
      "childTable": "childTable",
      "childColumn": "childColumn"
    }
  ],
  "buildExpression": "buildExpression",
  "startExpression": "startExpression",
  "endExpression": "endExpression",
  "attributes": {
    "key": {}
  },
  "clusters": [
    "string"
  ],
  "regulationId": "00000000-0000-0000-0000-000000000000",
  "parameters": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "displayName": "displayName",
      "nameLocalizations": {
        "key": "string"
      },
      "description": "description",
      "displayDescription": "displayDescription",
      "descriptionLocalizations": {
        "key": "string"
      },
      "mandatory": true,
      "value": "value",
      "valueType": "String",
      "order": 0,
      "parameterType": "Value",
      "attributes": {
        "key": {}
      }
    }
  ],
  "templates": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "language": "English",
      "content": "content",
      "contentType": "contentType",
      "schemas": [
        "string"
      ],
      "resource": "resource",
      "attributes": {
        "key": {}
      }
    }
  ]
}

Generate the output file of a report

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/reports/{reportId}/generate

Generate the output file of a report › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

reportId

string · uuid · required

The id of the report

Generate the output file of a report › query Parameters

format

string · enum

The format of the output document

The document type

Enum values:

Word

Excel

Pdf

Xml

XmlRaw

Csv

Generate the output file of a report › Headers

Content-Type

string · required

The request content type

Default: application/json

Generate the output file of a report › Request Body

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

Generate the output file of a report › Responses

Success

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

POST/api/tenants/{tenantId}/payrolls/{payrollId}/reports/{reportId}/generate

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/reports/:reportId/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "English",
  "payrollId": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  }
}
'

Example Request Body

{
  "language": "English",
  "payrollId": "00000000-0000-0000-0000-000000000000",
  "parameters": {
    "key": "string"
  }
}

Example Responses

{
  "name": "name",
  "content": "content",
  "contentType": "contentType"
}

Get missing data for company

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata

Get missing data for company › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get missing data for company › query Parameters

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Get missing data for company › Headers

Content-Type

string · required

The request content type

Default: application/json

Get missing data for company › Responses

Success

object[]

id

string · uuid

name

string | null

displayName

string | null

clusters

array | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/missingdata \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "displayName": "displayName",
    "clusters": [
      "string"
    ]
  }
]

Queries missing data grouped by employee

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata/employees

Queries missing data grouped by employee › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Queries missing data grouped by employee › query Parameters

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Queries missing data grouped by employee › Headers

Content-Type

string · required

The request content type

Default: application/json

Queries missing data grouped by employee › Responses

Success

object[]

id

string · uuid

firstName

string | null

lastName

string | null

identifier

string | null

array | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata/employees

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/missingdata/employees \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "firstName": "firstName",
    "lastName": "lastName",
    "identifier": "identifier",
    "cases": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "displayName": "displayName",
        "clusters": [
          "string"
        ]
      }
    ]
  }
]

Get missing data of an employee

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata/employees/{employeeId}

Get missing data of an employee › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

employeeId

string · uuid · required

The employee id

Get missing data of an employee › query Parameters

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Get missing data of an employee › Headers

Content-Type

string · required

The request content type

Default: application/json

Get missing data of an employee › Responses

Success

id

string · uuid

firstName

string | null

lastName

string | null

identifier

string | null

array | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/missingdata/employees/{employeeId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/missingdata/employees/:employeeId \
  --header 'Content-Type: application/json'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "identifier": "identifier",
  "cases": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "displayName": "displayName",
      "clusters": [
        "string"
      ]
    }
  ]
}

Get payroll case fields, sorted by display name

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/casefields

Get payroll case fields, sorted by display name › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Get payroll case fields, sorted by display name › query Parameters

caseFieldNames

string[]

The case field names (default: all)

caseType

string · enum

The case type (default: all)

The type of a case

Enum values:

Global

Company

Employee

clusterSetName

string

The cluster set name

evaluationDate

string · date-time

The evaluation date (default: UTC now)

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

overrideType

string · enum

The override type filter (default: active)

Override type for derivable object

Enum values:

Active

Inactive

regulationDate

string · date-time

The regulation date (default: UTC now)

valueType

string · enum

The value type of the case field

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

Get payroll case fields, sorted by display name › Headers

Content-Type

string · required

The request content type

Default: application/json

Get payroll case fields, sorted by display name › Responses

Success

object[]

id

string · uuid

name

string | null

displayName

string | null

description

string | null

GET/api/tenants/{tenantId}/payrolls/{payrollId}/casefields

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/casefields \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "displayName": "displayName",
    "description": "description"
  }
]

Query payroll case change values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/changes

Query payroll case change values › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Query payroll case change values › query Parameters

caseType

string · enum · required

The case type

The type of a case

Enum values:

Global

Company

Employee

divisionId

string · uuid

The division id

employeeId

string · uuid

The employeeId id, mandatory for employee case

clusterSetName

string

The cluster set name

evaluationDate

string · date-time

The evaluation date

excludeGlobal

boolean

Exclude global changes

filter

string

The OData filter expression (with support for attribute fields)

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

orderBy

string

The OData order-by expression (with support for attribute fields)

regulationDate

string · date-time

The regulation date

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

searchTerm

string

The term to search for. The search is performed case-insensitive on the translated caseName, caseFieldName and the value.

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

substituteLookupCodes

boolean

Substitute the lookup codes in case values with the lookup values

top

integer · int64

The number of items in the queried collection

Query payroll case change values › Headers

Content-Type

string · required

The request content type

Default: application/json

Query payroll case change values › Responses

Success

object[]

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

GET/api/tenants/{tenantId}/payrolls/{payrollId}/changes

curl --request GET \
  --url 'https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/changes?caseType=%3Cstring%3E' \
  --header 'Content-Type: application/json'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "caseName": "caseName",
    "created": "2024-08-25T15:00:00Z",
    "cancellationId": "00000000-0000-0000-0000-000000000000",
    "cancellationDate": "2024-08-25T15:00:00Z",
    "reason": "reason",
    "values": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "caseFieldName": "caseFieldName",
        "valueType": "String",
        "value": "value",
        "numericValue": 0,
        "start": "2024-08-25T15:00:00Z",
        "end": "2024-08-25T15:00:00Z",
        "attributes": {
          "key": {}
        }
      }
    ],
    "attributes": {
      "key": {}
    }
  }
]

Employees WageTypes