Humi-HR API Integration

These are the list of integration use cases supported by Knit for Humi-HR API as part of the HRIS category

Get Additional Incomes for a Company

ID: get_additional_incomes_for_a_company
Operation: read
Entities: attribute, additional income, company
Summary: This API endpoint retrieves a list of additional incomes available for a company. It requires an authorization token to be included in the request headers. The response follows the JSON:API specification and returns an array of AdditionalIncome objects, each with a unique identifier, machine-readable name, and human-readable display name. The API does not support query parameters and returns a standard list of additional incomes that are consistent across all companies.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_approved_time_off_requests
Operation: read
Entities: company, time off request, employee
Summary: This API endpoint retrieves approved time off requests for a company. It requires authentication via a Bearer token in the Authorization header. The API follows the JSON:API specification and requires the dateRange[start] and dateRange[end] query parameters to filter the time off requests based on the provided date range. Optional pagination parameters page[size] and page[number] can be used to control the number of results per page and the page number, respectively. The response includes an array of timeOffRequest objects, each containing details such as the request ID, employee ID, type of time off, start and end dates, status, and more. The response is paginated and ordered by the updated_at field in descending order.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_approved_time_off_requests_for_employee
Operation: read
Entities: time off request, employee
Summary: This API endpoint retrieves approved time off requests for a specific employee. The request requires an Authorization header with a bearer token and the employee's unique ID as a path parameter. The query parameters include a required date range (start and end dates) to filter the time off requests. Optional pagination parameters can be used to control the number of results per page and the page number. The response includes an array of time off requests, each with details such as type, start and end dates, status, and total time off requested. The response is paginated and follows the JSON:API specification.
Input Fields: Input Fields
Output Fields: Output Fields

ID: get_employee_details
Operation: read
Entities: employee, department, position
Summary: This API retrieves the details of a specific employee from a company using the employee's unique identifier. The request requires an Authorization header with a Bearer token for authentication. The response includes detailed information about the employee, such as their name, contact information, department, position, and employment details. The response follows the JSON:API specification and includes metadata about the API version and copyright information.
Input Fields: Input Fields
Output Fields: Output Fields

ID: post_employee_time_worked
Operation: write
Entities: time worked, employee, additional income
Summary: The Employee Time Worked API allows you to create or update time worked data for a single employee. The API requires authorization via a Bearer token. The request body must include the employee's unique identifier and an array of time worked entries, each containing details such as rate ID, start and end times, hours, and optional additional incomes. The API also supports inferred additional incomes for statutory holidays. The response includes the unique identifier for each time worked entry and calculated costs. The API is designed to handle updates and new entries efficiently.
Input Fields: Input Fields
Output Fields: Output Fields