Kolay IK MCP by usefulapi

Read employees, leave and payroll; create leave, time records and events in Kolay IK.

Sollte ich dies verwenden

Qualität und Sicherheit

A
Qualität der Beschreibung
99%
Vollständigkeit des Schemas
90%
Qualität der Benennung
78%
Risiko der Vergiftung
100%
Übereinstimmung der Berechtigungen
100%
Einhaltung des Protokolls
100%

Befunde (3)

  • LOWTool 'kolayik_get_person_leave_balances' name length outside 3-30 rangein kolayik_get_person_leave_balances
  • LOWTool 'kolayik_list_approval_processes' name length outside 3-30 rangein kolayik_list_approval_processes
  • LOWTool 'kolayik_list_expense_categories' name length outside 3-30 rangein kolayik_list_expense_categories

Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.

Kontextkosten

~6,402Tokens (Tool-Definitionen)
~1.4 KBTypische Antwortgröße
Erhebliche Auswirkung auf die Aufmerksamkeit (5.00% von 128k Kontext)

Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.

Installieren

Installation mit einem Klick

Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:

{
  "mcpServers": {
    "kolay-ik": {
      "url": "https://kolay-ik.usefulapi.io/mcp"
    }
  }
}

Remote-Endpunkte

https://kolay-ik.usefulapi.io/mcpstreamable-http

Was es kann

Tool-Inventar

Tools (30)

🟢 Nur lesen🟡 Schreiben🔴 Löschen⚪ Unbekannt
🟢kolayik_get_me

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_people(status, q, hired_from, hired_to, terminated_from, ...)

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).

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "status": {
      "description": "active (default) or terminated.",
      "type": "string",
      "enum": [
        "active",
        "terminated"
      ]
    },
    "q": {
      "description": "Search text in first and last name (or the national id number).",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "hired_from": {
      "description": "Active people hired on or after this date.",
      "type": "string"
    },
    "hired_to": {
      "description": "Active people hired on or before this date.",
      "type": "string"
    },
    "terminated_from": {
      "description": "Terminated people who left on or after this date.",
      "type": "string"
    },
    "terminated_to": {
      "description": "Terminated people who left on or before this date.",
      "type": "string"
    },
    "page": {
      "description": "Page number, from 1 (default 1).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_person(person_id)

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}.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Person id (from kolayik_list_people)."
    }
  },
  "required": [
    "person_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_person_summary(person_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Person id."
    }
  },
  "required": [
    "person_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_person_leave_balances(person_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Person id."
    }
  },
  "required": [
    "person_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_person_trainings(person_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Person id."
    }
  },
  "required": [
    "person_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_person_fields

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_units

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

Eingabe-Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_approval_processes(search, person_id)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "search": {
      "description": "Name contains this text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "person_id": {
      "description": "Only chains with this person in a step.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_leaves(status, start_date, end_date, person_id, include_inactive_employees, ...)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "status": {
      "description": "waiting, approved, rejected or cancelled.",
      "type": "string",
      "enum": [
        "waiting",
        "approved",
        "rejected",
        "cancelled"
      ]
    },
    "start_date": {
      "description": "Leaves from this date on.",
      "type": "string"
    },
    "end_date": {
      "description": "Leaves up to this date.",
      "type": "string"
    },
    "person_id": {
      "description": "Only this person.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$"
    },
    "include_inactive_employees": {
      "description": "Include people who have left (default false).",
      "type": "boolean"
    },
    "limit": {
      "description": "Results per page, 1-100.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_leave(leave_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "leave_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Leave id (from kolayik_list_leaves)."
    }
  },
  "required": [
    "leave_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_create_leave(person_id, leave_type_id, start_date, end_date, comment, ...)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The employee taking leave."
    },
    "leave_type_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Leave type id (for example from kolayik_get_person_leave_balances)."
    },
    "start_date": {
      "type": "string",
      "description": "Start, yyyy-mm-dd hh:mm:ss."
    },
    "end_date": {
      "type": "string",
      "description": "End, yyyy-mm-dd hh:mm:ss."
    },
    "comment": {
      "description": "Note on the leave record.",
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "replacement_person_id": {
      "description": "Colleague covering during the leave.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$"
    }
  },
  "required": [
    "person_id",
    "leave_type_id",
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_timelogs(person_id, type, status, start_date, end_date, ...)

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).

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "description": "Only this person.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$"
    },
    "type": {
      "description": "work or overtime.",
      "type": "string",
      "enum": [
        "work",
        "overtime"
      ]
    },
    "status": {
      "description": "waiting, approved, rejected or cancelled.",
      "type": "string",
      "enum": [
        "waiting",
        "approved",
        "rejected",
        "cancelled"
      ]
    },
    "start_date": {
      "description": "Records from this date on.",
      "type": "string"
    },
    "end_date": {
      "description": "Records up to this date.",
      "type": "string"
    },
    "sort_type": {
      "description": "Sort by startDate (default) or endDate.",
      "type": "string",
      "enum": [
        "startDate",
        "endDate"
      ]
    },
    "sort_order": {
      "description": "Sort direction (default desc).",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "limit": {
      "description": "Results per page, 1-100.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    },
    "page": {
      "description": "Page number, from 1 (default 1).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_timelog(timelog_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "timelog_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Timelog id (from kolayik_list_timelogs)."
    }
  },
  "required": [
    "timelog_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_create_timelog(person_id, start_date, end_date, type, status, ...)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The employee."
    },
    "start_date": {
      "type": "string",
      "description": "Start, yyyy-mm-dd hh:mm:ss."
    },
    "end_date": {
      "type": "string",
      "description": "End, yyyy-mm-dd hh:mm:ss."
    },
    "type": {
      "description": "work or overtime.",
      "type": "string",
      "enum": [
        "work",
        "overtime"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "waiting",
        "approved",
        "rejected",
        "cancelled"
      ],
      "description": "waiting (goes through the approval process), approved (counts immediately), rejected or cancelled."
    },
    "description": {
      "description": "Note on the record.",
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "person_id",
    "start_date",
    "end_date",
    "status"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_delete_timelog(timelog_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "timelog_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Timelog id to delete."
    }
  },
  "required": [
    "timelog_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_transactions(person_id, type, status, paid, start_date, ...)

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).

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "description": "Only this person.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$"
    },
    "type": {
      "description": "Transaction type.",
      "type": "string",
      "enum": [
        "advancePayment",
        "expense",
        "overtime",
        "bonus",
        "premium",
        "other",
        "otherCut",
        "advance-expense",
        "militaryBenefit",
        "nationalHolidayBenefit",
        "fuelAllowanceBenefit"
      ]
    },
    "status": {
      "description": "draft, waiting, approved or rejected.",
      "type": "string",
      "enum": [
        "draft",
        "waiting",
        "approved",
        "rejected"
      ]
    },
    "paid": {
      "description": "true = only paid, false = only unpaid.",
      "type": "boolean"
    },
    "start_date": {
      "description": "Transactions from this date on.",
      "type": "string"
    },
    "end_date": {
      "description": "Transactions up to this date.",
      "type": "string"
    },
    "limit": {
      "description": "Results per page, 1-100.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    },
    "page": {
      "description": "Page number, from 1 (default 1).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_transaction(transaction_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "transaction_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Transaction id (from kolayik_list_transactions)."
    }
  },
  "required": [
    "transaction_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_expense_categories(title, enabled)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "title": {
      "description": "Category title contains this text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "enabled": {
      "description": "true = only enabled categories, false = only disabled.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_payrolls(year)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "year": {
      "description": "Year (default: the current year).",
      "type": "integer",
      "minimum": 2000,
      "maximum": 2100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_payroll_sheet(payroll_id, search, status, salary_period, unit_item_ids)

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).

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "payroll_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Payroll run id (from kolayik_list_payrolls)."
    },
    "search": {
      "description": "Employee name contains this text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "status": {
      "description": "Calculation statuses (OR).",
      "maxItems": 8,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "ended",
          "started",
          "failed",
          "hasPayslip",
          "isPayslipPublic",
          "changedColumns",
          "activeEmployee",
          "terminatedEmployee"
        ]
      }
    },
    "salary_period": {
      "description": "Salary period types (OR).",
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "monthly",
          "hourly",
          "attendance_fee"
        ]
      }
    },
    "unit_item_ids": {
      "description": "Groups of unit item ids from kolayik_list_units.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "minItems": 1,
        "maxItems": 20,
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[A-Za-z0-9_-]{1,64}$",
          "description": "A Kolay IK id (32-character hex string)."
        }
      }
    }
  },
  "required": [
    "payroll_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_events(search, start, end, limit, page)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "search": {
      "description": "Title contains this text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "start": {
      "description": "Events from this date on.",
      "type": "string"
    },
    "end": {
      "description": "Events up to this date.",
      "type": "string"
    },
    "limit": {
      "description": "Results per page, 1-100.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    },
    "page": {
      "description": "Page number, from 1 (default 1).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_event(event_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Event id (from kolayik_list_events)."
    }
  },
  "required": [
    "event_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_create_event(title, start, end, comment)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Event title."
    },
    "start": {
      "type": "string",
      "description": "Start, yyyy-mm-dd hh:mm:ss."
    },
    "end": {
      "type": "string",
      "description": "End, yyyy-mm-dd hh:mm:ss."
    },
    "comment": {
      "description": "Event description.",
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    }
  },
  "required": [
    "title",
    "start",
    "end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_update_event(event_id, title, start, end, comment)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Event id."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Event title."
    },
    "start": {
      "type": "string",
      "description": "Start, yyyy-mm-dd hh:mm:ss."
    },
    "end": {
      "type": "string",
      "description": "End, yyyy-mm-dd hh:mm:ss."
    },
    "comment": {
      "description": "Event description.",
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    }
  },
  "required": [
    "event_id",
    "title",
    "start",
    "end"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_delete_event(event_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Event id to delete."
    }
  },
  "required": [
    "event_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_list_trainings(search, limit, page)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "search": {
      "description": "Title contains this text.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "limit": {
      "description": "Results per page, 1-100.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    },
    "page": {
      "description": "Page number, from 1 (default 1).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢kolayik_get_training(training_id)

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

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "training_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Training id (from kolayik_list_trainings)."
    }
  },
  "required": [
    "training_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_create_person(first_name, last_name, email, work_email, employment_start_date, ...)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "First name."
    },
    "last_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Last name."
    },
    "email": {
      "description": "Personal email.",
      "type": "string",
      "maxLength": 200,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "work_email": {
      "description": "Work email.",
      "type": "string",
      "maxLength": 200,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "employment_start_date": {
      "description": "First day of employment.",
      "type": "string"
    },
    "birthday": {
      "description": "Date of birth.",
      "type": "string"
    },
    "data_fields": {
      "description": "Extra data fields as {fieldToken, value}.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldToken": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100,
            "description": "Field token from kolayik_list_person_fields (for example `adres`)."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1000
              },
              {
                "type": "null"
              }
            ],
            "description": "The new value; null or an empty string clears it."
          }
        },
        "required": [
          "fieldToken",
          "value"
        ]
      }
    }
  },
  "required": [
    "first_name",
    "last_name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴kolayik_update_person(person_id, first_name, last_name, email, work_email, ...)

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.

Eingabe-Schema

{
  "type": "object",
  "properties": {
    "person_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Person id."
    },
    "first_name": {
      "description": "First name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "last_name": {
      "description": "Last name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "email": {
      "description": "Personal email; null clears it.",
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200,
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "work_email": {
      "description": "Work email; null clears it.",
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200,
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "data_fields": {
      "description": "Data fields as {fieldToken, value}.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fieldToken": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100,
            "description": "Field token from kolayik_list_person_fields (for example `adres`)."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1000
              },
              {
                "type": "null"
              }
            ],
            "description": "The new value; null or an empty string clears it."
          }
        },
        "required": [
          "fieldToken",
          "value"
        ]
      }
    }
  },
  "required": [
    "person_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Community

Diesen Server bewerten

Nachweis

Aktuelle Beobachtungen

verifiziertVersion nicht aufgezeichnet30 Tools