Ason Payroll Integration API

Tenants

Endpointhttps://sandbox-api.asonpayroll.com

API Reference also available as Swagger UI.

Query tenants

GET

https://sandbox-api.asonpayroll.com

/api/tenants

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

Content-Type

string · required

The request content type

Default: application/json

Query tenants › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants

Add a new tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new tenant › Request Body

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Add a new tenant › Responses

Created

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

POST/api/tenants

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

json

application/json

Get a tenant

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Get a tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Get a tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a tenant › Responses

Success

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Update a tenant

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Update a tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Update a tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a tenant › Request Body

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Update a tenant › Responses

Success

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

PUT/api/tenants/{tenantId}

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

json

application/json

Delete a tenant including all tenant data

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Delete a tenant including all tenant data › path Parameters

tenantId

string · uuid · required

The tenant id

Delete a tenant including all tenant data › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a tenant including all tenant data › Responses

200

Success

No data returned

Execute a query

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/query

Execute a query › path Parameters

tenantId

string · uuid · required

The tenant id

Execute a query › Headers

Content-Type

string · required

The request content type

Default: application/json

Execute a query › Request Body

$type

string · enum · required

Enum values:

PayrunPeriodSummaryRequest

Execute a query › Responses

Success

$type

string · enum · required

Enum values:

PayrunPeriodSummaryResponse

Employees

Query tenants

GET

https://sandbox-api.asonpayroll.com

/api/tenants

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

Content-Type

string · required

The request content type

Default: application/json

Query tenants › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants

Add a new tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new tenant › Request Body

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Add a new tenant › Responses

Created

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Get a tenant

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Get a tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Get a tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a tenant › Responses

Success

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Update a tenant

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Update a tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Update a tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a tenant › Request Body

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Update a tenant › Responses

Success

The tenant API object

identifier

string · minLength: 0 · maxLength: 128 · required

The unique identifier of the tenant (immutable)

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The culture including the calendar

object | null

Custom attributes

Delete a tenant including all tenant data

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}

Delete a tenant including all tenant data › path Parameters

tenantId

string · uuid · required

The tenant id

Delete a tenant including all tenant data › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a tenant including all tenant data › Responses

200

Success

No data returned

Execute a query

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/query

Execute a query › path Parameters

tenantId

string · uuid · required

The tenant id

Execute a query › Headers

Content-Type

string · required

The request content type

Default: application/json

Execute a query › Request Body

$type

string · enum · required

Enum values:

PayrunPeriodSummaryRequest

Execute a query › Responses

Success

$type

string · enum · required

Enum values:

PayrunPeriodSummaryResponse