Ason Payroll Integration API v1

Company case values

Endpointhttps://sandbox-api.asonpayroll.com

Query company case values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/companycases

Query company case values › path Parameters

tenantId

string · uuid · required

The tenant id

Query company case values › query Parameters

divisionId

string · uuid

The division id

caseFieldName

string

The case field name

caseName

string

The case name

divisionScope

string · enum

The division scope

Enum values:

All

Local

Global

GlobalAndLocal

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 company case values › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

GET/api/tenants/{tenantId}/companycases

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/companycases

shell

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",
      "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": {}
      }
    }
  ]
}

json

application/json

Get a company case value

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/companycases/{caseValueId}

Get a company case value › path Parameters

tenantId

string · uuid · required

The tenant id

caseValueId

string · uuid · required

The company case value id

Get a company case value › Responses

Success

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}/companycases/{caseValueId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/companycases/:caseValueId

shell

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": {}
  }
}

json

application/json

Company case documents Employee case changes

Query company case values

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/companycases

Query company case values › path Parameters

tenantId

string · uuid · required

The tenant id

Query company case values › query Parameters

divisionId

string · uuid

The division id

caseFieldName

string

The case field name

caseName

string

The case name

divisionScope

string · enum

The division scope

Enum values:

All

Local

Global

GlobalAndLocal

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 company case values › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Get a company case value

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/companycases/{caseValueId}

Get a company case value › path Parameters

tenantId

string · uuid · required

The tenant id

caseValueId

string · uuid · required

The company case value id

Get a company case value › Responses

Success

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