Ason Payroll Integration API v1

Users

Endpointhttps://sandbox-api.asonpayroll.com

Query users

GET

https://sandbox-api.asonpayroll.com

/api/users

Query users › 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 users › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new user

POST

https://sandbox-api.asonpayroll.com

/api/users

Add a new user › Request Body

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Add a new user › Responses

Created

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

POST/api/users

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/users \
  --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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "attributes": {
    "key": {}
  }
}

json

application/json

Get a user

GET

https://sandbox-api.asonpayroll.com

/api/users/{userId}

Get a user › path Parameters

userId

string · uuid · required

The id of the user

Get a user › Responses

Success

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Update a user

PUT

https://sandbox-api.asonpayroll.com

/api/users/{userId}

Update a user › path Parameters

userId

string · uuid · required

The user id

Update a user › Request Body

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Update a user › Responses

Success

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

PUT/api/users/{userId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/users/:userId \
  --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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "language": "English",
  "externalId": "externalId",
  "attributes": {
    "key": {}
  }
}

json

application/json

Delete a user

DELETE

https://sandbox-api.asonpayroll.com

/api/users/{userId}

Delete a user › path Parameters

userId

string · uuid · required

The id of the user

Delete a user › Responses

200

Success

No data returned

Webhooks User Memberships

Query users

GET

https://sandbox-api.asonpayroll.com

/api/users

Query users › 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 users › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new user

POST

https://sandbox-api.asonpayroll.com

/api/users

Add a new user › Request Body

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Add a new user › Responses

Created

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Get a user

GET

https://sandbox-api.asonpayroll.com

/api/users/{userId}

Get a user › path Parameters

userId

string · uuid · required

The id of the user

Get a user › Responses

Success

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Update a user

PUT

https://sandbox-api.asonpayroll.com

/api/users/{userId}

Update a user › path Parameters

userId

string · uuid · required

The user id

Update a user › Request Body

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes

Update a user › Responses

Success

The payroll user API object

identifier

string · minLength: 0 · maxLength: 254 · required

The email of the user

firstName

string · minLength: 0 · maxLength: 128 · required

The first name of the user

lastName

string · minLength: 0 · maxLength: 128 · required

The last name of the user

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

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

culture

string | null · minLength: 0 · maxLength: 128

The users culture

language

string · enum

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

externalId

string | null

The external identifier of a IdP associated with the user

object | null

Custom attributes