Query tasks
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
query Parameters
filterThe OData filter expression (with support for attribute fields)
orderByThe OData order-by expression (with support for attribute fields)
resultThe query result type: items, count or items with count (default: result items)
The query result type
selectThe OData field selection expression
skipThe number of items in the queried collection that are to be skipped
statusThe object status (default: all status)
The object status
topThe number of items in the queried collection
Query tasks › Responses
Success
countThe query result count
The query result items
Add a new task
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
Add a new task › Request Body
nameThe task name (immutable)
instructionThe task instruction
scheduledThe task schedule date
idThe unique object id (immutable)
statusThe object status
createdThe date which the API object was created (immutable)
updatedThe date which the API object was last updated (immutable)
displayNameThe localized task name (immutable)
The localized task names (immutable)
categoryThe task category
displayCategoryThe localized task category
The localized task categories (immutable)
displayInstructionThe localized task instruction
The localized task instructions(immutable)
employeeIdThe employee id
assignedUserIdThe assigned user id
completedUserIdThe completed user id
completedThe task completed date
commentThe task comment
Custom attributes
tenantIdThe tenant id (immutable)
The employee API object
The payroll user API object
Add a new task › Responses
Created
nameThe task name (immutable)
instructionThe task instruction
scheduledThe task schedule date
idThe unique object id (immutable)
statusThe object status
createdThe date which the API object was created (immutable)
updatedThe date which the API object was last updated (immutable)
displayNameThe localized task name (immutable)
The localized task names (immutable)
categoryThe task category
displayCategoryThe localized task category
The localized task categories (immutable)
displayInstructionThe localized task instruction
The localized task instructions(immutable)
employeeIdThe employee id
assignedUserIdThe assigned user id
completedUserIdThe completed user id
completedThe task completed date
commentThe task comment
Custom attributes
tenantIdThe tenant id (immutable)
The employee API object
The payroll user API object
Get a task
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
taskIdThe id of the task
Get a task › Responses
Success
nameThe task name (immutable)
instructionThe task instruction
scheduledThe task schedule date
idThe unique object id (immutable)
statusThe object status
createdThe date which the API object was created (immutable)
updatedThe date which the API object was last updated (immutable)
displayNameThe localized task name (immutable)
The localized task names (immutable)
categoryThe task category
displayCategoryThe localized task category
The localized task categories (immutable)
displayInstructionThe localized task instruction
The localized task instructions(immutable)
employeeIdThe employee id
assignedUserIdThe assigned user id
completedUserIdThe completed user id
completedThe task completed date
commentThe task comment
Custom attributes
tenantIdThe tenant id (immutable)
The employee API object
The payroll user API object
Update a task
path Parameters
tenantIdThe tenant id
payrollIdThe payroll id
taskIdUpdate a task › Request Body
nameThe task name (immutable)
instructionThe task instruction
scheduledThe task schedule date
idThe unique object id (immutable)
statusThe object status
createdThe date which the API object was created (immutable)
updatedThe date which the API object was last updated (immutable)
displayNameThe localized task name (immutable)
The localized task names (immutable)
categoryThe task category
displayCategoryThe localized task category
The localized task categories (immutable)
displayInstructionThe localized task instruction
The localized task instructions(immutable)
employeeIdThe employee id
assignedUserIdThe assigned user id
completedUserIdThe completed user id
completedThe task completed date
commentThe task comment
Custom attributes
tenantIdThe tenant id (immutable)
The employee API object
The payroll user API object
Update a task › Responses
Success
nameThe task name (immutable)
instructionThe task instruction
scheduledThe task schedule date
idThe unique object id (immutable)
statusThe object status
createdThe date which the API object was created (immutable)
updatedThe date which the API object was last updated (immutable)
displayNameThe localized task name (immutable)
The localized task names (immutable)
categoryThe task category
displayCategoryThe localized task category
The localized task categories (immutable)
displayInstructionThe localized task instruction
The localized task instructions(immutable)
employeeIdThe employee id
assignedUserIdThe assigned user id
completedUserIdThe completed user id
completedThe task completed date
commentThe task comment
Custom attributes
tenantIdThe tenant id (immutable)
The employee API object
The payroll user API object
