Guides
Signup For Free

Alexis HR API Integration

Suggest Edits

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

Delete One Additional Compensation

  • ID: delete_one_additional_compensation
  • Operation: write
  • Entities: compensation
  • Summary: The 'Delete One Additional Compensation' API allows the user to delete a specific additional compensation resource identified by its ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource to be deleted. Upon successful deletion, a 204 status code is returned with an 'ok' status. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Bonus Compensation

  • ID: delete_one_bonus_compensation
  • Operation: write
  • Entities: response, bonus compensation, request
  • Summary: The 'Delete One Bonus Compensation' API allows the user to delete a specific bonus compensation record identified by its resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource to be deleted. Upon successful deletion, a 204 status code is returned with an 'ok' status. In case of errors, appropriate status codes and error messages are returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Child

  • ID: delete_one_child
  • Operation: write
  • Entities: resource, child
  • Summary: The 'Delete One Child' API allows the user to delete a specific child resource identified by its ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource to be deleted. The API responds with a 204 status code on successful deletion. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Compensation

  • ID: delete_one_compensation
  • Operation: write
  • Entities: compensation
  • Summary: The 'Delete One Compensation' API allows the user to delete a specific compensation record identified by its resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID of the compensation to be deleted. Upon successful deletion, a 204 status code is returned with an empty data object. In case of errors, appropriate status codes and error messages are returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Cost Center

  • ID: delete_one_cost_center
  • Operation: write
  • Entities: cost center
  • Summary: The 'Delete One Cost Center' API allows the user to delete a specific cost center identified by its unique resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID of the cost center to be deleted. Upon successful deletion, a 204 status code is returned with a status string and an empty data object. In case of errors, various status codes such as 400, 401, 403, 404, and 500 are returned with appropriate error messages and descriptions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Department

  • ID: delete_one_department
  • Operation: write
  • Entities: department
  • Summary: The 'Delete One Department' API allows the user to delete a specific department by providing the department's unique ID in the path parameters. The request requires an authorization header with a Bearer token. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. If there are errors, such as a bad request, unauthorized access, forbidden access, not found, or internal server error, appropriate status codes and error messages are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Employee

  • ID: delete_one_employee
  • Operation: write
  • Entities: employee
  • Summary: The 'Delete One Employee' API allows you to delete an employee record from the system using the DELETE method. The API requires an Authorization header with a Bearer token for authentication. The path parameter 'id' is required to specify the employee resource to be deleted. Upon successful deletion, a 204 status code is returned with an empty data object. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One EmployeeTeamReference

  • ID: delete_one_employeeteamreference
  • Operation: write
  • Entities: employee team reference, response, request
  • Summary: The 'Delete One EmployeeTeamReference' API allows the deletion of a specific EmployeeTeamReference resource identified by its ID. The request requires an Authorization header with a Bearer token for authentication. The ID of the resource to be deleted must be provided as a path parameter. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Employment

  • ID: delete_one_employment
  • Operation: write
  • Entities: employment
  • Summary: The 'Delete One Employment' API allows the user to delete a specific employment record by providing the resource ID in the path parameters. The request requires an authorization header with a Bearer token. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Employment Type

  • ID: delete_one_employment_type
  • Operation: write
  • Entities: employment type
  • Summary: The 'Delete One Employment Type' API allows the user to delete a specific employment type by providing the resource ID in the path parameters. The request requires an authorization header with a Bearer token. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. In case of errors, appropriate status codes and error messages are returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Leave

  • ID: delete_one_leave
  • Operation: write
  • Entities: leave, response, authorization
  • Summary: The 'Delete One Leave' API allows the user to delete a specific leave record identified by its resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID of the leave to be deleted. Upon successful deletion, a 204 status code is returned with a status string and an empty data object. In case of errors, appropriate status codes and error messages are returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One LeaveType

  • ID: delete_one_leavetype
  • Operation: write
  • Entities: leave type
  • Summary: The 'Delete One LeaveType' API allows the user to delete a specific leave type by providing the resource ID in the path parameters. The request requires an authorization header with a Bearer token. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Office

  • ID: delete_one_office
  • Operation: write
  • Entities: office
  • Summary: The 'Delete One Office' API allows the user to delete a specific office resource identified by its ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the office resource to be deleted. Upon successful deletion, a 204 status code is returned with an 'ok' status. In case of errors, appropriate status codes and error messages are returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One Team

  • ID: delete_one_team
  • Operation: write
  • Entities: team
  • Summary: The 'Delete One Team' API allows the user to delete a specific team identified by its resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the team to be deleted. Upon successful deletion, a 204 status code is returned with an 'ok' status. If there are errors, appropriate status codes and messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One TimesheetEntry

  • ID: delete_one_timesheetentry
  • Operation: write
  • Entities: timesheet entry
  • Summary: The 'Delete One TimesheetEntry' API allows the user to delete a specific timesheet entry by providing the resource ID in the path parameters. The request requires an authorization header with a Bearer token. Upon successful deletion, a 204 status code is returned with an 'ok' status and empty data. In case of errors, appropriate status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete One WorkWeek

  • ID: delete_one_workweek
  • Operation: write
  • Entities: work week
  • Summary: The 'Delete One WorkWeek' API allows the user to delete a specific work week resource identified by its ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource to be deleted. The API responds with a 204 status code on successful deletion, indicating that the resource was deleted successfully. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch and Update Employee Compensation

  • ID: fetch_and_update_employee_compensation
  • Operation: write
  • Entities:
  • Summary: This configuration involves two steps: first, fetching the compensationId of an employee using the 'Get One Employee' API, and then using this compensationId to update the compensation details via the 'Update One Compensation' API. The first step requires an employee ID and authorization token to retrieve detailed employee information, including the compensationId. The second step uses the compensationId to update various compensation details such as amount, currency, payout day, and more. The final output includes the updated compensation details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Employee Department and Update Department Details

  • ID: fetch_employee_department_and_update_department_details
  • Operation: write
  • Entities:
  • Summary: This configuration involves two steps: First, it fetches the department ID of an employee using the 'Get One Employee' API. The employee ID is provided as a path parameter, and an authorization token is required in the headers. Optional query parameters can be used to select specific fields and related resources. The response includes detailed employee information, including the department ID. In the second step, the 'Update One Department' API is used to update the department details using the fetched department ID. The request requires an authorization header, a content-type header, and a JSON body containing the department's name and optionally its description, cost center ID, and parent department ID. The response includes the updated department details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Company Details Using Employee ID

  • ID: get_company_details_using_employee_id
  • Operation: read
  • Entities:
  • Summary: This configuration involves two steps to fetch company details using an employee ID. First, the 'Get One Employee' API is used to retrieve the employee's details, including the companyId. The API requires an authorization token and the employee ID as a path parameter. Optional query parameters can be used to select specific fields and related resources. The response includes comprehensive employee data, such as personal details and employment information. In the second step, the 'Get One Company' API is used to retrieve detailed information about the company using the companyId obtained from the first step. This API also requires an authorization token and the company ID as a path parameter. Optional query parameters allow selection of specific company fields. The response includes the company's details, such as id, name, orgNumber, and contact information. Both APIs handle various response codes, including success and error codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Additional Compensations

  • ID: get_many_additional_compensations
  • Operation: read
  • Entities: additional compensation, employee, company
  • Summary: The 'Get Many Additional Compensations' API allows users to retrieve multiple additional compensation records from the Alexis HR system. The API supports various query parameters for selecting specific fields, filtering conditions, limiting, offsetting, and sorting the results. The response includes a status, an array of additional compensation data, and metadata such as total count and offset. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Bonus Compensations

  • ID: get_many_bonus_compensations
  • Operation: read
  • Entities: bonus compensation, employee, company
  • Summary: The 'Get Many Bonus Compensations' API allows users to retrieve multiple bonus compensation records from the Alexis HR system. The API supports filtering, sorting, and pagination through query parameters. Users can specify which fields to select, apply filters on various fields like id, companyId, employeeId, etc., limit the number of results, and offset the starting point of the results. The response includes the status, data array of bonus compensations, total number of resources, count of received resources, and any relations. The API requires an Authorization header with a Bearer token. Possible responses include a successful 200 status with data, or error statuses such as 400 Bad Request, 401 Unauthorized, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Children

  • ID: get_many_children
  • Operation: read
  • Entities: filter, employee, child
  • Summary: The 'Get Many Children' API endpoint allows users to retrieve multiple child records from the Alexis HR system. The API supports various query parameters such as 'select' to specify which fields to return, 'filters' to apply conditions on fields like 'id', 'employeeId', 'name', and 'birthdate', 'limit' to restrict the number of records, 'offset' for pagination, and 'sort' to order the results. The response includes a status, an array of child data, total number of resources, count of received resources, and any relations. The API requires an Authorization header with a Bearer token. It returns different status codes and messages for successful and error responses, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Companies

  • ID: get_many_companies
  • Operation: read
  • Entities: company
  • Summary: The 'Get Many Companies' API allows users to retrieve a list of companies with various filtering, sorting, and pagination options. The request requires an Authorization header with a Bearer token. Query parameters include 'select' for specifying fields, 'filters' for conditional filtering, 'limit' for limiting the number of results, 'offset' for pagination, and 'sort' for sorting the results. The response includes a status, data array of company objects, total number of resources, count of received resources, and offset. Possible response codes are 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Compensations

  • ID: get_many_compensations
  • Operation: read
  • Entities: compensation, employee, company
  • Summary: The 'Get Many Compensations' API allows users to retrieve multiple compensation records from the Alexis HR system. The API supports various query parameters such as 'select' to specify fields, 'filters' to apply conditions on fields, 'limit' to restrict the number of records, 'offset' for pagination, and 'sort' to order the results. The response includes a status, an array of compensation data, and metadata like total count and offset. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Cost Centers

  • ID: get_many_cost_centers
  • Operation: read
  • Entities: resource, field, cost center
  • Summary: The 'Get Many Cost Centers' API allows users to retrieve multiple cost centers from the Alexis HR system. The API supports filtering, sorting, and pagination through query parameters. Users can specify fields to select, apply filters on fields like id, companyId, code, and name, limit the number of results, and sort the results. The response includes the status, data with cost center details, total number of resources, count of received resources, and offset. Error responses include status codes and error messages for bad requests, unauthorized access, forbidden access, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Departments

  • ID: get_many_departments
  • Operation: read
  • Entities: department, cost center, company
  • Summary: The 'Get Many Departments' API allows users to retrieve multiple department records from the Alexis HR system. The API supports various query parameters such as 'select' to specify fields, 'relations' to include related resources, 'filters' to apply conditions on fields, 'limit' to restrict the number of records, 'offset' for pagination, and 'sort' to order the results. The response includes the status, an array of department data, total number of resources, count of received resources, and any related cost center information. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Employee Team References

  • ID: get_many_employee_team_references
  • Operation: read
  • Entities: team, employee, user
  • Summary: The 'Get Many Employee Team References' API allows users to retrieve multiple EmployeeTeamReference records from the AlexisHR system. The API supports various query parameters such as 'select' to specify fields, 'relations' to include related resources, 'filters' to apply conditions on fields, 'limit' and 'offset' for pagination, and 'sort' to order the results. The response includes the status, data array of EmployeeTeamReference objects, total number of resources, count of received resources, and any related resources. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Employees

  • ID: get_many_employees
  • Operation: read
  • Entities: compensation, employee, department
  • Summary: The 'Get Many Employees' API retrieves a list of employees from the Alexis HR system. It requires a GET request to the endpoint 'https://api.alexishr.com/v1/employee' with an 'Authorization' header containing a Bearer token. The response includes a status and a data array with detailed information about each employee, such as their ID, title, active status, company and office IDs, manager and department IDs, employment details, compensation, and personal information like name, email, phone, and address. The response also includes related entities like offices, cost centers, departments, and more. The API handles various response codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Employment Types

  • ID: get_many_employment_types
  • Operation: read
  • Entities: employment type, country, company
  • Summary: The 'Get Many Employment Types' API allows users to retrieve multiple employment types from the Alexis HR system. It requires an authorization token in the header. Users can specify query parameters such as 'select' to choose specific fields, 'filters' to apply conditions on fields like 'id', 'companyId', 'name', 'vacation', 'country', and 'maxMonths', 'limit' to restrict the number of results, 'offset' for pagination, and 'sort' to order the results. The response includes a status, an array of employment type objects with fields like 'id', 'companyId', 'name', 'vacation', 'country', and 'maxMonths', and metadata such as 'total', 'count', 'offset', and 'relations'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Employments

  • ID: get_many_employments
  • Operation: read
  • Entities: employment, employee, company
  • Summary: The 'Get Many Employments' API retrieves multiple employment records from the Alexis HR system. It requires an authorization token in the header. The API supports various query parameters such as 'select' to specify fields, 'relations' to include related resources, 'filters' to apply conditions, 'limit' and 'offset' for pagination, and 'sort' to order results. The response includes employment data, total count, and related resources. It handles various HTTP status codes for success and error scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Leaves

  • ID: get_many_leaves
  • Operation: read
  • Entities: leave type, leave, employee
  • Summary: The 'Get Many Leaves' API allows users to retrieve multiple leave records from the Alexis HR system. The API supports various query parameters to filter, sort, and select specific fields of the leave records. Users can specify fields to select, related resources to include, and conditions to filter the results. The API also supports pagination through 'limit' and 'offset' parameters. The response includes the status, data with leave details, total number of records, count of records in the current response, and any related resources. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many LeaveTransactions

  • ID: get_many_leavetransactions
  • Operation: read
  • Entities: leave type, employee, leave transaction
  • Summary: The 'Get Many LeaveTransactions' API allows users to retrieve multiple leave transactions from the Alexis HR system. The API supports various query parameters such as 'select' to specify fields, 'relations' to include related resources, 'filters' to apply conditions on fields, 'limit' to restrict the number of results, 'offset' for pagination, and 'sort' to order the results. The response includes the status, data array of leave transactions, total count, and any related resources. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many LeaveTypes

  • ID: get_many_leavetypes
  • Operation: read
  • Entities: leave type, leave type code, company
  • Summary: The 'Get Many LeaveTypes' API retrieves multiple leave types from the Alexis HR system. It supports filtering, sorting, and pagination through query parameters. The API requires an authorization header with a Bearer token. Query parameters include 'select' for specifying fields, 'relations' for related resources, 'filters' for conditional filtering, 'limit' and 'offset' for pagination, and 'sort' for ordering results. The response includes a status, data array of leave types, total count, and optional relations. Each leave type has fields like id, name, kind, minimumDuration, deductible, paid, disabled, and archived. The API handles errors with appropriate status codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Offices

  • ID: get_many_offices
  • Operation: read
  • Entities: office, resource, company
  • Summary: The 'Get Many Offices' API allows users to retrieve multiple office records from the Alexis HR system. The API supports filtering, sorting, and pagination through query parameters. Users can specify which fields to select, apply filters on fields like id, companyId, name, etc., and sort the results by various fields. The response includes the status, a list of office data, total number of resources, count of received resources, and any relations. The API requires an Authorization header with a Bearer token for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Teams

  • ID: get_many_teams
  • Operation: read
  • Entities: team, company
  • Summary: The Get Many Teams API allows users to retrieve multiple team records from the Alexis HR system. Users can specify which fields to select using the 'select' query parameter, apply filters on fields such as 'id', 'companyId', 'name', 'description', 'bgColor', and 'fgColor' using the 'filters' query parameter, limit the number of results with 'limit', offset the results with 'offset', and sort the results using the 'sort' query parameter. The API requires an Authorization header with a Bearer token. The response includes the status, an array of team data, the total number of resources, the count of received resources, and any resource relations.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Timesheet Entries

  • ID: get_many_timesheet_entries
  • Operation: read
  • Entities: timesheet, timesheet entry, employee
  • Summary: The 'Get Many Timesheet Entries' API allows users to retrieve multiple timesheet entries from the Alexis HR system. The API supports various query parameters to filter, sort, and select specific fields of the timesheet entries. Users can specify fields to select, related resources to include, and conditions to filter the entries. The API requires an authorization token in the header. The response includes the status, data of timesheet entries, total count, and any related resources. The API handles various response codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many TimesheetEntryTypes

  • ID: get_many_timesheet_entry_types
  • Operation: read
  • Entities: resource relation, timesheet entry type, filter condition
  • Summary: The 'Get Many TimesheetEntryTypes' API allows users to retrieve multiple timesheet entry types from the Alexis HR system. The API supports various query parameters such as 'select' to specify fields, 'filters' to apply conditions on fields like 'id', 'name', and 'kind', 'limit' to restrict the number of results, 'offset' for pagination, and 'sort' to order the results. The response includes a status string, an array of timesheet entry types with fields 'id', 'name', and 'kind', and metadata like total count, received count, and offset. The API requires an Authorization header with a Bearer token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many Timesheets

  • ID: get_many_timesheets
  • Operation: read
  • Entities: timesheet, approval, employee
  • Summary: The Get Many Timesheets API allows users to retrieve multiple timesheet records from the AlexisHR system. Users can specify which fields to select using the 'select' query parameter, and can also include related resources such as 'approverEmployee' and 'employee' using the 'relations' parameter. The API supports filtering of timesheets based on various fields like 'id', 'status', 'startDate', etc., using the 'filters' parameter. Pagination is supported through 'limit' and 'offset' parameters, and sorting can be done using the 'sort' parameter. The API requires an Authorization header with a Bearer token for access. The response includes the status, data array of timesheets, total count, and any related resources if specified.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Many WorkWeeks

  • ID: get_many_workweeks
  • Operation: read
  • Entities: office, work week, employee
  • Summary: The 'Get Many WorkWeeks' API allows users to retrieve multiple work week records from the Alexis HR system. The API supports various query parameters to filter, sort, and select specific fields or related resources. Users must provide a valid Bearer token in the Authorization header. The response includes detailed information about each work week, including shifts for each day of the week, and can also include related office and employee data if specified. The API returns a status of 'ok' along with the data, total count, and any specified relations. Error responses include status codes and messages for bad requests, unauthorized access, forbidden actions, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Additional Compensation

  • ID: get_one_additional_compensation
  • Operation: read
  • Entities: compensation, employee, company
  • Summary: The 'Get One Additional Compensation' API retrieves details of a specific additional compensation record identified by the resource ID. It requires an authorization token in the header and the resource ID as a path parameter. Optionally, specific fields can be selected using the 'select' query parameter. The response includes the status and detailed data of the additional compensation, including fields like id, companyId, employeeId, userId, name, amount, currencyId, effectiveDate, endDate, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, note, and salaryCode. The API handles various response codes, including 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Bonus Compensation

  • ID: get_one_bonus_compensation
  • Operation: read
  • Entities: bonus compensation, employee, company
  • Summary: The 'Get One Bonus Compensation' API retrieves details of a specific bonus compensation using its unique resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID of the bonus compensation. Optionally, specific fields can be selected using the 'select' query parameter, which accepts an array of strings. The response includes the status and data of the bonus compensation, with fields such as id, companyId, employeeId, userId, name, amount, payoutDate, currencyId, and note. The API handles various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Child

  • ID: get_one_child
  • Operation: read
  • Entities: employee, relation, child
  • Summary: The 'Get One Child' API retrieves details of a specific child resource identified by the 'id' path parameter. The request requires an Authorization header with a Bearer token. Optionally, specific fields of the child resource can be selected using the 'select' query parameter. The API returns a 200 status with the child's details including id, employeeId, name, and birthdate. In case of errors, it returns appropriate status codes and error messages such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Company

  • ID: get_one_company
  • Operation: read
  • Entities: resource, relation, company
  • Summary: The 'Get One Company' API retrieves detailed information about a specific company using its unique resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the company to be retrieved. Optionally, specific fields of the company can be selected using the 'select' query parameter, which accepts an array of strings. The API responds with a status code of 200 and a JSON object containing the company's details, including id, name, orgNumber, billableUsers, vatNumber, phone, email, legalName, logoUrl, backgroundUrl, and offboardDate. In case of errors, appropriate status codes and messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Compensation

  • ID: get_one_compensation
  • Operation: read
  • Entities: compensation, employee, company
  • Summary: The 'Get One Compensation' API retrieves detailed compensation information for a specific resource identified by its ID. The API requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID. Optionally, a 'select' query parameter can be used to specify which fields to retrieve, such as 'id', 'employeeId', 'amount', etc. The API returns a JSON response with a status and data object containing compensation details like 'amount', 'effectiveDate', 'currency', 'payoutDay', and more. In case of errors, it returns appropriate HTTP status codes and error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Cost Center

  • ID: get_one_cost_center
  • Operation: read
  • Entities: resource, cost center, company
  • Summary: The 'Get One Cost Center' API retrieves details of a specific cost center identified by its resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the cost center to be retrieved. Optionally, the query parameter 'select' can be used to specify which fields of the cost center should be returned. The response includes a status and data object containing the cost center details such as 'id', 'companyId', 'code', and 'name'. In case of errors, appropriate HTTP status codes and error messages are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Department

  • ID: get_one_department
  • Operation: read
  • Entities: department, cost center, company
  • Summary: The 'Get One Department' API retrieves details of a specific department using its unique ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the department to retrieve. Optional query parameters 'select' and 'relations' allow filtering of department fields and related resources, respectively. The response includes the department's details and related resources, with various status codes indicating success or specific errors such as 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Employee

  • ID: get_one_employee
  • Operation: read
  • Entities: compensation, employee, department
  • Summary: The 'Get One Employee' API retrieves detailed information about a specific employee using their unique ID. The API requires an authorization token in the header and the employee ID as a path parameter. Optional query parameters allow selection of specific employee fields, related resources, and additional filters, limits, offsets, and sorting options to include in the response. The response includes comprehensive employee data, such as personal details, employment information, and related resources like office, department, and compensation details. The API supports various response codes, including 200 for success and error codes like 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Employee Team Reference

  • ID: get_one_employee_team_reference
  • Operation: read
  • Entities: team, employee, user
  • Summary: The 'Get One Employee Team Reference' API retrieves detailed information about a specific EmployeeTeamReference resource identified by its unique ID. The API requires an authorization token in the header and the resource ID as a path parameter. Optional query parameters allow selection of specific fields and related resources. The response includes the status, data of the EmployeeTeamReference, and optionally related resources such as employee, team, and user details. The API handles various HTTP status codes for successful retrieval, client errors, and server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Employment

  • ID: get_one_employment
  • Operation: read
  • Entities: employment, employee, company
  • Summary: The 'Get One Employment' API retrieves detailed information about a specific employment record identified by the 'id' path parameter. It requires an authorization header with a Bearer token. The API allows optional query parameters 'select' and 'relations' to specify which fields and related resources to include in the response. The response includes the employment data and related resources, if specified. The API returns various status codes, including 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Employment Type

  • ID: get_one_employment_type
  • Operation: read
  • Entities: employment type, country, company
  • Summary: The 'Get One Employment Type' API retrieves details of a specific employment type using its unique ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID. Optionally, you can use the 'select' query parameter to specify which fields to retrieve, such as 'id', 'name', 'country', etc. The response includes a status and data object with details like 'id', 'companyId', 'name', 'vacation', 'country', and 'maxMonths'. Possible response codes include 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Leave

  • ID: get_one_leave
  • Operation: read
  • Entities: leave type, leave, employee
  • Summary: The 'Get One Leave' API retrieves detailed information about a specific leave request identified by its unique ID. The API requires an authorization token in the headers and the leave ID as a path parameter. Optional query parameters allow selection of specific fields and related resources to include in the response. The response includes the status and detailed data of the leave, including employee and leave type information. The API handles various HTTP status codes to indicate success or specific errors such as unauthorized access or resource not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One LeaveTransaction

  • ID: get_one_leavetransaction
  • Operation: read
  • Entities: leave type, employee, leave transaction
  • Summary: The 'Get One LeaveTransaction' API retrieves detailed information about a specific leave transaction identified by its unique ID. The API requires an authorization token in the header and the resource ID as a path parameter. Optional query parameters allow selection of specific fields and related resources. The response includes the status and detailed data of the leave transaction, including its parent, status, leave type, employee, and child details. The response also includes related resources such as child, leave type, and employee details. The API handles various error responses, including 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One LeaveType

  • ID: get_one_leavetype
  • Operation: read
  • Entities: leave type, leave type code, company
  • Summary: The 'Get One LeaveType' API retrieves details of a specific leave type by its ID. It requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID of the leave type. Optional query parameters include 'select' to specify which fields to return and 'relations' to include related resources. The response includes the status and data of the leave type, with fields such as 'id', 'name', 'kind', 'minimumDuration', 'deductible', 'paid', 'disabled', and 'archived'. The 'relations' object may include 'leaveTypeCode' details. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Office

  • ID: get_one_office
  • Operation: read
  • Entities: office, resource, company
  • Summary: The 'Get One Office' API retrieves details of a specific office using its unique resource ID. The API requires an authorization token in the header and the office ID as a path parameter. Optionally, specific fields can be selected using the 'select' query parameter. The response includes the office's details such as id, companyId, name, phone, email, timezone, CFAR, SCB, and SNI. The API returns various status codes including 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 if the office is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Team

  • ID: get_one_team
  • Operation: read
  • Entities: team, relation, company
  • Summary: The 'Get One Team' API retrieves details of a specific team using its unique resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the team to be retrieved. Optionally, specific fields of the team can be selected using the 'select' query parameter, which accepts an array of strings such as 'id', 'companyId', 'name', 'description', 'bgColor', and 'fgColor'. The API responds with a status code of 200 and a JSON object containing the team's details if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the team is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Timesheet

  • ID: get_one_timesheet
  • Operation: read
  • Entities: timesheet, approver employee, employee
  • Summary: The 'Get One Timesheet' API retrieves detailed information about a specific timesheet identified by its unique resource ID. The API requires an authorization token in the header and the timesheet ID as a path parameter. Optional query parameters allow the selection of specific fields and related resources to be included in the response. The response includes the timesheet's status, dates, interval, and related employee information. The API handles various HTTP status codes to indicate success or specific errors such as unauthorized access, forbidden access, resource not found, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One Timesheet Entry

  • ID: get_one_timesheet_entry
  • Operation: read
  • Entities: timesheet, timesheet entry, employee
  • Summary: The 'Get One Timesheet Entry' API retrieves a specific timesheet entry by its ID. It requires an authorization token in the header and the resource ID as a path parameter. Optional query parameters include 'select' to specify which fields to return and 'relations' to include related resources. The response includes the status and detailed data of the timesheet entry, along with any related employee, timesheet, and type information. The API handles various response codes, including 200 for success, and error codes like 400, 401, 403, 404, and 500 for different failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One TimesheetEntryType

  • ID: get_one_timesheetentrytype
  • Operation: read
  • Entities: kind, resource, timesheet entry type
  • Summary: The 'Get One TimesheetEntryType' API retrieves a specific timesheet entry type by its ID. It requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the resource ID to be fetched. Optionally, query parameters can be used to select specific fields of the TimesheetEntryType, such as 'id', 'name', and 'kind'. The API returns a 200 status with the timesheet entry type details if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get One WorkWeek

  • ID: get_one_workweek
  • Operation: read
  • Entities: office, work week, employee
  • Summary: The 'Get One WorkWeek' API retrieves detailed information about a specific work week identified by its unique resource ID. The request requires an authorization header with a Bearer token. The path parameter 'id' is mandatory and specifies the work week to retrieve. Optional query parameters 'select' and 'relations' allow filtering of fields and related resources, respectively. The response includes comprehensive details about the work week, including its schedule for each day, and related office and employee information. The API returns various HTTP status codes to indicate success or specific errors such as unauthorized access or resource not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Additional Compensation

  • ID: patch_update_one_additional_compensation
  • Operation: write
  • Entities: compensation, employee, company
  • Summary: The 'Update One Additional Compensation' API allows users to update the details of an existing additional compensation record. The API requires authorization via a Bearer token and accepts a PATCH request to the specified endpoint with the resource ID as a path parameter. The request body can include optional fields such as name, amount, currencyId, effectiveDate, endDate, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, note, and salaryCode. The response returns the updated resource data with fields like id, companyId, employeeId, userId, name, amount, currencyId, effectiveDate, endDate, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, note, and salaryCode. The API also handles various error responses such as 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Bonus Compensation

  • ID: patch_update_one_bonus_compensation
  • Operation: write
  • Entities: bonus compensation, employee, company
  • Summary: The 'Update One Bonus Compensation' API allows users to update the details of a specific bonus compensation record identified by its resource ID. The API requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The path parameter 'id' is required to specify the resource to be updated. The request body can include optional fields such as 'name', 'amount', 'payoutDate', 'currencyId', and 'note' to update the respective details of the bonus compensation. The API responds with a 200 status code and the updated resource data upon success. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 for not found resources, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Child

  • ID: patch_update_one_child
  • Operation: write
  • Entities: resource, employee, child
  • Summary: The 'Update One Child' API allows users to update the details of a child resource identified by a unique ID. The API requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The path parameter 'id' is required to specify the child resource to be updated. The request body must include the 'name' and 'birthdate' of the child. The API responds with a 200 status code and the updated resource data if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Compensation

  • ID: patch_update_one_compensation
  • Operation: write
  • Entities: compensation, employee, company
  • Summary: The 'Update One Compensation' API allows updating the details of a specific compensation record identified by its ID. The API requires authorization via a Bearer token and accepts a JSON request body with optional fields such as employeeId, userId, amount, currency, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, paidOvertime, note, and salaryCode. The response includes the updated compensation details, including the ID, employeeId, companyId, amount, effectiveDate, baseAmount, exchangeRate, currency, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, paidOvertime, note, and salaryCode. The API handles various response codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Cost Center

  • ID: patch_update_one_cost_center
  • Operation: write
  • Entities: cost center, company
  • Summary: The 'Update One Cost Center' API allows users to update the details of a specific cost center identified by its resource ID. The API requires an authorization token in the headers and accepts a JSON body with optional 'code' and 'name' fields to update the cost center's details. The path parameter 'id' is required to specify the cost center to be updated. The API responds with a 200 status code and the updated resource data if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Department

  • ID: patch_update_one_department
  • Operation: write
  • Entities: department, company
  • Summary: The 'Update One Department' API allows users to update the details of a specific department by providing the department ID in the path parameters. The request requires an authorization header with a Bearer token and a JSON body containing the department's name, and optionally, its description, cost center ID, and parent department ID. The API responds with a 200 status code and the updated department details if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the department is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Employee

  • ID: patch_update_one_employee
  • Operation: write
  • Entities: employee, department, company
  • Summary: The 'Update One Employee' API allows you to update the details of a specific employee identified by their unique ID. The API requires authorization via a Bearer token and accepts a JSON request body containing various employee attributes such as title, office ID, manager ID, department ID, and more. The response includes the updated employee data, confirming the changes made. The API handles various response codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 for not found resources, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One EmployeeTeamReference

  • ID: patch_update_one_employeeteamreference
  • Operation: write
  • Entities: employee team reference, user, team
  • Summary: The 'Update One EmployeeTeamReference' API allows updating the team reference of a specific employee by providing the team ID. The request requires an authorization token and the content type must be set to application/json. The path parameter 'id' is required to specify the resource ID. The request body must include the 'teamId' to update. The API returns a 200 status with the updated resource data on success. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error, each with a specific error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Employment

  • ID: patch_update_one_employment
  • Operation: write
  • Entities: employment, employee, company
  • Summary: The 'Update One Employment' API allows updating the details of a specific employment record identified by its ID. The API requires authorization via a Bearer token and accepts a JSON request body with optional fields such as employeeId, userId, typeId, startDate, endDate, effectiveEndDate, terminated status, rate, note, and country. The country field accepts a wide range of country codes. The response includes a status and the updated employment data. Possible response codes include 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Employment Type

  • ID: patch_update_one_employment_type
  • Operation: write
  • Entities: employment type, country, company
  • Summary: The 'Update One Employment Type' API allows users to update the details of a specific employment type by providing the resource ID in the path parameters. The request requires authorization via a Bearer token and accepts a JSON body with optional fields such as 'name', 'vacation', and 'maxMonths', and a required 'country' field. The response returns a status and the updated resource data if successful, or an error message with a status code if there is an issue with the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Leave

  • ID: patch_update_one_leave
  • Operation: write
  • Entities: leave, approval, employee
  • Summary: The 'Update One Leave' API allows users to update the details of a specific leave request identified by its resource ID. The API requires authorization via a Bearer token and accepts a JSON request body with optional fields such as childId, duration, description, startDate, endDate, morning, afternoon, status, and approvalNote. The extent field is mandatory. The API responds with a 200 status code and the updated leave details if successful. Error responses include 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the resource is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One LeaveType

  • ID: patch_update_one_leavetype
  • Operation: write
  • Entities: leave type, status, message
  • Summary: The 'Update One LeaveType' API allows users to update the details of a specific leave type by providing the resource ID in the path parameters. The request requires an authorization token in the headers and accepts a JSON body with optional fields such as 'name', 'kind', 'minimumDuration', 'deductible', 'paid', 'disabled', and 'archived'. The response returns a status and the updated resource data if successful, or an error message with a status code if there is an issue with the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Office

  • ID: patch_update_one_office
  • Operation: write
  • Entities: office, resource, company
  • Summary: The Update One Office API allows users to update the details of an existing office. The API requires a PATCH request to the endpoint https://api.alexishr.com/v1/office/{id} with the office ID specified in the path parameters. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. The request body can include optional fields such as name, phone, email, timezone, CFAR, SCB, and SNI to update the respective details of the office. The API returns a 200 response with the updated office details if successful. In case of errors, it returns appropriate error messages with status codes such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One Team

  • ID: patch_update_one_team
  • Operation: write
  • Entities: team, resource, company
  • Summary: The 'Update One Team' API allows users to update the details of a specific team identified by its resource ID. The API requires authorization via a Bearer token and accepts a PATCH request to the endpoint 'https://api.alexishr.com/v1/team/{id}'. The path parameter 'id' is required to specify the team to be updated. The request body can include optional fields such as 'name', 'description', 'bgColor', and 'fgColor' to update the team's details. The API returns a 200 status code with the updated team data upon success. In case of errors, it returns appropriate status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 if the team is not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One TimesheetEntry

  • ID: patch_update_one_timesheetentry
  • Operation: write
  • Entities: status, employee, timesheet entry
  • Summary: The 'Update One TimesheetEntry' API allows users to update a specific timesheet entry by providing the resource ID in the path parameters. The request requires authorization via a Bearer token and accepts a JSON body with optional fields such as typeId, employeeId, date, minutes, and note. The API responds with a status and the updated resource data if successful. Error responses include status codes and messages for bad requests, unauthorized access, forbidden actions, not found resources, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update One WorkWeek

  • ID: patch_update_one_workweek
  • Operation: write
  • Entities: work week, shift, company
  • Summary: The 'Update One WorkWeek' API allows updating the details of a specific work week identified by its resource ID. The API requires an authorization token in the headers and accepts a PATCH request to the endpoint with the resource ID as a path parameter. The request body can include an 'effectiveTo' date-time field to specify until when the work week is effective. The response includes a status and detailed resource data, including work week details for each day of the week. The API handles various response codes, including 200 for success, 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Additional Compensation

  • ID: post_create_one_additional_compensation
  • Operation: write
  • Entities: additional compensation, employee, company
  • Summary: This API endpoint allows the creation of an additional compensation for an employee. It requires a POST request to the specified URL with a JSON body containing details such as companyId, employeeId, userId, name, amount, currencyId, effectiveDate, payoutDay, payoutPeriod, payoutFrequency, and optional fields like endDate, salarySchedule, note, and salaryCode. The response includes a status and the created resource data with similar fields. The API requires authorization via a Bearer token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Bonus Compensation

  • ID: post_create_one_bonus_compensation
  • Operation: write
  • Entities: bonus compensation, employee, company
  • Summary: The 'Create One Bonus Compensation' API allows users to create a bonus compensation record for an employee. The request requires a JSON body with fields such as companyId, employeeId, userId, name, amount, payoutDate, and currencyId, all of which are mandatory. An optional note can also be included. The API responds with a status and the created resource data, including the IDs and details of the bonus compensation. The API requires authorization via a Bearer token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Child

  • ID: post_create_one_child
  • Operation: write
  • Entities: employee, child
  • Summary: The 'Create One Child' API allows the creation of a child record associated with an employee. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/child' with a JSON body containing 'employeeId', 'name', and 'birthdate'. The request must include an 'Authorization' header with a Bearer token. On success, it returns a 201 status with the created child's details. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, and 500 Internal Server Error, each with a specific error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Compensation

  • ID: post_create_one_compensation
  • Operation: write
  • Entities: compensation, employee, company
  • Summary: The 'Create One Compensation' API allows the creation of a compensation record for an employee. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/compensation' with a JSON body containing details such as 'employeeId', 'userId', 'amount', 'effectiveDate', 'currency', 'payoutDay', 'payoutPeriod', 'payoutFrequency', and 'paidOvertime'. Optional fields include 'companyId', 'salarySchedule', 'note', and 'salaryCode'. The response includes a status and data object with details of the created compensation. Possible response codes include 201 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Cost Center

  • ID: post_create_one_cost_center
  • Operation: write
  • Entities: cost center, company
  • Summary: The 'Create One Cost Center' API allows users to create a new cost center in the system. The request must include an authorization header with a Bearer token and a JSON body containing the 'code' of the cost center, which is required, and optionally the 'name'. The API responds with a 201 status code and the details of the created cost center if successful. In case of errors, it returns appropriate HTTP status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Department

  • ID: post_create_one_department
  • Operation: write
  • Entities: department, cost center, company
  • Summary: The 'Create One Department' API allows users to create a new department within the system. The request must include an authorization header with a valid JWT token and a content-type header set to 'application/json'. The request body requires a 'name' field for the department, while 'description', 'costCenterId', and 'parentId' are optional fields. Upon successful creation, the API returns a 201 status with the department's details. Error responses include 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Employee

  • ID: post_create_one_employee
  • Operation: write
  • Entities: employee, department, company
  • Summary: The 'Create One Employee' API allows you to create a new employee record in the system. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/employee' with a JSON body containing employee details such as title, office ID, manager employee ID, department ID, cost center ID, username, division, organization, employee number, tax details, work email, work phone, occupational pension status, private email, first name, last name, social security number, private phone, birth date, avatar URL, nationality, gender, pronoun, bank account details, home address, and custom fields. The request must include an 'Authorization' header with a Bearer token and a 'Content-Type' header set to 'application/json'. Upon successful creation, the API returns a 201 status code with a JSON response containing the employee's ID, title, active status, company ID, and other details. In case of errors, appropriate error messages and status codes (400, 401, 403, 500) are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One EmployeeTeamReference

  • ID: post_create_one_employeeteamreference
  • Operation: write
  • Entities: team, employee, company
  • Summary: This API endpoint allows the creation of an EmployeeTeamReference. It requires a POST request to the specified URL with a JSON body containing 'teamId', 'companyId', 'employeeId', and 'userId', all of which are required string fields. The request must include an 'Authorization' header with a Bearer token and a 'Content-Type' header set to 'application/json'. On success, it returns a 201 status with the created resource data. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, and 500 Internal Server Error, each with a specific error message and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Employment

  • ID: post_create_one_employment
  • Operation: write
  • Entities: employment, employee, company
  • Summary: The 'Create One Employment' API allows clients to create a new employment record for an employee. The API requires a POST request to the endpoint 'https://api.alexishr.com/v1/employment' with a JSON body containing details such as 'employeeId', 'userId', 'typeId', 'startDate', 'terminated', 'rate', and 'country'. The 'Authorization' header with a Bearer token is mandatory. The response includes a status and data object with details of the created employment. Possible responses include a 201 status for success, and error statuses 400, 401, 403, and 500 for various failure scenarios.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Employment Type

  • ID: post_create_one_employment_type
  • Operation: write
  • Entities: employment type, country, company
  • Summary: The 'Create One Employment Type' API allows users to create a new employment type in the system. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/employment-type' with a JSON body containing the 'name', 'vacation', and 'country' fields. The 'name' is a string representing the employment type name, 'vacation' is a boolean indicating if vacation is included, and 'country' is a string representing the country code. The 'maxMonths' field is optional and represents the maximum number of months. The request must include an 'Authorization' header with a Bearer token. On success, it returns a 201 status with the created employment type details. Possible error responses include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), and 500 (Internal Server Error).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Leave

  • ID: post_create_one_leave
  • Operation: write
  • Entities: leave, employee, request
  • Summary: The 'Create One Leave' API allows clients to create a leave request for an employee. The request requires an authorization token and a JSON body containing the employeeId, typeId, duration, startDate, and endDate. Optional fields include childId, description, extent, morning, and afternoon. The API responds with a 201 status code and the leave details if successful. Error responses include 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One LeaveType

  • ID: post_create_one_leavetype
  • Operation: write
  • Entities: leave type
  • Summary: The 'Create One LeaveType' API allows users to create a new leave type in the system. The request must include an authorization header with a bearer token and a JSON body with the leave type details such as name, kind, minimum duration, deductible, paid, disabled, and archived status. The response will return a 201 status code with the created leave type details if successful. In case of errors, appropriate status codes and error messages will be returned, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Office

  • ID: post_create_one_office
  • Operation: write
  • Entities: office, company
  • Summary: The 'Create One Office' API allows users to create a new office in the system. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/office' with a JSON body containing the office's name, phone, email, timezone, CFAR, SCB, and SNI. The request must include an 'Authorization' header with a Bearer token. On success, it returns a 201 status with the office details. Possible error responses include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), and 500 (Internal Server Error).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One Team

  • ID: post_create_one_team
  • Operation: write
  • Entities: team, company
  • Summary: The 'Create One Team' API allows users to create a new team by sending a POST request to the specified endpoint. The request must include an authorization header with a Bearer token and a JSON body containing the team's name, background color, and foreground color. The description of the team is optional. Upon successful creation, the API returns a 201 status with the team's details. If there are errors, appropriate error messages and status codes (400, 401, 403, 500) are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One TimesheetEntry

  • ID: post_create_one_timesheetentry
  • Operation: write
  • Entities: status, employee, timesheet entry
  • Summary: The 'Create One TimesheetEntry' API allows the creation of a new timesheet entry for an employee. The request requires a POST method to the endpoint 'https://api.alexishr.com/v1/timesheet-entry'. The request headers must include an 'Authorization' bearer token and 'Content-Type' set to 'application/json'. The request body must contain 'typeId', 'employeeId', 'date', and 'minutes' as required fields, with an optional 'note'. The response will return a 201 status with the created timesheet entry details if successful. Error responses include 400 for bad requests, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create One WorkWeek

  • ID: post_create_one_workweek
  • Operation: write
  • Entities: work week, work shift, employee
  • Summary: The 'Create One WorkWeek' API allows the creation of a work week schedule for an employee. It requires a POST request to the endpoint 'https://api.alexishr.com/v1/work-week' with a JSON body containing details such as 'effectiveFrom', 'timezone', and 'duration'. Each day of the week (Monday to Sunday) must include information on whether it is a working day, the duration of work, and the shifts with start and end times. The request must include an 'Authorization' header with a Bearer token. The response includes the status and data of the created work week, including IDs and detailed work schedules for each day. Possible response codes include 201 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Additional Compensation

  • ID: put_replace_one_additional_compensation
  • Operation: write
  • Entities: additional compensation, employee, company
  • Summary: The 'Replace One Additional Compensation' API allows users to update an existing additional compensation record by providing the resource ID in the path parameters. The request requires authorization via a Bearer token and the content type must be 'application/json'. The request body can include details such as name, amount, currencyId, effectiveDate, endDate, payoutDay, payoutPeriod, payoutFrequency, salarySchedule, note, and salaryCode. The response will return a status and the updated resource data if successful. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Bonus Compensation

  • ID: put_replace_one_bonus_compensation
  • Operation: write
  • Entities: bonus compensation, employee, company
  • Summary: The Replace One Bonus Compensation API allows you to update an existing bonus compensation record by its unique ID. The API requires authorization via a Bearer token and accepts a JSON request body with optional fields such as name, amount, payoutDate, currencyId, and note. The response includes the updated resource data if successful, or an error message if the request fails. The API supports various HTTP status codes to indicate the result of the operation, including 200 for success, 400 for bad request, 401 for unauthorized access, 403 for forbidden access, 404 for not found, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Child

  • ID: put_replace_one_child
  • Operation: write
  • Entities: employee, child
  • Summary: The 'Replace One Child' API allows you to update the details of a child resource identified by a unique ID. The API requires authorization via a Bearer token. The request must include the child's name and birthdate in the body. The response will return the updated child details if successful, or an error message if there is an issue with the request. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Compensation

  • ID: put_replace_one_compensation
  • Operation: write
  • Entities: compensation, employee, company
  • Summary: The Replace One Compensation API allows you to update the compensation details for a specific resource identified by its ID. The API requires authorization via a Bearer token. The request must include the resource ID as a path parameter and can optionally include various compensation details in the request body, such as employee ID, user ID, amount, currency, payout day, payout period, payout frequency, salary schedule, paid overtime status, note, and salary code. The response will return the updated compensation details if successful, or an error message if the request fails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Cost Center

  • ID: put_replace_one_cost_center
  • Operation: write
  • Entities: cost center, company
  • Summary: The Replace One Cost Center API allows you to update the details of a specific cost center identified by its resource ID. The API requires an authorization token in the headers and accepts a JSON body containing the 'code' and 'name' of the cost center. The path parameter 'id' is required to specify which cost center to update. On success, it returns a 200 status with the updated cost center details. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error, each with a specific error message and code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Department

  • ID: put_replace_one_department
  • Operation: write
  • Entities: department, cost center, company
  • Summary: The 'Replace One Department' API allows users to update the details of a specific department identified by its ID. The API requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The path parameter 'id' is required to specify the department to be updated. The request body must include the 'name' of the department, and optionally, 'description', 'costCenterId', and 'parentId'. The API responds with a 200 status code and the updated department details if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Employee

  • ID: put_replace_one_employee
  • Operation: write
  • Entities: bank account, employee, home address
  • Summary: The Replace One Employee API allows you to update the details of an existing employee in the system. It requires a PUT request to the endpoint with the employee's ID as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. The request body can contain various fields such as title, officeId, managerEmployeeId, departmentId, costCenterId, userName, division, organization, employeeNumber, tax details, workEmail, workPhone, and more. The response will return the updated employee details if successful, or an error message if there is an issue with the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One EmployeeTeamReference

  • ID: put_replace_one_employeeteamreference
  • Operation: write
  • Entities: team, employee, company
  • Summary: The 'Replace One EmployeeTeamReference' API allows you to update the team reference for a specific employee by providing the team ID. The API requires a PUT request to the endpoint with the employee's resource ID as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. The request body should contain the new team ID. Upon success, the API returns a 200 status with the updated resource data. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error, each with a corresponding error message and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Employment

  • ID: put_replace_one_employment
  • Operation: write
  • Entities: employment, employee, company
  • Summary: The 'Replace One Employment' API allows you to update an existing employment record in the system. It requires a PUT request to the specified endpoint with the employment ID as a path parameter. The request must include an authorization header with a Bearer token and a JSON body containing the employment details such as employeeId, userId, typeId, startDate, endDate, effectiveEndDate, terminated status, rate, note, and country. The response will return a status of 'ok' and the updated employment data if successful. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Employment Type

  • ID: put_replace_one_employment_type
  • Operation: write
  • Entities: employment type, country, company
  • Summary: The 'Replace One Employment Type' API allows users to update an existing employment type by specifying the resource ID in the path parameters. The request requires an authorization token in the headers and accepts a JSON body with optional fields such as 'name', 'vacation', 'country', and 'maxMonths'. The 'country' field is required and must be one of the specified country codes. The API returns a 200 status with the updated resource data upon success. In case of errors, it returns appropriate HTTP status codes and error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Leave

  • ID: put_replace_one_leave
  • Operation: write
  • Entities: leave, status, employee
  • Summary: The Replace One Leave API allows updating a specific leave record identified by its resource ID. The request requires authorization via a Bearer token and must include the Content-Type header set to application/json. The path parameter 'id' is required to specify the leave record to be updated. The request body can include optional fields such as childId, duration, description, startDate, endDate, morning, afternoon, status, and approvalNote, with 'extent' being a required field. The API responds with a 200 status code and the updated leave data upon success. Error responses include status codes 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), and 500 (Internal Server Error), each with a corresponding error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One LeaveType

  • ID: put_replace_one_leavetype
  • Operation: write
  • Entities: leave type, response, resource
  • Summary: The Replace One LeaveType API allows users to update an existing leave type by specifying its ID in the path parameters. The request requires authorization via a Bearer token and accepts a JSON body with optional fields such as name, kind, minimumDuration, deductible, paid, disabled, and archived. The API returns a 200 status with the updated leave type details upon success. In case of errors, it returns appropriate HTTP status codes and error messages, such as 400 for bad requests, 401 for unauthorized access, 403 for forbidden actions, 404 for not found resources, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Office

  • ID: put_replace_one_office
  • Operation: write
  • Entities: office, resource, company
  • Summary: The Replace One Office API allows you to update the details of an existing office resource identified by its unique ID. The API requires a PUT request to the specified endpoint with the office ID as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/json. The request body can include optional fields such as name, phone, email, timezone, CFAR, SCB, and SNI to update the office details. The API returns a 200 status code with the updated office details in the response body if successful. In case of errors, appropriate HTTP status codes and error messages are returned, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Team

  • ID: put_replace_one_team
  • Operation: write
  • Entities: team, resource, company
  • Summary: The Replace One Team API allows you to update the details of a specific team identified by its resource ID. The API requires authorization via a Bearer token and accepts a JSON request body with optional fields such as name, description, bgColor, and fgColor. The response includes a status and the updated resource data if successful. Error responses include status codes and messages for bad requests, unauthorized access, forbidden actions, not found resources, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One Timesheet Entry

  • ID: put_replace_one_timesheet_entry
  • Operation: write
  • Entities: status, employee, timesheet entry
  • Summary: The Replace One Timesheet Entry API allows you to update an existing timesheet entry by providing the necessary details. The API requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The path parameter 'id' is required to specify the resource ID of the timesheet entry to be updated. The request body can include optional fields such as typeId, employeeId, date, minutes, and note. The API returns a 200 status code with the updated timesheet entry details if successful. In case of errors, it returns appropriate status codes and error messages, such as 400 for Bad Request, 401 for Unauthorized, 403 for Forbidden, 404 for Not Found, and 500 for Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace One WorkWeek

  • ID: put_replace_one_workweek
  • Operation: write
  • Entities: work week, work shift, company
  • Summary: The Replace One WorkWeek API allows you to update the details of a specific work week identified by its resource ID. The API requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The path parameter 'id' is required to specify the work week to be updated. The request body can include an 'effectiveTo' date-time field to specify until when the work week is effective. The API returns a 200 status with the updated work week details if successful. Possible error responses include 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, and 500 Internal Server Error, each with a specific error message and status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Terminate and Replace Employment using Employee ID

  • ID: put_terminate_replace_employment
  • Operation: write
  • Entities:
  • Summary: This configuration involves two steps: first, fetching the employmentId using the 'Get One Employee' API, and then using that employmentId to terminate and replace an employment record using the 'Replace One Employment' API. The process requires a valid authorization token and the employee ID. The final output will include the updated employment details, such as the employment ID, company ID, employee ID, type ID, start and end dates, termination status, rate, note, and country.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago