Ason Payroll Integration API

Tasks

Endpointhttps://sandbox-api.asonpayroll.com

API Reference also available as Swagger UI.

Query tasks

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks

Query tasks › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

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

Content-Type

string · required

The request content type

Default: application/json

Query tasks › Responses

Success

Query result

count

integer · int64

The query result count

array | null

The query result items

GET/api/tenants/{tenantId}/payrolls/{payrollId}/tasks

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/tasks \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "count": 0,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "displayName": "displayName",
      "nameLocalizations": {
        "key": "string"
      },
      "category": "category",
      "displayCategory": "displayCategory",
      "categoryLocalizations": {
        "key": "string"
      },
      "instruction": "instruction",
      "displayInstruction": "displayInstruction",
      "instructionLocalizations": {
        "key": "string"
      },
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "assignedUserId": "00000000-0000-0000-0000-000000000000",
      "scheduled": "2024-08-25T15:00:00Z",
      "completedUserId": "00000000-0000-0000-0000-000000000000",
      "completed": "2024-08-25T15:00:00Z",
      "comment": "comment",
      "hasAction": true,
      "attributes": {
        "key": {}
      },
      "tenantId": "00000000-0000-0000-0000-000000000000",
      "employee": {
        "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": {}
        }
      },
      "assignedUser": {
        "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": {}
        }
      },
      "attachments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "status": "Active",
          "created": "2024-08-25T15:00:00Z",
          "updated": "2024-08-25T15:00:00Z",
          "name": "name",
          "content": "U3dhZ2dlcg==",
          "contentType": "contentType",
          "attributes": {
            "key": {}
          }
        }
      ]
    }
  ]
}

json

application/json

Add a new task

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks

Add a new task › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Add a new task › Headers

Content-Type

string · required

The request content type

Default: application/json

Add a new task › Request Body

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

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)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

hasAction

boolean

Whether the task has an action

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

array | null

The task attachments

Add a new task › Responses

Created

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

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)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

hasAction

boolean

Whether the task has an action

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

array | null

The task attachments

POST/api/tenants/{tenantId}/payrolls/{payrollId}/tasks

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/tasks \
  --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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "attributes": {
        "key": {}
      }
    }
  ]
}

json

application/json

Get a task

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}

Get a task › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

Get a task › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a task › Responses

Success

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

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)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

hasAction

boolean

Whether the task has an action

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

array | null

The task attachments

GET/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/tasks/:taskId \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "name",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "attributes": {
        "key": {}
      }
    }
  ]
}

json

application/json

Update a task

PUT

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}

Update a task › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · required

Update a task › Headers

Content-Type

string · required

The request content type

Default: application/json

Update a task › Request Body

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

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)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

hasAction

boolean

Whether the task has an action

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

array | null

The task attachments

Update a task › Responses

Success

The task API object

name

string · minLength: 0 · maxLength: 128 · required

The task name (immutable)

instruction

string · minLength: 1 · required

The task instruction

scheduled

string · date-time · required

The task schedule date

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)

displayName

string | null

The localized task name (immutable)

object | null

The localized task names (immutable)

category

string | null · minLength: 0 · maxLength: 128

The task category

displayCategory

string | null

The localized task category

object | null

The localized task categories (immutable)

displayInstruction

string | null

The localized task instruction

object | null

The localized task instructions(immutable)

employeeId

string | null · uuid

The employee id

assignedUserId

string | null · uuid

The assigned user id

completedUserId

string | null · uuid

The completed user id

completed

string | null · date-time

The task completed date

comment

string | null

The task comment

hasAction

boolean

Whether the task has an action

object | null

Custom attributes

tenantId

string · uuid

The tenant id (immutable)

object

The employee API object

object

The payroll user API object

array | null

The task attachments

PUT/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}

curl --request PUT \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/tasks/:taskId \
  --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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "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",
  "displayName": "displayName",
  "nameLocalizations": {
    "key": "string"
  },
  "category": "category",
  "displayCategory": "displayCategory",
  "categoryLocalizations": {
    "key": "string"
  },
  "instruction": "instruction",
  "displayInstruction": "displayInstruction",
  "instructionLocalizations": {
    "key": "string"
  },
  "employeeId": "00000000-0000-0000-0000-000000000000",
  "assignedUserId": "00000000-0000-0000-0000-000000000000",
  "scheduled": "2024-08-25T15:00:00Z",
  "completedUserId": "00000000-0000-0000-0000-000000000000",
  "completed": "2024-08-25T15:00:00Z",
  "comment": "comment",
  "hasAction": true,
  "attributes": {
    "key": {}
  },
  "tenantId": "00000000-0000-0000-0000-000000000000",
  "employee": {
    "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": {}
    }
  },
  "assignedUser": {
    "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": {}
    }
  },
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "name": "name",
      "content": "U3dhZ2dlcg==",
      "contentType": "contentType",
      "attributes": {
        "key": {}
      }
    }
  ]
}

json

application/json

Delete a task

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}

Delete a task › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

Delete a task › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a task › Responses

200

Success

No data returned

Runs the task action.

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}:runAction

Runs the task action. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

Runs the task action. › Headers

Content-Type

string · required

The request content type

Default: application/json

Runs the task action. › Responses

200

Success

No data returned

Gets the attachment of the task

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}/attachments/{attachmentId}

Gets the attachment of the task › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The task id

attachmentId

string · uuid · required

The attachment id

Gets the attachment of the task › query Parameters

report

string

The report to generate based on the document (default: null)

variant

string

The variant of the report (if applicable) (default: null)

Gets the attachment of the task › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the attachment of the task › Responses

200

Success

No data returned

Get a task attribute

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}/attributes/{attributeName}

Get a task attribute › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

attributeName

string · required

The attribute name

Get a task attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a task attribute › Responses

Success

string

Set a task attribute

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}/attributes/{attributeName}

Set a task attribute › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

attributeName

string · required

The attribute name

Set a task attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Set a task attribute › Request Body

string

Set a task attribute › Responses

Created

string

Delete a task attribute

DELETE

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/tasks/{taskId}/attributes/{attributeName}

Delete a task attribute › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

taskId

string · uuid · required

The id of the task

attributeName

string · required

The attribute name

Delete a task attribute › Headers

Content-Type

string · required

The request content type

Default: application/json

Delete a task attribute › Responses

200

Success

boolean

WageTypes Payrun periods