Sage HR Component

Sage HR is all inclusive Human Resource management solution. Use the Sage HR component to manage Employees, Teams, Projects, and more.

Component key: sage-hr

Description

Sage HR Sage HR is all inclusive Human Resource management solution. Use the Sage HR component to manage Employees, Teams, Projects, and more.

Connections

API Key

Sage HR uses an activated API key for Authentication.

To activate API:

Sign into Sage HR, click on your name on the top right, then click Settings.
On the settings menu, click INTEGRATIONS, then click API.
Click ENABLE API ACCESS to activate access to API and provide you with your unique API key.
Save the API Key and paste into your Prismatic connection configuration.

Input	Notes
API Key password / Required apiKey	API Key for your Sage HR User
Subdomain Name string / Required subdomain	The subdomain name of your Sage HR account

Data Sources

Fetch Positions

Fetch an array of positions | key: positions | type: picklist

Input	Notes	Example
Connection connection / Required connection
Page string page	The page number to return	2

Example Payload for Fetch Positions

{
  "result": [
    {
      "label": "CFO",
      "key": "19"
    }
  ]
}

Fetch Projects

Fetch an array of Projects | key: projects | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Fetch Projects

{
  "result": [
    {
      "label": "Project Name.",
      "key": "123"
    }
  ]
}

Fetch Teams

Fetch an array of teams | key: teams | type: picklist

Input	Notes	Example
Connection connection / Required connection
Page string page	The page number to return	2

Example Payload for Fetch Teams

{
  "result": [
    {
      "label": "Sales",
      "key": "19"
    }
  ]
}

Actions

Close Project

Close a project. | key: closeProject

Input	Notes	Example
Connection connection / Required connectionInput
Project ID string / Required project_id	ID of project to be closed	123

Example Payload for Close Project

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Create Document

Creates a document only visible to the employee themselves. | key: createDocument

Input	Default	Notes	Example
Category ID string category_id		Optional ID of the document category to filter by.	123
Connection connection / Required connectionInput
Description string description		Document description.	Document description
Employee IDs string / Required Value List employee_id	000xxx	Employee Identifier; also accepts and array of integers to share with multiple employees	123213
Expiration Date string expiration_date		Expiration date of the document, format: YYYY-MM-DD	2020-01-01
Expires boolean expires	false	if 'true' expiration_date is also required	true
File Name string / Required file_name		The name of the file	filename.jpg
File data / Required fileInput		The file to upload.	Some binary file
Notify boolean notify	false	'true' to notify employee by email	true
Right to Work Document Number string right_to_work_document_number		Right to work document number	123213
Right to Work Document Type string right_to_work_document_type		Right to work document type	valid
Shared With Direct Manager boolean shared_with_direct_manager	false	'true' to share with all direct manager	true
Shared With Everyone boolean shared_with_everyone	false	'true' to share with all employees	true
Shared With Team Manager boolean shared_with_team_manager	false	'true' to share with all team managers	true
Source string source	API	Source of the document	API
Status string status		Status of the document	valid

Example Payload for Create Document

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Create Employee

Create new employee | key: createEmployee

Input	Default	Notes	Example
City string city		Employees address city	Jacksonville
Connection connection / Required connectionInput
Country string country		Employees country two character ISO code	US
Date of Birth string date_of_birth		Employees date of birth, format: YYYY-MM-DD	2020-01-01
Email string / Required email		Email address of the employee	test@test.es
First Name string / Required first_name		First name of the employee	John
Gender string gender		Employees gender, Must be one of: Male, Female, Other	Male
Home Phone string home_phone		Home phone number	+1 123 456 789
Last Name string / Required last_name		Last name of the employee	Locke
Marital Status string marital_status		Employees marital status, Must be one of: Married, Single, Divorced, Widower, In a relationship, Other	Single
Mobile Phone string mobile_phone		Mobile phone number	+1 123 456 789
Nationality string nationality		Employees nationalty in long form, example: Canadian	Canadian
Personal Identification Number string personal_identification_number		Personal identification number	1123456789
Position Title string position_title		Employees position	Engineer
Post Code string post_code		Employees address: zip or postal code	32003
Send Email boolean send_email	false	'true' to send welcome email to employee	false
State string state		Employees address: state	Florida
Street First string street_first		Employees address first line	First street
Street Second string street_second		Employees address second line	Second street
Tax Number string tax_number		Tax Number	1123456789
Work Phone string work_phone		Work phone number	+1 123 456 789
Work Start Date string work_start_date		Employees work start date, format: YYYY-MM-DD, leave empty to use todays date	2020-01-01

Example Payload for Create Employee

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Create Project

Create a new project. | key: createProject

Input	Default	Notes	Example
Project Code string code		Code of the project	123
Connection connection / Required connectionInput
End Date string end_date		Last working day; format: YYYY-MM-DD	2020-01-01
Limit Total Hours boolean limit_total_hours	false	Activate the limit of hours	true
Max Limit Total Hours string max_limit_total_hours		The limit number of hours	123
Project Name string name		Name of the project	New Project
Start Date string start_date		Last working day; format: YYYY-MM-DD	2020-01-01

Example Payload for Create Project

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Create Projects

Create a batch of projects. | key: createProjects

Input	Notes	Example
Connection connection / Required connectionInput
Projects code / Required projects	An array of projects.

Example Payload for Create Projects

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Create Time Off Requests

Create new time off request | key: createTimeOffRequests

Input	Notes	Example
Connection connection / Required connectionInput
Last Working Day string date	format: YYYY-MM-DD; required if type is single	2020-01-01
Last Working Day string date_from	format: YYYY-MM-DD; required if type is multi	2020-01-01
Last Working Day string date_to	format: YYYY-MM-DD; required if type is multi	2020-01-01
Details string details	required based on policy settings	2
Employee ID string / Required employee_id	The ID of the employee	12323
Hours string hours	required if type is single & part_of_day is first_part_of_day or second_part_of_day	2
Part of Day string part_of_day	Part of day	specific_timespan
Replacement ID string replacement_id	Time off policy ID	123
Last Working Day string time_from	format: H:M; required if part_of_day is specific_timespan	9:00
Time Off Policy ID string time_off_policy_id	Time off policy ID	123
Last Working Day string time_to	format: H:M; required if part_of_day is specific_timespan	15:00
Type string type	Time off request type	Multi

Example Payload for Create Time Off Requests

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Delete Document

Allows admin to delete document. | key: deleteDocument

Input	Notes	Example
Connection connection / Required connectionInput
Document ID string / Required document_id	ID of document to be deleted	123

Example Payload for Delete Document

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Get Document

View Document Details. | key: getDocument

Input	Notes	Example
Connection connection / Required connectionInput
Document ID string / Required document_id	Document ID	123

Example Payload for Get Document

{
  "data": {
    "data": {
      "id": 18,
      "document_category_id": 15,
      "description": "",
      "company_id": 5,
      "file_name": "test_pdf.pdf",
      "file_content_type": "application/pdf",
      "file_size": 6193,
      "file_updated_at": "2021-06-09T07:32:16.562-07:00",
      "shared_with_direct_manager": false,
      "shared_with_team_manager": true,
      "created_by": 5,
      "source": "web",
      "created_at": "2021-06-09T14:32:20Z",
      "updated_at": "2021-06-09T14:32:20Z",
      "shared_with_everyone": false,
      "last_edited_by": 5,
      "document_template_pattern_id": null,
      "acceptance_required": false,
      "acceptance_deadline": null,
      "file_scan_started_at": null,
      "file_scan_result": "Pass",
      "document_type": "",
      "document_type_other": "",
      "right_to_work_number": "",
      "expiration_date": null,
      "document_expires": false
    }
  }
}

Get Employee

Retrieve single active employee in company. | key: getEmployee

Input	Default	Notes	Example
Connection connection / Required connectionInput
Employee ID string / Required employee_id		The ID of the employee	12323
Employment Status History boolean employment_status_history	false	Whether to return the employment status history	false
Position History boolean position_history	false	Whether to return the position history	false
Team History boolean team_history	false	Whether to return the team history	false

Example Payload for Get Employee

{
  "data": {
    "data": {
      "id": 19,
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "picture_url": "https://example.com/john.png",
      "employment_start_date": "2014-08-25",
      "date_of_birth": "1991-02-13",
      "team": "Sage HR",
      "team_id": 6742,
      "position": "Api developer",
      "position_id": 123,
      "reports_to_employee_id": 5,
      "work_phone": "555-0505",
      "home_phone": "555-0506",
      "mobile_phone": "555-0507",
      "gender": "Male",
      "street_first": "84 Glenwood Street",
      "street_second": "Peoria",
      "city": "London",
      "post_code": 99999,
      "country": "GB",
      "employee_number": "A1",
      "employment_status": "Full-time",
      "nationality": "Spanish",
      "marital_status": "Married",
      "personal_identification_number": "1",
      "tax_number": "1",
      "team_history": [
        {
          "team_id": 1,
          "start_date": "2018-01-01",
          "end_date": "201-01-01",
          "team_name": "Some Team"
        }
      ],
      "employment_status_history": [
        {
          "employment_status_id": 1,
          "start_date": "2018-01-01",
          "end_date": "201-01-01",
          "employment_statu_name": "Full time"
        }
      ],
      "position_history": [
        {
          "position_id": 1,
          "start_date": "2018-01-01",
          "end_date": "201-01-01",
          "position_name": "Developer",
          "position_code": "1234"
        }
      ]
    }
  }
}

Get Employee Compensations

Retrieve single employee's compensation details | key: getEmployeeCompensations

Input	Notes	Example
Connection connection / Required connectionInput
Employee ID string / Required employee_id	The ID of the employee	12323

Example Payload for Get Employee Compensations

{
  "data": {
    "data": [
      {
        "start_date": "2017-01-01",
        "end_date": "2019-01-01",
        "currency": "EUR",
        "amount": 1234,
        "period": "monthly",
        "comment": "Starting salary",
        "category": "Salary"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

Get Employee Custom Fields

Get employee custom fields | key: getEmployeeCustomFields

Input	Notes	Example
Connection connection / Required connectionInput
Employee ID string / Required employee_id	The ID of the employee	12323

Example Payload for Get Employee Custom Fields

{
  "data": {
    "data": [
      {
        "id": 1,
        "label": "Hobby",
        "type": "CustomDropdownField",
        "value": "Hockey",
        "options": [
          "Hockey",
          "Football",
          "Voleyball"
        ]
      },
      {
        "id": 2,
        "label": "Languages",
        "type": "CustomTags",
        "options": null,
        "value": [
          "English",
          "Latvian",
          "Estonian"
        ]
      }
    ]
  }
}

Get Terminated Employee

Retrieve single terminated employee | key: getTerminatedEmployee

Input	Notes	Example
Connection connection / Required connectionInput
Employee ID string / Required employee_id	The ID of the employee	12323

Example Payload for Get Terminated Employee

{
  "data": {
    "data": {
      "id": 19,
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "picture_url": "https://example.com/john.png",
      "employment_start_date": "2014-08-25",
      "date_of_birth": "1991-02-13",
      "position": "Api developer",
      "position_id": 1234,
      "reports_to_employee_id": 1000,
      "work_phone": "867-5309",
      "home_phone": "555-5555",
      "mobile_phone": "555-1234",
      "gender": "Male",
      "street_first": "123 some Street",
      "stree_second": "3A",
      "city": "London",
      "post_code": "E8 1LA",
      "country": "GB",
      "employee_number": 123,
      "personal_identification_number": "1",
      "tax_number": "1",
      "termination_date": "2015-05-28",
      "termination": {
        "reason": "Moving location",
        "comments": "Moving to"
      }
    }
  }
}

List Documents

View all documents for company | key: listDocuments

Input	Notes	Example
Category ID string category_id	Optional ID of the document category to filter by.	123
Connection connection / Required connectionInput
Employee ID string employee_id	Optional id of employee to filter documents.	12323

Example Payload for List Documents

{
  "data": {
    "data": [
      {
        "id": 18,
        "document_category_id": 15,
        "description": "",
        "company_id": 5,
        "file_name": "test_pdf.pdf",
        "file_content_type": "application/pdf",
        "file_size": 6193,
        "file_updated_at": "2021-06-09T07:32:16.562-07:00",
        "shared_with_team_manager": true,
        "shared_with_direct_manager": false,
        "created_by": 5,
        "source": "web",
        "created_at": "2021-06-09T14:32:20Z",
        "updated_at": "2021-06-09T14:32:20Z",
        "shared_with_everyone": false,
        "last_edited_by": 5,
        "document_template_pattern_id": null,
        "acceptance_required": false,
        "acceptance_deadline": null,
        "file_scan_started_at": null,
        "file_scan_result": "Pass",
        "document_type": "",
        "document_type_other": "",
        "right_to_work_number": "",
        "expiration_date": null,
        "document_expires": false
      },
      {
        "id": 19,
        "document_category_id": 15,
        "description": "",
        "company_id": 5,
        "file_name": "test_pdf2.pdf",
        "file_content_type": "application/pdf",
        "file_size": 6193,
        "file_updated_at": "2021-06-09T07:59:56.762-07:00",
        "shared_with_managers": true,
        "created_by": 5,
        "source": "web",
        "created_at": "2021-06-09T15:00:20Z",
        "updated_at": "2021-06-09T15:00:20Z",
        "shared_with_direct_manager": false,
        "shared_with_team_manager": true,
        "last_edited_by": 5,
        "document_template_pattern_id": null,
        "acceptance_required": false,
        "acceptance_deadline": null,
        "file_scan_started_at": null,
        "file_scan_result": "Pass",
        "document_type": "",
        "document_type_other": "",
        "right_to_work_number": "",
        "expiration_date": null,
        "document_expires": false
      }
    ]
  }
}

List Employees

List active employees in company. | key: listEmployees

Input	Default	Notes	Example
Connection connection / Required connectionInput
Employment Status History boolean employment_status_history	false	Whether to return the employment status history	false
Page string page		The page number to return	2
Position History boolean position_history	false	Whether to return the position history	false
Team History boolean team_history	false	Whether to return the team history	false

Example Payload for List Employees

{
  "data": {
    "data": [
      {
        "id": 19,
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "picture_url": "https://example.com/john.png",
        "employment_start_date": "2014-08-25",
        "date_of_birth": "1991-02-13",
        "team": "Sage HR",
        "team_id": 1,
        "position": "Api developer",
        "position_id": 123,
        "reports_to_employee_id": 5,
        "work_phone": "555-0505",
        "home_phone": "555-0506",
        "mobile_phone": "555-0507",
        "gender": "Male",
        "street_first": "84 Glenwood Street",
        "street_second": "Peoria",
        "city": "London",
        "post_code": 99999,
        "country": "GB",
        "employee_number": "A01",
        "employment_status": "Full-time",
        "nationality": "Spanish",
        "marital_status": "Married",
        "personal_identification_number": "1",
        "tax_number": "1",
        "team_history": [
          {
            "team_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "team_name": "Some Team"
          }
        ],
        "employment_status_history": [
          {
            "employment_status_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "employment_statu_name": "Full time"
          }
        ],
        "position_history": [
          {
            "position_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "position_name": "Developer",
            "position_code": "1234"
          }
        ]
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

List Positions

List positions in company | key: listPositions

Input	Notes	Example
Connection connection / Required connectionInput
Page string page	The page number to return	2

Example Payload for List Positions

{
  "data": {
    "data": [
      {
        "id": 19,
        "title": "CFO",
        "description": "...",
        "code": "X2"
      },
      {
        "id": 20,
        "title": "CEO",
        "description": null,
        "code": null
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

List Projects

List projects | key: listProjects

Input	Notes
Connection connection / Required connectionInput

List Teams

List teams in company | key: listTeams

Input	Notes	Example
Connection connection / Required connectionInput
Page string page	The page number to return	2

Example Payload for List Teams

{
  "data": {
    "data": [
      {
        "id": 19,
        "name": "Sales",
        "manager_ids": [
          1,
          2
        ],
        "employee_ids": [
          5,
          7,
          90
        ]
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

List Terminated Employees

Retrieve a list of terminated employees | key: listTerminatedEmployees

Input	Default	Notes	Example
Connection connection / Required connectionInput
Employment Status History boolean employment_status_history	false	Whether to return the employment status history	false
Page string page		The page number to return	2
Position History boolean position_history	false	Whether to return the position history	false
Team History boolean team_history	false	Whether to return the team history	false

Example Payload for List Terminated Employees

{
  "data": {
    "data": [
      {
        "id": 19,
        "termination_date": "2015-05-28",
        "employee_number": "123",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "picture_url": "https://example.com/john.png",
        "employment_start_date": "2014-08-25",
        "date_of_birth": "1991-02-13",
        "position": "Api developer",
        "personal_identification_number": "1",
        "tax_number": "1",
        "team_history": [
          {
            "team_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "team_name": "Some Team"
          }
        ],
        "employment_status_history": [
          {
            "employment_status_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "employment_statu_name": "Full time"
          }
        ],
        "position_history": [
          {
            "position_id": 1,
            "start_date": "2018-01-01",
            "end_date": "201-01-01",
            "position_name": "Developer",
            "position_code": "1234"
          }
        ]
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

List Time Off Balances

Lists employee time off balances | key: listTimeOffBalances

Input	Notes	Example
Connection connection / Required connectionInput
Employee ID string / Required employee_id	The ID of the employee	12323

Example Payload for List Time Off Balances

{
  "data": {
    "data": [
      {
        "policy_id": 1,
        "used": 5.6,
        "available": 2
      },
      {
        "policy_id": 2,
        "used": 75,
        "available": null
      }
    ]
  }
}

List Time Off Requests

Lists employee time off Requests | key: listTimeOffRequests

Input	Notes	Example
Connection connection / Required connectionInput
From Date string from	If not specified defaults to beginning of current month. Format: YYYY-MM-DD	2018-05-20
Page string page	The page number to return	2
To Date string to	If not specified defaults to end of current month. Days between from date and to date must be less than 65. If you need info for larger period of time make multiple requests. Format: YYYY-MM-DD	2018-05-20

Example Payload for List Time Off Requests

{
  "data": {
    "data": [
      {
        "id": 2902504,
        "status": "Approved",
        "status_code": "approved",
        "policy_id": 1,
        "employee_id": 1,
        "replacement": {
          "id": 2,
          "full_name": "John Doe"
        },
        "details": "Birthday lunch",
        "is_multi_date": false,
        "is_single_day": true,
        "is_part_of_day": true,
        "first_part_of_day": false,
        "second_part_of_day": true,
        "start_date": "2018-05-24",
        "end_date": "2018-05-24",
        "request_date": "2018-05-22",
        "approval_date": null,
        "hours": 3.5,
        "fields": [
          {
            "title": "Approved by manager?",
            "answer": "yes"
          }
        ]
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 2,
      "previous_page": null,
      "total_pages": 2,
      "per_page": 50,
      "total_entries": 75
    }
  }
}

Raw Request

Send raw HTTP request to Sage HR | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/employees), The base URL is already included (https://subdomain.sage.hr/api/). For example, to connect to https://subdomain.sage.hr/api/employees, only /employees is entered in this field.	/employees
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Rehire Employee

Rehire Employee. | key: rehireEmployee

Input	Default	Notes	Example
Comments string comments		Comments	No comments
Connection connection / Required connectionInput
New start working day string / Required date		format: YYYY-MM-DD	2020-01-01
Employee ID string / Required employee_id		The ID of the employee	12323
Start Fresh boolean start_fresh	false	This parameter is used to start the employee record clean, resetting the employee's leave balances.	No comments

Example Payload for Rehire Employee

{
  "data": {}
}

Terminate Employee

Terminate Employee. | key: terminateEmployee

Input	Notes	Example
Comments string comments	Comments	No comments
Connection connection / Required connectionInput
Last Working Day string / Required date	Last working day; format: YYYY-MM-DD	2020-01-01
Employee ID string / Required employee_id	The ID of the employee	12323
Termination Reason ID string / Required termination_reason_id	Termination reason ID	123

Example Payload for Terminate Employee

{
  "data": {}
}

Time Clocking In and Out

Clock in and out employees on specific days | key: timeClockingInAndOut

Input	Default	Notes	Example
Clocked Time code / Required clocked_time		Clocked time entries for the day. If override is true, this will override the existing entries.
Connection connection / Required connectionInput
Override boolean override	false	'true' if override provided days clocked entries	true

Example Payload for Time Clocking In and Out

{
  "data": {
    "errors": [
      "error 1",
      "error 2"
    ]
  }
}

Update Document

Document will only be visible to employee themselves. | key: updateDocument

Input	Default	Notes	Example
Category ID string category_id		Optional ID of the document category to filter by.	123
Connection connection / Required connectionInput
Description string description		Document description.	Document description
Document ID string / Required document_id		ID of document to be updated	123
Employee IDs string / Required Value List employee_id	000xxx	Employee Identifier; also accepts and array of integers to share with multiple employees	123213
Expiration Date string expiration_date		Expiration date of the document, format: YYYY-MM-DD	2020-01-01
Expires boolean expires	false	if 'true' expiration_date is also required	true
File Name string / Required file_name		The name of the file	filename.jpg
File data / Required fileInput		The file to upload.	Some binary file
Notify boolean notify	false	'true' to notify employee by email	true
Right to Work Document Number string right_to_work_document_number		Right to work document number	123213
Right to Work Document Type string right_to_work_document_type		Right to work document type	valid
Shared With Direct Manager boolean shared_with_direct_manager	false	'true' to share with all direct manager	true
Shared With Everyone boolean shared_with_everyone	false	'true' to share with all employees	true
Shared With Team Manager boolean shared_with_team_manager	false	'true' to share with all team managers	true
Source string source	API	Source of the document	API
Status string status		Status of the document	valid

Example Payload for Update Document

{
  "data": {
    "data": {
      "id": 18,
      "document_category_id": 15,
      "description": "",
      "company_id": 5,
      "file_name": "test_pdf.pdf",
      "file_content_type": "application/pdf",
      "file_size": 6193,
      "file_updated_at": "2021-06-09T07:32:16.562-07:00",
      "shared_with_direct_manager": false,
      "shared_with_team_manager": true,
      "created_by": 5,
      "source": "web",
      "created_at": "2021-06-09T14:32:20Z",
      "updated_at": "2021-06-09T14:32:20Z",
      "shared_with_everyone": false,
      "last_edited_by": 5,
      "document_template_pattern_id": null,
      "acceptance_required": false,
      "acceptance_deadline": null,
      "file_scan_started_at": null,
      "file_scan_result": "Pass",
      "document_type": "",
      "document_type_other": "",
      "right_to_work_number": "",
      "expiration_date": null,
      "document_expires": false
    }
  }
}

Update Employee

Update employee | key: updateEmployee

Input	Default	Notes	Example
Approver IDs string Value List approver_ids	000xxx	List of approver IDs.
City string city		Employees address city	Jacksonville
Connection connection / Required connectionInput
Country string country		Employees country two character ISO code	US
Date of Birth string date_of_birth		Employees date of birth, format: YYYY-MM-DD	2020-01-01
Employee ID string / Required employee_id		The ID of the employee	12323
Employee Number string employee_number		The employee number	12323
First Name string first_name		First name of the employee	John
Gender string gender		Employees gender, Must be one of: Male, Female, Other	Male
Home Phone string home_phone		Home phone number	+1 123 456 789
Last Name string last_name		Last name of the employee	Locke
Leader ID string leader_id		The ID of the leader	12323
Location ID string location_id		The ID of the location	12323
Marital Status string marital_status		Employees marital status, Must be one of: Married, Single, Divorced, Widower, In a relationship, Other	Single
Mobile Phone string mobile_phone		Mobile phone number	+1 123 456 789
Nationality string nationality		Employees nationalty in long form, example: Canadian	Canadian
Personal Identification Number string personal_identification_number		Personal identification number	1123456789
Position ID string position_id		The ID of the position	12323
Post Code string post_code		Employees address: zip or postal code	32003
Selected Leave Types string Value List selected_leave_types	000xxx	Selected leave types.
State string state		Employees address: state	Florida
Street First string street_first		Employees address first line	First street
Street Second string street_second		Employees address second line	Second street
Tax Number string tax_number		Tax Number	1123456789
Team ID string team_id		The ID of the team	12323
Work Phone string work_phone		Work phone number	+1 123 456 789
Work Start Date string work_start_date		Employees work start date, format: YYYY-MM-DD, leave empty to use todays date	2020-01-01

Example Payload for Update Employee

{
  "data": {
    "data": {
      "id": 1711
    }
  }
}

Update Employee Custom Field

Update employee custom field | key: updateEmployeeCustomField

Input	Notes	Example
Connection connection / Required connectionInput
Custom Field ID string / Required custom_field_id	Custom field ID	123
Employee ID string / Required employee_id	The ID of the employee	12323
Custom Field Value string / Required value	Custom field Value	123

Example Payload for Update Employee Custom Field

{
  "data": {
    "data": null
  }
}

Update Project

Update a project. | key: updateProject

Input	Default	Notes	Example
Project Code string code		Code of the project	123
Connection connection / Required connectionInput
End Date string end_date		Last working day; format: YYYY-MM-DD	2020-01-01
Project ID string / Required id		Id of the project	123
Limit Total Hours boolean limit_total_hours	false	Activate the limit of hours	true
Max Limit Total Hours string max_limit_total_hours		The limit number of hours	123
Project Name string name		Name of the project	New Project
Start Date string start_date		Last working day; format: YYYY-MM-DD	2020-01-01

Example Payload for Update Project

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Update Projects

Update a batch of projects. | key: updateProjects

Input	Notes	Example
Connection connection / Required connectionInput
Projects code / Required projects	Array of projects to be updated

Example Payload for Update Projects

{
  "data": {
    "data": {
      "id": 1
    }
  }
}

Sage HR is all inclusive Human Resource management solution. Use the Sage HR component to manage Employees, Teams, Projects, and more.

Description​

Connections​

API Key​

Data Sources​

Fetch Positions​

Fetch Projects​

Fetch Teams​

Actions​

Close Project​

Create Document​

Create Employee​

Create Project​

Create Projects​

Create Time Off Requests​

Delete Document​

Get Document​

Get Employee​

Get Employee Compensations​

Get Employee Custom Fields​

Get Terminated Employee​

List Documents​

List Employees​

List Positions​

List Projects​

List Teams​

List Terminated Employees​

List Time Off Balances​

List Time Off Requests​

Raw Request​

Rehire Employee​

Terminate Employee​

Time Clocking In and Out​

Update Document​

Update Employee​

Update Employee Custom Field​

Update Project​

Update Projects​