Kolay IK MCP by usefulapi

The Kolay IK user the API token belongs to: id, name, email, work email. A cheap check that the connection works. GET /v2/profile/me.

無需輸入參數。

List employees (id, first and last name), 60 per page. By default only active employees; set status to terminated for people who left. Search by name with q. Filter by hire date (active people) or termination date (terminated people). The reply has total, currentPage and lastPage; request the next page with page. POST /v2/person/list (a read).

Full profile of one employee: contact data, employment dates, contract, units, compensation and custom data fields. National id numbers and bank numbers are removed. GET /v2/person/view/{id}.

Short profile of one employee: name, contact data, current units (company, location, department, position) and manager. GET /v2/person/view-summary/{id}.

Leave entitlement of one employee per leave type: earned, used, carried over and unused days. GET /v2/person/leave-status/{id}.

Trainings assigned to one employee. GET /v2/person/list-trainings/{id}.

The custom data fields a person can have (fieldToken, type, category). Use the fieldToken in kolayik_update_person and kolayik_create_person. GET /v2/person/show-available-data-fields.

無需輸入參數。

The organization tree: unit types (company, branch, department, position ...) and their items with ids. GET /v2/unit/show-unit-tree.

無需輸入參數。

The approval chains configured in the account (leave, expense and similar), with their steps and approvers. Filter by name or by a person in the steps. GET /v2/approval-process/list.

List leave (time off) records, newest data first as the vendor orders them. Filter by status, a date range or one person. Each record has the leave type, dates, person, replacement, status (approved/waiting/rejected) and used days. GET /v2/leave/list.

One leave record with type, dates, return date, comment, person, replacement person, status and used days. GET /v2/leave/view/{id}.

WRITE: records leave for an employee and deducts the used days from their balance. The vendor may approve it immediately, and it is visible to the employee and their manager. Find the leave type id in an existing leave record (kolayik_list_leaves) or the person's balances (kolayik_get_person_leave_balances). Not idempotent: a second call creates a second record. POST /v2/leave/create.

List time records (work hours, overtime) with person, start and end, minutes used, status and type. Filter by person, type, status and date range. The reply has searchCount, totalCount, page and limit. POST /v2/timelog/list (a read).

One time record by id. GET /v2/timelog/view/{id}.

WRITE: adds a time record (work hours or overtime) for an employee. With status approved it counts immediately (overtime may flow into payroll); with waiting it enters the approval process. Not idempotent: a second call creates a second record. POST /v2/timelog/create.

WRITE (destructive): permanently deletes one time record. This cannot be undone. DELETE /v2/timelog/delete/{id}.

List employee transactions (expenses, advance payments, bonuses, overtime pay, deductions) with amount, currency, status, paid flag and items. Filter by person, type, status, paid and date range. POST /v2/transaction/list (a read).

One transaction (expense, advance, bonus ...) with its items. GET /v2/transaction/view/{id}.

Expense categories of the account (for example taxi, meals), optionally filtered by title or enabled state. GET /v2/expense/list-categories.

Payroll runs of a year: id, period, number of employees, payslips created, errors and total employer cost. Needs a token with the payroll:list scope. Use the id with kolayik_get_payroll_sheet. GET /v2/payroll/list.

The full payroll sheet (carsaf bordro) of one payroll run: every employee's gross, net, tax and insurance columns. This is sensitive salary data of all employees (or the filtered ones). Needs a token with the payroll-sheet:view scope. Filter by name, status, salary period, insurance, tax, expense center or units. POST /v2/payroll-sheet/view/{id} (a read).

List company calendar events (meetings, holidays) with title, start, end and comment. Filter by text and date range. The reply has searchCount, totalCount, page and limit. GET /v2/event/list.

One calendar event. GET /v2/event/view/{id}.

WRITE: adds an event to the company calendar, visible to the employees who see it. Not idempotent. POST /v2/event/create.

WRITE: changes the title, times or comment of a calendar event (the vendor requires title, start and end). PUT /v2/event/update/{id}.

WRITE (destructive): permanently deletes one calendar event. This cannot be undone. DELETE /v2/event/delete/{id}.

List the trainings defined in the account. Filter by title text. The reply has searchCount, totalCount, page and limit. GET /v2/training/list.

One training with its details. GET /v2/training/view/{id}.

WRITE: adds a new employee (only first and last name are required). Creates a real HR record that may send the person an invitation, depending on the account settings. Not idempotent: calling it twice creates a duplicate. Further data goes in data_fields (see kolayik_list_person_fields). POST /v2/person/create.

WRITE: changes basic data of one employee; only the fields you pass change. Pass null for an optional field to clear it. Further data goes in data_fields (see kolayik_list_person_fields). Changes the HR record immediately. PUT /v2/person/update.