Employment Hero API Integration

These are the list of integration use cases supported by Knit for Employment Hero API as part of the HRIS category

Get a Certification

ID: get_a_certification
Operation: read
Entities: certification, organisation
Summary: This API endpoint retrieves a specific certification for a given organisation. It requires the organisation ID and certification ID as path parameters. The request must include an Authorization header with a bearer token for authentication. The response includes the certification's unique identifier, name, and type.
Input Fields: Input Fields
Output Fields: Output Fields

Get a Leave Request

ID: get_a_leave_request
Operation: read
Entities: leave request, employee, organisation
Summary: This API endpoint retrieves a specific leave request for a given organisation. It requires the organisation ID and the leave request ID as path parameters. The request must include an Authorization header with a bearer token for authentication. The response includes details of the leave request such as start and end dates, total hours, status, and other relevant information.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Certifications for an Organisation

ID: get_all_certifications_for_an_organisation
Operation: read
Entities: certification, organisation
Summary: This API endpoint retrieves a list of all certifications for a specific organisation identified by the organisation_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification objects, each with an id, name, and status. Pagination details such as items per page, current page index, total pages, and total items are also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Custom Fields for an Organisation

ID: get_all_custom_fields_for_an_organisation
Operation: read
Entities: custom field option, custom field, organisation
Summary: This API endpoint retrieves a list of all custom fields for a specific organisation. The request requires an 'organisation_id' as a path parameter and an 'Authorization' header with a bearer token. The response includes a data object containing an array of custom field objects, each with details such as id, name, hint, description, type, onboarding status, requirement status, permissions, and options. The response also provides pagination details including items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Employee Certification Details

ID: get_all_employee_certification_details
Operation: read
Entities: employee, certification, organisation
Summary: This API endpoint retrieves a list of all certifications assigned to a specific employee within an organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification items, each with details such as certification ID, name, type, expiry date, completion date, status, and any driver problems. The response also includes pagination details like items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Employee Custom Fields

ID: get_all_employee_custom_fields
Operation: read
Entities: custom field, employee, organisation
Summary: This API endpoint retrieves a list of all custom fields for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of employee custom field objects, each with properties such as id, value, name, description, and type. The response also includes pagination details like items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Employees of a Team

ID: get_all_employees_of_a_team
Operation: read
Entities: team, employee, organisation
Summary: This API retrieves all employees associated with a specific team within a managed organization. It requires the organization ID and team ID as path parameters and an authorization bearer token in the headers. The response includes an array of employee objects, each containing detailed information such as ID, email, name, job title, and more. The response also provides pagination details like items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Organisations

ID: get_all_organisations
Operation: read
Entities: company, employee, organisation
Summary: The 'Get All Organisations' API retrieves an array of all organisations that are managed by the user or the organisation they work for. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of organisation objects, each with details such as id, name, phone, country, and logo_url. Additionally, pagination details like items per page, current page index, total pages, and total items are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get All Teams

ID: get_all_teams
Operation: read
Entities: team, organisation
Summary: The 'Get All Teams' API retrieves an array of all teams associated with a specified organisation. The request requires an 'organisation_id' as a path parameter and an 'Authorization' header with a bearer token for authentication. The response includes a 'data' object containing an array of team objects, each with an 'id', 'name', and 'status'. Additionally, pagination details such as 'item_per_page', 'page_index', 'total_pages', and 'total_items' are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get an Employee

ID: get_an_employee
Operation: read
Entities: primary_manager, employee, organisation
Summary: This API endpoint retrieves a specific employee's details from the Employment Hero platform. It requires the organisation ID and employee ID as path parameters, and an authorization bearer token in the headers. The response includes detailed information about the employee, such as their name, contact details, job title, and associated managers and cost centres.
Input Fields: Input Fields
Output Fields: Output Fields

Get Bank Accounts for Employee

ID: get_bank_accounts_for_employee
Operation: read
Entities: employee, bank account, organisation
Summary: This API endpoint retrieves a list of all bank accounts for a specific employee within an organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of bank account records, each with details such as account name, account number, BSB, amount, and whether it is the primary account. Pagination details such as items per page, page index, total pages, and total items are also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get Emergency Contact

ID: get_emergency_contact
Operation: read
Entities: employee, emergency contact, organisation
Summary: This API endpoint retrieves a list of all emergency contacts for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of emergency contact objects, each with details such as contact name, contact numbers, relationship, and contact type. Pagination details such as items per page, page index, total pages, and total items are also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Pay Details

ID: get_employee_pay_details
Operation: read
Entities: employee, organisation, pay detail
Summary: This API endpoint retrieves a list of all pay details for a specific employee within a given organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of pay details, each with properties such as id, effective_from, classification, industrial_instrument, pay_rate_template, anniversary_date, salary, salary_type, pay_unit, pay_category, leave_allowance_template, change_reason, and comments. The response also includes pagination details like item_per_page, page_index, total_pages, and total_items.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employees

ID: get_employees
Operation: read
Entities: manager, employee, organisation
Summary: The Get Employees API retrieves an array of all employees managed by a specified organisation. The API requires an organisation ID as a path parameter and an authorization bearer token in the headers. The response includes a data object containing an array of employee objects, each with detailed information such as ID, email, name, address, job title, and more. If there are no employees, the array will be empty.
Input Fields: Input Fields
Output Fields: Output Fields

Get Employment History

ID: get_employment_history
Operation: read
Entities: employment history, employee, organisation
Summary: This API endpoint retrieves the complete employment history for a specific employee within a given organisation. It requires the organisation_id and employee_id as path parameters and an Authorization header with a bearer token for authentication. The response includes an array of employment history records, each containing details such as the position title, start and end dates, and employment type. The response also provides pagination details including items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get Leave Requests

ID: get_leave_requests
Operation: read
Entities: leave request, employee, organisation
Summary: The Get Leave Requests API retrieves a list of all leave requests for a specified organisation. The request requires an organisation_id as a path parameter and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of leave request objects, each with details such as id, start_date, end_date, total_hours, comment, status, leave_balance_amount, leave_category_name, reason, and employee_id.
Input Fields: Input Fields
Output Fields: Output Fields

List Rostered Shifts

ID: get_list_rostered_shifts
Operation: read
Entities: rostered shift, member, organisation
Summary: The 'List Rostered Shifts' API allows users to retrieve all rostered shifts accessible by the current user within a specified organisation. The API supports pagination and filtering by various parameters such as date range, shift statuses, location IDs, member IDs, and more. The request requires an organisation ID as a path parameter and an authorization bearer token in the headers. Optional query parameters include from_date, to_date, statuses, location_ids, member_ids, unassigned_shifts_only, and exclude_shifts_overlapping_from_date. The response includes a list of shifts with details such as start and end times, status, location, member information, and shift swap details.
Input Fields: Input Fields
Output Fields: Output Fields

List Unavailabilities

ID: get_list_unavailabilities
Operation: read
Entities: unavailability, member, organisation
Summary: The List Unavailabilities API retrieves all unavailability records that match the specified conditions for a given organisation. The API requires an organisation ID as a path parameter and supports optional query parameters such as from_date, to_date, location_id, member_id, item_per_page, and page_index to filter the results. The response includes a list of unavailability records with details such as member ID, description, start and end dates, and recurring patterns. The API uses a bearer token for authorization.
Input Fields: Input Fields
Output Fields: Output Fields

Obtain Access Token

ID: get_obtain_access_token
Operation: read
Entities: OAuth 2.0 application, access token, authorisation server
Summary: The Obtain Access Token API is used to initiate the OAuth 2.0 authorization process to obtain an access token for accessing private data over the Employment Hero API. The API requires the client ID, redirect URI, and response type as query parameters. The user will be prompted to log in and grant permissions, after which they will be redirected to the specified redirect URI with an authorization code. This code can then be used to obtain the access token. The Employment Hero account used for authorization can only access data within its roles or permissions.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organisation Details

ID: get_organisation_details
Operation: read
Entities: employee, organisation, payroll_admin_email
Summary: This API endpoint retrieves detailed information about a specific organisation using its UUID. The request requires an Authorization header with a bearer token for authentication. The response includes various details about the organisation such as its name, phone number, country, logo URL, primary address, end of week, typical work day, payroll admin emails, subscription plan, superfund name, employee counts, time zone, and creation date.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organisation Policies

ID: get_organisation_policies
Operation: read
Entities: policy, organisation
Summary: This API endpoint retrieves a list of all policies for a specific organisation identified by the organisation_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of policy objects, each with details such as id, name, induction status, and creation date. Pagination details such as items per page, current page index, total pages, and total items are also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Get Organisations from Employment Hero

ID: get_organisations_from_employment_hero
Operation: read
Entities: organisation
Summary: This API retrieves a list of organisations from Employment Hero. The request must include an access token in the Authorization header, which is obtained from the Employment Hero Authorisation Server. The API uses the GET method and the endpoint is https://api.employmenthero.com/api/v1/organisations. The response includes details of each organisation such as its unique identifier, name, creation date, and last update date.
Input Fields: Input Fields
Output Fields: Output Fields

Get Payslips for Employee

ID: get_payslips_for_employee
Operation: read
Entities: payslip, employee, organisation
Summary: This API endpoint retrieves a list of all payslips for a specific employee within an organisation. It requires the organisation ID and employee ID as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of payslip records, each with details such as employee name, total deductions, net pay, wages, tax, and other payroll-related information. The response also includes pagination details like items per page, current page index, total pages, and total items.
Input Fields: Input Fields
Output Fields: Output Fields

Get Rostered Shift by ID

ID: get_rostered_shift_by_id
Operation: read
Entities: rostered shift, member, organisation
Summary: The 'Get Rostered Shift by ID' API retrieves a specific rostered shift record using its unique ID. The API requires the organisation ID and the shift ID as path parameters. The request must include an Authorization header with a bearer token for authentication. The response includes detailed information about the shift, such as start and end times, status, notes, location details, member details, shift swap information, and any breaks during the shift.
Input Fields: Input Fields
Output Fields: Output Fields

Get Superannuation Detail

ID: get_superannuation_detail
Operation: read
Entities: superannuation detail, employee, organisation
Summary: This API endpoint retrieves the superannuation detail for a specific employee within a given organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the fund name, member number, product code, and other relevant superannuation account information. If the employee does not have a superannuation detail, a not found error will be returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Tax Declaration Detail

ID: get_tax_declaration_detail
Operation: read
Entities: tax declaration, employee, organisation
Summary: The Get Tax Declaration Detail API retrieves the tax declaration details for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the employee's first and last name, tax file number, residency status, and any applicable tax debts. If no tax declaration is found, a not found error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Get Timesheet Entries

ID: get_timesheet_entries
Operation: read
Entities: timesheet entry, employee, organisation
Summary: The Get Timesheet Entries API retrieves a list of all timesheet entries for a specific employee within an organisation. The API requires the organisation ID and employee ID as path parameters. The employee ID can be a specific UUID or '-' to retrieve timesheets for all employees. Optional query parameters include start_date and end_date to filter the timesheet entries by date range. The request must include an Authorization header with a bearer token. The response contains a data object with an array of timesheet entries, each entry includes details such as date, start and end times, status, units, and associated cost centre.
Input Fields: Input Fields
Output Fields: Output Fields

Get Unavailability Record by ID

ID: get_unavailability_record_by_id
Operation: read
Entities: unavailability, member, organisation
Summary: This API retrieves an unavailability record using its ID. It requires the organisation ID and the unavailability record ID as path parameters. The request must include an Authorization header with a bearer token for authentication. The response includes details of the unavailability such as the member ID, description, all-day status, start and end dates, start and end times during the day, and any recurring pattern information.
Input Fields: Input Fields
Output Fields: Output Fields

Access Token Retrieval

ID: post_access_token_retrieval
Operation: write
Entities: authorization code, access token, refresh token
Summary: This API endpoint is used to retrieve an access token required to access protected resources. The request is made using the POST method to the URL 'https://oauth.employmenthero.com/oauth2/token'. The request requires several query parameters: 'client_id', 'client_secret', 'grant_type', 'code', and 'redirect_uri'. The 'grant_type' should be set to 'authorization_code'. The response includes an 'access_token', 'refresh_token', 'token_type', 'expires_in', and 'scope'. The 'access_token' is used for authorization, and the 'token_type' is currently only supported as 'Bearer'. The 'expires_in' indicates the lifetime of the access token in seconds.
Input Fields: Input Fields
Output Fields: Output Fields

Refresh Access Token

ID: post_refresh_access_token
Operation: write
Entities: refresh token, access token, client
Summary: The Refresh Access Token API is used to obtain a new access token using a refresh token. Access tokens expire after 15 minutes, and this API allows for continuous usage by providing a new access token and a new refresh token, invalidating the previous refresh token. The API requires the client_id, client_secret, grant_type, and refresh_token as query parameters. The response includes a new access_token, refresh_token, token_type, expires_in, and scope.
Input Fields: Input Fields
Output Fields: Output Fields