Sage HR

_object

Employees

Teams

The date when the employee started their employment

The position or job title of the employee

Additional comments regarding the termination

The reason for the employee's termination

The date when the employee's termination is effective

Terminated Employees

Termination Reasons

List active employees in company

Create new employee

Update Employee

Single active employee in company

Employee custom fields

Update custom field

Terminate employee

List terminated employees in company

Single terminated employee in company

List time off policies

Details about a time off policy

Update KIT days configuration of a time off policy

View all the KIT days of an employee in a policy

Create a KIT day in a leave

Approve, decline or cancel a KIT day

Report with individual allowances

Employee time off balances

List time off requests

Create new time off request

List employees out of office today

List document categories

Document will only be visible to employee themselves

Create new document

List positions in company

List teams in company

Overview of quarterly goal progress

Quarterly company goals

Quarterly team goals

Quarterly individual goals

Employee compensations

Posible recruitment position statuses: `draft`, `published`, `internal`, `completed`, `cancelled`


List recruitment positions

Position details

List applicants

Tracking applicant's source:
 * if left blank, source will be automatically set to `api`
 * set source to a special keyword (`company_marketing`, `recruiters`, `referral`, `sourced`) to have it mapped to corresponding values 
 * set source to a desired reference to create a custom source, e.g. `source=linkedin` will create a custom source called linkedin if it does not exist already
 * passing a referral object as a parameter will set the source to `referral`
 
Example of creating an applicant with a refferal object:
```
curl -X POST -H 'X-AUTH-TOKEN:***' -H 'Content-Type:application/json' \
  "https://***/api/recruitment/positions/2/applicants" \
  -d '{"applicant": \
          {"referral": {"email": "recruitment@example.com", "full_name": "Alice L"}, \
           "address": "BD23 8UL", "summary":"An applicant", \
           "first_name": "Applicant Name"}}'
```


Create new applicant

Applicant details

List applicant's process throught the recruitment pipeline. Newest, first.


Applicant actions

Employees will be only clocked in & out if API time clocking is enabled for Timesheet group

Clock in & out employees on specific days

List termination reasons in company

List onboarding task categories

Create new onboarding task

List offboarding task categories

Create new offboarding task

Job position transfer from Sage HR to Vikarina

Organizational structure transfer from Sage HR to Vikarina

New starters list from Sage HR to Vikarina

Contract (custom field) information transfer from Sage HR to Vikarina

New appointment (position changes) information transfer from Sage HR to Vikarina

Salary information transfer from Sage HR to Vikarina to Vikarina

Bank account information transfer (Custom field) from Sage HR to Vikarina

Termination information transfer from Sage HR to Vikarina

Unused vacation days transfer from Sage HR to Vikarina

Leaves information transfer from Sage HR to Vikarina

Time Schedule information transfer from Sage HR to Vikarina

Sending bonuses [payed once] to Vikarina

Quickbooks

Gusto

Rippling HR

BambooHR

ADP Workforce Now

Workable

Deel

Google Workspace

HiBob

Lightspeed R-Series

# Delete Employee

This scenario allows your application to delete a Employee from any external application. 
You will pass ID of the Employee you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Employee API call**:
   - Call Integration.app REST API or SDK with ID of the Employee you want to delete and Integration.app will send the correct request to the external app.


Delete Employee

Deletes Employee in any external application

Personio

Workday

Isolved

Everee

# Continuous Import of Employees to Your App

This scenario enables your application to continuously sync Employees from any external application to your app's API. It handles the initial import of Employees and keeps them synchronized when a Employee is created, updated, or deleted in the external application.

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Employees to my App

Import Employees and receive created/updated or deleted events

# Create Employee

This scenario allows your application to create a Employee in any external application in the same way. 
You will pass Employee fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Employee with and configure mapping to our default model

2. **Create Employee API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Employee data into a format compatible with the selected external application.
   - It then makes an API call to create the Employee in that specific application.


Create Employee

Creates Employee in any external application

# Realtime Full two-way Sync of Employees

This scenario enables your application to fully sync Employees between your app and any external application in both directions. It handles the initial import/export of Employees and then sends events when a Employee is created, updated, or deleted on any side, as close to real-time as possible.

Employee fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Employees in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Employees to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Employees

Bi-directional realtime sync of Employees with records deduplication

# Update Employee

This scenario allows your application to update a Employee in any external application in the same way. 
You will pass  ID of the Employee you want to update and Employee fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Employee with and configure mapping to our default model

2. **Create Employee API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Employee data into a format compatible with the selected external application.
   - It then makes an API call to update the Employee in that specific application.


Updates Employee in any external application

# Get all Employees

This scenario enables your application to get a complete list of Employees from any external application to your app's API in the same way. 

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Employees along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Employees page by page.


Get all Employees

Imports all Employees from any external application to your App.

Sage HR API Integration Profile

Getting Started

Data Collections

Operations

Integration Scenarios