Ason Payroll Integration API v1

Employees

Endpointhttps://sandbox-api.asonpayroll.com

Query employees

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/employees

Query employees › path Parameters

tenantId

string · uuid · required

The tenant id

Query employees › query Parameters

divisionId

string · uuid

The division id

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 employees › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new employee

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/employees

Add a new employee › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new employee › Request Body

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

Add a new employee › Responses

Created

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

POST/api/tenants/{tenantId}/employees

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/employees \
  --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",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Get a employee

GET

https://sandbox-api.asonpayroll.com

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

Get a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The id of the employee

Get a 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

Update a employee

PUT

https://sandbox-api.asonpayroll.com

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

Update a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The employee id

Update a employee › Request Body

The update employee api object

status

string · enum

The object status

Enum values:

Active

Inactive

identifier

string | null · maxLength: 128

The employee identifier

firstName

string | null · maxLength: 128

The first name of the employee

lastName

string | null · maxLength: 128

The last name of the employee

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 · maxLength: 128

The culture including the calendar, fallback is the division culture

object | null

Custom attributes

Update a 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

PUT/api/tenants/{tenantId}/employees/{employeeId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/employees/:employeeId \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "Active",
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}
'

shell

Example Request Body

{
  "status": "Active",
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "English",
  "divisions": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "culture": "culture",
  "attributes": {
    "key": {}
  }
}

json

application/json

Delete a employee

DELETE

https://sandbox-api.asonpayroll.com

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

Delete a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The id of the employee

Delete a employee › Responses

200

Success

No data returned

Tenants (Organizations)Payrolls (Organization Units)

Query employees

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/employees

Query employees › path Parameters

tenantId

string · uuid · required

The tenant id

Query employees › query Parameters

divisionId

string · uuid

The division id

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 employees › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

Add a new employee

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/employees

Add a new employee › path Parameters

tenantId

string · uuid · required

The tenant id

Add a new employee › Request Body

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

Add a new employee › Responses

Created

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

Get a employee

GET

https://sandbox-api.asonpayroll.com

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

Get a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The id of the employee

Get a 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

Update a employee

PUT

https://sandbox-api.asonpayroll.com

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

Update a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The employee id

Update a employee › Request Body

The update employee api object

status

string · enum

The object status

Enum values:

Active

Inactive

identifier

string | null · maxLength: 128

The employee identifier

firstName

string | null · maxLength: 128

The first name of the employee

lastName

string | null · maxLength: 128

The last name of the employee

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 · maxLength: 128

The culture including the calendar, fallback is the division culture

object | null

Custom attributes

Update a 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

Delete a employee

DELETE

https://sandbox-api.asonpayroll.com

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

Delete a employee › path Parameters

tenantId

string · uuid · required

The tenant id

employeeId

string · uuid · required

The id of the employee

Delete a employee › Responses

200

Success

No data returned