Ason Payroll Integration API

Divisions

Endpointhttps://sandbox-api.asonpayroll.com

API Reference also available as Swagger UI.

Query divisions

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions

Query divisions › path Parameters

tenantId

string · uuid · required

The tenant id

Query divisions › 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 divisions › Headers

Content-Type

string · required

The request content type

Default: application/json

Query divisions › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new division

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions

Add a new division › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new division › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new division › Request Body

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Add a new division › Responses

Created

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

POST/api/tenants/{tenantId}/divisions

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/divisions \
  --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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}
'

shell

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Get a division

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Get a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

Get a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a division › Responses

Success

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Update a division

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Update a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · required

Update a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a division › Request Body

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Update a division › Responses

Success

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

PUT/api/tenants/{tenantId}/divisions/{divisionId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/divisions/:divisionId \
  --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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}
'

shell

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Delete a division

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Delete a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

Delete a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a division › Responses

200

Success

No data returned

Get a division attribute

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Get a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Get a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a division attribute › Responses

Success

string

Set a division attribute

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Set a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Set a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Set a division attribute › Request Body

string

Set a division attribute › Responses

Created

string

Delete a division attribute

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Delete a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Delete a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a division attribute › Responses

200

Success

boolean

Payrun periods Users

Ason Payroll Integration API

Divisions

Endpointhttps://sandbox-api.asonpayroll.com

API Reference also available as Swagger UI.

Query divisions

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions

Query divisions › path Parameters

tenantId

string · uuid · required

The tenant id

Query divisions › 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 divisions › Headers

Content-Type

string · required

The request content type

Default: application/json

Query divisions › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new division

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions

Add a new division › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new division › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new division › Request Body

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Add a new division › Responses

Created

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

POST/api/tenants/{tenantId}/divisions

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/divisions \
  --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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}
'

shell

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Get a division

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Get a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

Get a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a division › Responses

Success

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Update a division

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Update a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · required

Update a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a division › Request Body

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

Update a division › Responses

Success

The division API object

name

string · minLength: 0 · maxLength: 128 · required

The division name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

object | null

The localized division names

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar, fallback of employee culture

object | null

Custom attributes

PUT/api/tenants/{tenantId}/divisions/{divisionId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/divisions/:divisionId \
  --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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}
'

shell

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

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"
  },
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Delete a division

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}

Delete a division › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

Delete a division › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a division › Responses

200

Success

No data returned

Get a division attribute

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Get a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Get a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a division attribute › Responses

Success

string

Set a division attribute

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Set a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Set a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Set a division attribute › Request Body

string

Set a division attribute › Responses

Created

string

Delete a division attribute

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/divisions/{divisionId}/attributes/{attributeName}

Delete a division attribute › path Parameters

tenantId

string · uuid · required

The tenant id

divisionId

string · uuid · required

The id of the division

attributeName

string · required

The attribute name

Delete a division attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a division attribute › Responses

200

Success

boolean

Payrun periods Users