Ason Payroll Integration API

User Memberships

Endpointhttps://sandbox-api.asonpayroll.com

Endpoints for integrating Ason into your platform. API Reference also available as Swagger UI.

Query user memberships of the tenant.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships

Query user memberships of the tenant. › path Parameters

tenantId

string · uuid · required

The tenant id

Query user memberships of the tenant. › 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 user memberships of the tenant. › Headers

Content-Type

string · required

The request content type

Default: application/json

Query user memberships of the tenant. › Responses

The user memberships matching the query, their count, or both, depending on result.

Query result

count

integer · int64

The query result count

array | null

The query result items

Create a new user membership for the tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships

Create a new user membership for the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Create a new user membership for the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Create a new user membership for the tenant › Request Body

Creates a user membership

userId

string · uuid

The user id

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id, mandatory for the self-service role

Create a new user membership for the tenant › Responses

The created user membership.

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

POST/api/tenants/{tenantId}/user_memberships

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

application/json

Query user memberships invitations of the tenant.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invitations

Query user memberships invitations of the tenant. › path Parameters

tenantId

string · uuid · required

The tenant id

Query user memberships invitations of the tenant. › Headers

Content-Type

string · required

The request content type

Default: application/json

Query user memberships invitations of the tenant. › Responses

The invitations of the tenant.

object[]

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

Invites a user to the tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invite

Invites a user to the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Invites a user to the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Invites a user to the tenant › Request Body

Create an invitation for a user to join a tenant

email

string | null

The email address the invitation is sent to

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id, mandatory for the self-service role

Invites a user to the tenant › Responses

The created invitation.

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

POST/api/tenants/{tenantId}/user_memberships/invite

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "tenantIdentifier": "tenantIdentifier",
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "expiresAt": "2024-08-25T15:00:00Z"
}

json

application/json

Withdraws a invitation to the tenant

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invitations/{invitationId}

Withdraws a invitation to the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

invitationId

string · uuid · required

The invitation id

Withdraws a invitation to the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Withdraws a invitation to the tenant › Responses

The invitation was withdrawn.

No data returned

Update the user membership

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/{userMembershipId}

Update the user membership › path Parameters

tenantId

string · uuid · required

The tenant id

userMembershipId

string · uuid · required

The user membership id

Update the user membership › Headers

Content-Type

string · required

The request content type

Default: application/json

Update the user membership › Request Body

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

Update the user membership › Responses

The updated user membership.

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

PUT/api/tenants/{tenantId}/user_memberships/{userMembershipId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships/:userMembershipId \
  --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",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

application/json

Removes a user membership from the tenant

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/{userMembershipId}

Removes a user membership from the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

userMembershipId

string · uuid · required

The id of the user membership

Removes a user membership from the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Removes a user membership from the tenant › Responses

The user membership was removed.

No data returned

Get a user membership invitation sent to the current user

GET

https://sandbox-api.asonpayroll.com

/api/user_membership_invitations/{invitationId}

Get a user membership invitation sent to the current user › path Parameters

invitationId

string · uuid · required

The invitation id

Get a user membership invitation sent to the current user › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a user membership invitation sent to the current user › Responses

The invitation, including the tenant identifier.

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

Accept a user membership invitation sent to the current user

POST

https://sandbox-api.asonpayroll.com

/api/user_membership_invitations/{invitationId}

Accept a user membership invitation sent to the current user › path Parameters

invitationId

string · uuid · required

The invitation id

Accept a user membership invitation sent to the current user › Headers

Content-Type

string · required

The request content type

Default: application/json

Accept a user membership invitation sent to the current user › Responses

The invitation was accepted, and you are now a member of the tenant.

No data returned

Users Webhooks

Ason Payroll Integration API

User Memberships

Endpointhttps://sandbox-api.asonpayroll.com

Endpoints for integrating Ason into your platform. API Reference also available as Swagger UI.

Query user memberships of the tenant.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships

Query user memberships of the tenant. › path Parameters

tenantId

string · uuid · required

The tenant id

Query user memberships of the tenant. › 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 user memberships of the tenant. › Headers

Content-Type

string · required

The request content type

Default: application/json

Query user memberships of the tenant. › Responses

The user memberships matching the query, their count, or both, depending on result.

Query result

count

integer · int64

The query result count

array | null

The query result items

Create a new user membership for the tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships

Create a new user membership for the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Create a new user membership for the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Create a new user membership for the tenant › Request Body

Creates a user membership

userId

string · uuid

The user id

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id, mandatory for the self-service role

Create a new user membership for the tenant › Responses

The created user membership.

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

POST/api/tenants/{tenantId}/user_memberships

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

application/json

Query user memberships invitations of the tenant.

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invitations

Query user memberships invitations of the tenant. › path Parameters

tenantId

string · uuid · required

The tenant id

Query user memberships invitations of the tenant. › Headers

Content-Type

string · required

The request content type

Default: application/json

Query user memberships invitations of the tenant. › Responses

The invitations of the tenant.

object[]

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

Invites a user to the tenant

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invite

Invites a user to the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

Invites a user to the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Invites a user to the tenant › Request Body

Create an invitation for a user to join a tenant

email

string | null

The email address the invitation is sent to

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id, mandatory for the self-service role

Invites a user to the tenant › Responses

The created invitation.

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

POST/api/tenants/{tenantId}/user_memberships/invite

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "tenantIdentifier": "tenantIdentifier",
  "email": "email",
  "role": {
    "$type": "Owner"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "expiresAt": "2024-08-25T15:00:00Z"
}

json

application/json

Withdraws a invitation to the tenant

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/invitations/{invitationId}

Withdraws a invitation to the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

invitationId

string · uuid · required

The invitation id

Withdraws a invitation to the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Withdraws a invitation to the tenant › Responses

The invitation was withdrawn.

No data returned

Update the user membership

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/{userMembershipId}

Update the user membership › path Parameters

tenantId

string · uuid · required

The tenant id

userMembershipId

string · uuid · required

The user membership id

Update the user membership › Headers

Content-Type

string · required

The request content type

Default: application/json

Update the user membership › Request Body

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

Update the user membership › Responses

The updated user membership.

The membership of a user in a tenant

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)

tenantId

string · uuid

The tenant id

userId

string · uuid

The user id

employeeId

string | null · uuid

The employee id

firstName

string | null

The first name of the user.

lastName

string | null

The last name of the user.

object

The role of a user in a tenant

PUT/api/tenants/{tenantId}/user_memberships/{userMembershipId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/user_memberships/:userMembershipId \
  --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",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "role": {
    "$type": "Owner"
  }
}

json

application/json

Removes a user membership from the tenant

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/user_memberships/{userMembershipId}

Removes a user membership from the tenant › path Parameters

tenantId

string · uuid · required

The tenant id

userMembershipId

string · uuid · required

The id of the user membership

Removes a user membership from the tenant › Headers

Content-Type

string · required

The request content type

Default: application/json

Removes a user membership from the tenant › Responses

The user membership was removed.

No data returned

Get a user membership invitation sent to the current user

GET

https://sandbox-api.asonpayroll.com

/api/user_membership_invitations/{invitationId}

Get a user membership invitation sent to the current user › path Parameters

invitationId

string · uuid · required

The invitation id

Get a user membership invitation sent to the current user › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a user membership invitation sent to the current user › Responses

The invitation, including the tenant identifier.

An invitation to become a member of a tenant

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)

tenantId

string · uuid

The tenant id

tenantIdentifier

string | null

The tenant identifier

email

string | null

The email

object

The role of a user in a tenant

employeeId

string | null · uuid

The employee id for the user membership.

expiresAt

string · date-time

The expiration date and time for the user membership invitation.

Accept a user membership invitation sent to the current user

POST

https://sandbox-api.asonpayroll.com

/api/user_membership_invitations/{invitationId}

Accept a user membership invitation sent to the current user › path Parameters

invitationId

string · uuid · required

The invitation id

Accept a user membership invitation sent to the current user › Headers

Content-Type

string · required

The request content type

Default: application/json

Accept a user membership invitation sent to the current user › Responses

The invitation was accepted, and you are now a member of the tenant.

No data returned

Users Webhooks