Action

Description

Required scopes

List Of Employees

Get a list of active employee profiles

Get Employee By ID

Get details of an employee's profile

Get Employee Field Definition

Get a list of fields available when creating or updating an employee account

Create Employee

Create a new employee account based on provided parameters

Update Employee

Update an existing employee's information

Deactivate Employee

Deactivate an employee account

Reactivate Employee

Reactivate a previously deactivated employee account

List Supervisors

Retrieve a list of employees marked as supervisors

Invite Employee

Invite an employee by sending an invitation email

Change Employee Username

Update an employee's username

List Deactivated Employees

Get a paginated list of deactivated employees

List Absence Accounts

Returns all accounts filtered by account id, employee id, account type and status

List Absence Adjustments

Returns adjustments of a specific accrued absence account

Create Absence Adjustment

Create an adjustment to change a balance of an accrued absence account

List Absence Types

Get available absence types

List Account Types

Get all available account types filtered by id, absence type and deleted state

Get Accrued Account Type

Get account types with absence type - Accrued

Delete Account Type

Remove account type

Update Accrued Account Type

Update account type definition of absence type Accrued

Create Accrued Account Type

Create new account type definition of absence type Accrued

Get Absence Records

Returns absence records matching given criteria

Decline Absence Record

Decline a specific absence record

Submit Absence Request

Submit an absence request on behalf of an employee

List Absence Requests

Get all absence requests, filter by employee and/or absence request status

Approve Absence Request

Approve a specific absence request

Deny Absence Request

Deny an absence request

Get Account Balance

Gets account balance for a specific account

Get Absence Request Draft

Get an absence request draft that can be sent later to submit an absence request

List Account Transactions

Returns all transactions for a given account in a given date

Create Transaction

Create a new transaction for a TOIL account to adjust its balance

List Departments

Get a list of departments

Get Department By ID

Get details of a department

Create Department

Create a new department

Update Department

Update details of a department

Delete Department

Delete a department

List Employee Groups

Get a list of employee groups

Get Employee Group By ID

Get details of an employee group

Create Employee Group

Create a new employee group

Update Employee Group

Update details of an employee group

Delete Employee Group

Delete an employee group

List Employee Types

Get a list of available employee types

List Skills

Get a list of skills on the portal

Create Skill

Create a new skill on the portal

Update Skill

Update the name, description and time limited status of a skill

Delete Skill

Delete a skill by providing the skill id

List Available Shifts

Returns paginated list of available shifts matching given criteria

Get Shift By ID

Returns shift by shift id

Create Shift

Create a shift

Update Shift

Update a shift

Delete Shift

Delete an existing shift

Approve Shift

Approve a shift that is ready for payroll processing

Assign Shift To Employee

Assign a shift to a specific employee or set it to Open

List Shift Types

Returns paginated list of available shift types

Create Shift Type

Create a new shift type

Update Shift Type

Update an existing shift type

List Available Positions

Returns paginated list of available positions

Create Position

Create a position

Get Position By ID

Returns position by provided id

Update Position

Update a position

Delete Position

Delete position by provided id

Get Employee Pay Rates In Employee Group

Return pay rates for an employee in a specified employee group

Update Employee Group Pay Rates

Update employees pay rates in a given employee group

Get Employee Pay Rates For All Groups

Return pay rates of a given employee for all assigned employee groups

Get Employee Salary Allocation

Return salary allocation for a given employee id

Get Employee Period Salary

Return a Period Salary with a given employee id

Create Or Update Employee Period Salary

Create or update a Period Salary with a given employee id

List Salary Types

Return available salary types

Get Payroll Data

Returns the payroll data matching given criteria including departments, time period, and shift status

Get Revenue Records

Get all revenue records matching the request criteria

Create Or Update Revenue

Create a new revenue record for a revenue unit on a given day or update an existing one

Delete Revenue

Delete revenue for a given date and revenue unit

List Employee Shifts For Today

Returns a list of all of today's Employee Shifts

List Punch Clock Records

Returns a list of all available Punch Clock records as specified in your parameters