Ugrás a tartalomhoz

Pulsika API

Kapcsolja össze rendszereit a Pulsikával, hogy olvashassa és frissíthesse a munkavállalói adatokat, az egységeket, a szabadságokat, a teljesítményt, a képzéseket és a cég további adatait. Az API JSON-t használ HTTPS-en keresztül, minden rendszerhez külön kulccsal és minden erőforráshoz külön jogosultságokkal.

Az API az Enterprise csomag része.

Első lépések

  1. A cég tulajdonosaként vagy adminisztrátoraként nyissa meg a Hozzáférés → API-kulcsok oldalt, és válassza az „Új kulcs” lehetőséget.
  2. Nevezze el a kulcsot az azt használó rendszerről. Csak a szükséges olvasási vagy írási jogosultságokat adja meg, és ahol lehet, korlátozza a hozzáférést a rendszer IP-címeire.
  3. Másolja ki a kulcsot: csak egyszer jelenik meg. A Pulsika csak egy ujjlenyomatot tárol róla.
  4. Hívja a cég címét a kulccsal az Authorization fejlécben.

Minden hívás a cég saját címére megy:

https://compania-mea.pulsika.eu/api/v1
curl https://compania-mea.pulsika.eu/api/v1/employees?per_page=10 \
  -H "Authorization: Bearer hq_12_••••••••"

Hitelesítés

A kulcsot az Authorization fejlécben, Bearer tokenként küldje. Egy kulcs csak a saját cége címén működik. Lejárhat, és bármikor felfüggeszthető, újraaktiválható vagy visszavonható; IP-címekre vagy -tartományokra is korlátozható. A módosításokat a kulcsot létrehozó személy nevén rögzíti a rendszer. Ha ez a személy elveszíti az API-kulcsok kezeléséhez szükséges jogosultságot, a kulccsal továbbra is lehet olvasni, de adatot írni már nem.

Authorization: Bearer hq_12_••••••••

Hatókörök

Egy kulcs minden erőforráshoz kaphat olvasási ({resource}:read) és írási ({resource}:write) jogosultságot. Ezek a teljes cég adataira vonatkoznak. Két további hatókör érhető el: a sensitive a bizalmasként megjelölt egyéni mezők olvasásához és írásához, a metrics:write pedig a KPI-értékek üzleti hivatkozások szerinti küldéséhez.

Kérések és válaszok

  • A kérések és a válaszok UTF-8 kódolású JSON-t használnak. Kéréstörzs küldésekor adja meg a Content-Type: application/json fejlécet.
  • A dátumokhoz az ÉÉÉÉ-HH-NN (YYYY-MM-DD), az időbélyegekhez az ISO 8601 formátumot használja. A válaszok UTC-ben vannak, például 2026-05-01T08:00:00Z.
  • Egyetlen rekord {"data": {…}} formában érkezik; egy lista {"data": […], "meta": {page, per_page, total, last_page}, "links": {next, prev}} formában.
  • Listák: page (1-től), per_page (alapértelmezés szerint 25, legfeljebb 100), sort (id, created_at, updated_at; csökkenő sorrendhez mínuszjel elé), updated_since (egy adott időpont után módosított rekordok, szinkronizáláshoz), valamint az egyes erőforrások szűrői.
  • Rekordot POST kéréssel hozhat létre, és PATCH kéréssel frissíthet, csak a módosított mezőket küldve. A DELETE 204-et ad vissza. A nem írható mezőket tartalmazó kéréseket a rendszer elutasítja.
  • Az írási műveletek atomiak: vagy minden módosítás együtt mentésre kerül, vagy egyik sem.
GET https://compania-mea.pulsika.eu/api/v1/employees?status=active&updated_since=2026-05-01T00:00:00Z&page=2

Hibák

A hibák {"error": "<code>", "message": "<text>"} formában érkeznek. Érvénytelen adatok esetén a válasz állapotkódja 422, a részletek pedig az "errors" alatt találhatók minden érintett mezőhöz.

ÁllapotKódJelentés
401invalid_tokenA kulcs hiányzik, ismeretlen, vagy egy másik céghez tartozik.
403token_inactiveA kulcs fel van függesztve, vagy lejárt.
403not_in_planA cég előfizetése nem tartalmazza ezt a fajta kulcsot (automatizálási kulcsok: Professionaltól; a teljes API: Enterprise).
403insufficient_scopeA kulcsból hiányzik a művelethez szükséges hatókör.
403ip_not_allowedA kulcs nem fogad hívásokat erről a címről.
403token_owner_inactiveA kulcsot létrehozó személy már nem kezelhet kulcsokat, ezért a kulccsal olvasni lehet, írni nem.
404—Nincs ilyen erőforrás vagy rekord az Ön cégénél (vagy nem része a csomagjának).
405—Az erőforrás nem kínálja ezt a műveletet.
409in_useA rekordot máshol még használják, ezért nem törölhető.
422—Érvénytelen adatok; semmi sem került mentésre.
429—Túl sok kérés; próbálja újra Retry-After másodperc múlva.

Korlátok

A korlát kulcsonként percenként 120 kérés, IP-címenként 300. Túllépés esetén a válasz állapotkódja 429. A Retry-After fejléc megadja, mennyit kell várni az újabb próbálkozás előtt.

Verziók

A jelenlegi verzió az 1-es (/api/v1). Az új erőforrások, mezők és szűrők ebbe a verzióba kerülnek. A nem kompatibilis változások egy új verzióban jelennek meg, amelyet előre bejelentünk.

Személyes adatok

  • A CNP (román személyi szám) az API-n keresztül nem olvasható és nem írható.
  • A bizalmas egyéni mezők eléréséhez a sensitive hatókör szükséges.
  • A névtelen felmérések eredményei csak összesítésként érhetők el. Nem érhetők el, amíg a válaszok le vannak zárva, vagy túl kevés van belőlük ahhoz, hogy a résztvevők névtelensége megmaradjon.
  • Az API-napló 30 napig őrzi meg a kulcsot, a végpontot, a válasz állapotát és az időtartamot, a kérés és a válasz tartalma nélkül. A legutóbbi hívások a Hozzáférés → API-kulcsok oldalon láthatók.

KPI-értékek küldése

Azok a rendszerek, amelyek csak KPI-értékeket küldenek (eladások, értékelések, darabszámok), azonosítók helyett üzleti hivatkozás alapján is küldhetik őket: POST /api/v1/metrics/{key}/values egy időszakkal és az értékekkel a munkavállalókra (törzsszám szerint), az egységekre vagy az osztályokra (kód szerint). Ehhez a metrics:write hatókör szükséges; a GET /api/v1/metrics felsorolja az értékeket fogadó mutatókat.

POST https://compania-mea.pulsika.eu/api/v1/metrics/sales.actual/values

{
    "period": "2026-09",
    "values": [
        {
            "subject": "CJ01",
            "value": 1234.5
        },
        {
            "subject": "FV0012",
            "value": 980
        }
    ]
}

Szervezet

Földrajzi területek /geo-areas

Az országok, régiók és körzetek fája, amelyekhez az egységek tartoznak; ez határozza meg a területi vezetők hatáskörét is. A nevek az azonos szülő alatti területek között egyediek. A törlés el lesz utasítva, amíg egységek vagy alterületek használják a területet.

Hatókörök: geo_areas:read, geo_areas:write

Végpontok

  • GET /api/v1/geo-areas Lista
  • GET /api/v1/geo-areas/{id} Egy rekord
  • POST /api/v1/geo-areas Létrehozás
  • PATCH /api/v1/geo-areas/{id} Frissítés
  • DELETE /api/v1/geo-areas/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név, az azonos szülőterülethez tartozó területek között egyedi.
level_labelstring | null Ennek a szintnek a megnevezése (ország, régió, körzet).
parent_idinteger | null A terület, amelyen belül elhelyezkedik; legfelső szintű területnél null. Soha nem önmaga vagy valamelyik saját alterülete.
sortinteger | null Sorrend a testvérterületek között.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

parent_idintegerCsak a közvetlenül e terület alatti területek.
rootsbooleantrue: csak a legfelső szintű területek.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/geo-areas

{
    "name": "Nord-Vest",
    "level_label": "regiune",
    "parent_id": 1,
    "sort": 0
}

Példaválasz

{
    "data": {
        "id": 3,
        "name": "Nord-Vest",
        "level_label": "regiune",
        "parent_id": 1,
        "sort": 0,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Egységek /work-units

A cég egységei: üzletek, gyógyszertárak, irodák, szállodák. A törlés el lesz utasítva, amíg személyek, dokumentumok vagy eredmények hivatkoznak az egységre.

Hatókörök: work_units:read, work_units:write

Végpontok

  • GET /api/v1/work-units Lista
  • GET /api/v1/work-units/{id} Egy rekord
  • POST /api/v1/work-units Létrehozás
  • PATCH /api/v1/work-units/{id} Frissítés
  • DELETE /api/v1/work-units/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név, a cégen belül egyedi.
codestring | null Saját kód, a cégen belül egyedi (a KPI-értékek párosításához).
geo_area_idinteger | null A földrajzi terület (régió, ország), amelyhez tartozik.
addressstring | null Utca, házszám.
citystring | nullcsak olvasható Település (romániai egységeknél a hivatalos listából).
countystring | nullcsak olvasható Megye vagy régió.
phonestring | null Telefonszám.
emailstring | null E-mail-cím.
opened_ondate | null Nyitás dátuma.
closed_ondate | null Bezárás dátuma.
is_activeboolean Használatban van-e.
custom_fieldsobject A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

codestringPontos kód (kis- és nagybetűtől függetlenül).
geo_area_idintegerCsak ezen a területen.
is_activebooleantrue vagy false.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/work-units

{
    "name": "Farmacia Verde Centru",
    "code": "CJ01",
    "geo_area_id": 3,
    "address": "Str. Memorandumului 10",
    "opened_on": "2016-03-01",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Példaválasz

{
    "data": {
        "id": 12,
        "name": "Farmacia Verde Centru",
        "code": "CJ01",
        "geo_area_id": 3,
        "address": "Str. Memorandumului 10",
        "city": "Cluj-Napoca",
        "county": "Cluj",
        "phone": null,
        "email": null,
        "opened_on": "2016-03-01",
        "closed_on": "2026-05-01",
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Osztályok /departments

Cégszintű funkciók (Értékesítés, Logisztika…), amelyek egymásba ágyazhatók. A törlés el lesz utasítva, amíg beosztások vagy alosztályok használják az osztályt.

Hatókörök: departments:read, departments:write

Végpontok

  • GET /api/v1/departments Lista
  • GET /api/v1/departments/{id} Egy rekord
  • POST /api/v1/departments Létrehozás
  • PATCH /api/v1/departments/{id} Frissítés
  • DELETE /api/v1/departments/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név, a cégen belül egyedi.
codestring | null Saját kód, a cégen belül egyedi (a KPI-értékek párosításához).
parent_idinteger | null Az osztály, amelyhez tartozik; soha nem önmaga vagy valamelyik saját alosztálya.
is_activeboolean Használatban van-e.
custom_fieldsobject A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

codestringPontos kód (kis- és nagybetűtől függetlenül).
parent_idintegerCsak a közvetlenül ez alatti osztályok.
is_activebooleantrue vagy false.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/departments

{
    "name": "Farmacie",
    "code": "FARM",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Példaválasz

{
    "data": {
        "id": 4,
        "name": "Farmacie",
        "code": "FARM",
        "parent_id": 1,
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Munkakörök /positions

A munkakörök és szintjük (a nagyobb szám magasabb munkakört jelent). A törlés el lesz utasítva, amíg valaki betölti a munkakört.

Hatókörök: positions:read, positions:write

Végpontok

  • GET /api/v1/positions Lista
  • GET /api/v1/positions/{id} Egy rekord
  • POST /api/v1/positions Létrehozás
  • PATCH /api/v1/positions/{id} Frissítés
  • DELETE /api/v1/positions/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név, a cégen belül egyedi.
codestring | null Saját kód, a cégen belül egyedi.
levelintegerkötelező Hierarchiaszint, 0 és 100 között.
descriptiontext | null Leírás.
is_activeboolean Használatban van-e.
custom_fieldsobject A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

codestringPontos kód (kis- és nagybetűtől függetlenül).
is_activebooleantrue vagy false.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/positions

{
    "name": "Farmacist",
    "code": "FA",
    "level": 2,
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Példaválasz

{
    "data": {
        "id": 7,
        "name": "Farmacist",
        "code": "FA",
        "level": 2,
        "description": null,
        "is_active": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Csapatok /teams

Egységeken átnyúló csoportok (egy projekt, egy munkacsoport). A tagok egyenként adhatók hozzá és távolíthatók el az alábbi műveletekkel.

Hatókörök: teams:read, teams:write

Végpontok

  • GET /api/v1/teams Lista
  • GET /api/v1/teams/{id} Egy rekord
  • POST /api/v1/teams Létrehozás
  • PATCH /api/v1/teams/{id} Frissítés
  • DELETE /api/v1/teams/{id} Törlés
  • POST /api/v1/teams/{id}/add-member Munkavállaló hozzáadása a csapathoz (nem változik semmi, ha már tagja). Törzs: {"employee_id": 345}.
  • POST /api/v1/teams/{id}/remove-member Munkavállaló eltávolítása a csapatból. Törzs: {"employee_id": 345}.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név, a cégen belül egyedi.
descriptiontext | null Leírás.
is_activeboolean Használatban van-e.
member_idsarraycsak olvasható A csapat munkavállalói (csak olvasható; az add-member / remove-member művelettel módosítható).
custom_fieldsobject A cég saját mezői, mezőazonosító szerint (lásd: /custom-fields).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

is_activebooleantrue vagy false.
employee_idintegerCsak azok a csapatok, amelyeknek ez a munkavállaló tagja.

/api/v1/teams/{id}/add-member: employee_id (integer) — A hozzáadandó munkavállaló (azonosító a /employees végpontból).

/api/v1/teams/{id}/remove-member: employee_id (integer) — Az eltávolítandó munkavállaló (azonosító a /employees végpontból).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/teams

{
    "name": "Proiect inventar",
    "is_active": true,
    "custom_fields": {
        "12": "XL"
    }
}

Példaválasz

{
    "data": {
        "id": 2,
        "name": "Proiect inventar",
        "description": null,
        "is_active": true,
        "member_ids": [
            345,
            346
        ],
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Egyéni mezők /custom-fields

A mezők, amelyeket a cég a saját rekordjaihoz adott, csak olvasható formában: mit jelent egy rekord custom_fields értékében az egyes azonosító, milyen típusú, és milyen választási lehetőségei vannak. Az érzékeny munkavállalói mezők csak sensitive hatókörű kulcs esetén jelennek meg. A mezőket az alkalmazásban kell meghatározni.

Hatókörök: custom_fields:read

Végpontok

  • GET /api/v1/custom-fields Lista
  • GET /api/v1/custom-fields/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító; a kulcs egy rekord custom_fields értékében.
entityemployee | work_unit | department | position | team | companycsak olvasható A rekord fajtája, amelyhez tartozik.
labelstringcsak olvasható A neve, a kérés nyelvén (Accept-Language).
typetext | textarea | number | date | boolean | select | multiselect | urlcsak olvasható Mit tartalmaz: text, textarea, number, date (Y-m-d), boolean, select, multiselect vagy url.
optionsarray | nullcsak olvasható A select vagy multiselect választási lehetőségei: id és label; a tárolt érték az id.
is_requiredbooleancsak olvasható Kötelező-e értéket megadni.
visibilityreach | sensitivecsak olvasható reach (mindenki, aki látja a munkavállalót) vagy sensitive.
is_activebooleancsak olvasható Használatban van-e.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

entityemployee | work_unit | department | position | team | companyCsak az ilyen fajta rekord mezői.
is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 12,
        "entity": "employee",
        "label": "Mărime uniformă",
        "type": "select",
        "options": [
            {
                "id": "m",
                "label": "M"
            }
        ],
        "is_required": false,
        "visibility": "reach",
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Munkavállalók és idő

Munkavállalók /employees

A cég munkavállalói. Létrehozáskor az első beosztásuk is létrejön; a későbbi áthelyezések a /placements végponton keresztül történnek. A személyi azonosítókat (például a román CNP-t) az API soha nem olvassa és nem írja. A felhasználói fiókokat az alkalmazásban kell létrehozni.

Hatókörök: employees:read, employees:write

Végpontok

  • GET /api/v1/employees Lista
  • GET /api/v1/employees/{id} Egy rekord
  • POST /api/v1/employees Létrehozás
  • PATCH /api/v1/employees/{id} Frissítés
  • DELETE /api/v1/employees/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
employee_numberstring | null Az Ön által adott törzsszám, a cégen belül egyedi (ez alapján párosítjuk a KPI-értékeket).
first_namestringkötelező Utónév.
last_namestringkötelező Vezetéknév.
emailstring | null Munkahelyi e-mail-cím.
phonestring | null Telefonszám.
birth_datedate | null Születési dátum.
hire_datedate | null Belépés dátuma (ezen a napon kezdődik az első beosztás).
termination_datedate | null Kilépés dátuma.
statusactive | inactive | terminated active, inactive vagy terminated.
work_unit_idintegerkötelező A jelenlegi elsődleges beosztás egysége; létrehozáskor kötelező, utána csak olvasható.
department_idinteger | null A jelenlegi elsődleges beosztás osztálya (csak létrehozáskor).
position_idinteger | null A jelenlegi elsődleges beosztás munkaköre (csak létrehozáskor).
has_loginbooleancsak olvasható Be tud-e jelentkezni a személy.
custom_fieldsobject A cég saját mezői, mezőazonosító szerint; a bizalmasak csak a sensitive hatókörrel.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusactive | inactive | terminatedCsak ezzel az állapottal.
work_unit_idintegerJelenleg ebbe az egységbe beosztva.
employee_numberstringPontos törzsszám.
emailstringPontos e-mail-cím.
qstringA név egy része.
hired_sincedateEttől a naptól (Y-m-d) felvettek: új munkatársak.
leaving_sincedateEttől a naptól (Y-m-d) távozók: van kilépési dátumuk.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/employees

{
    "employee_number": "FV0012",
    "first_name": "Ana",
    "last_name": "Popescu",
    "email": "ana.popescu@example.com",
    "hire_date": "2024-02-01",
    "status": "active",
    "work_unit_id": 12,
    "custom_fields": {
        "12": "XL"
    }
}

Példaválasz

{
    "data": {
        "id": 345,
        "employee_number": "FV0012",
        "first_name": "Ana",
        "last_name": "Popescu",
        "email": "ana.popescu@example.com",
        "phone": null,
        "birth_date": "2026-05-01",
        "hire_date": "2024-02-01",
        "termination_date": "2026-05-01",
        "status": "active",
        "work_unit_id": 12,
        "department_id": 1,
        "position_id": 1,
        "has_login": true,
        "custom_fields": {
            "12": "XL"
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Beosztások /placements

Ki hol dolgozik: egység, osztály és munkakör, mettől meddig. Egy új elsődleges beosztás átveszi az előző helyét, amely jelenlegi másodlagos beosztásként megmarad, amíg le nem zárják.

Hatókörök: placements:read, placements:write

Végpontok

  • GET /api/v1/placements Lista
  • GET /api/v1/placements/{id} Egy rekord
  • POST /api/v1/placements Létrehozás
  • DELETE /api/v1/placements/{id} Törlés
  • POST /api/v1/placements/{id}/end Lezárja a beosztást a valid_to napon (a kezdete előtt nem lehet).
  • POST /api/v1/placements/{id}/make-primary A személy elsődleges beosztásává teszi; az addigi elsődleges másodlagos lesz.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
employee_idintegerkötelező A személy.
work_unit_idintegerkötelező Az egység.
department_idinteger | null Az osztály.
position_idinteger | null A munkakör.
is_primaryboolean A személy elsődleges beosztása-e.
valid_fromdatekötelező Első nap.
valid_todate | null Utolsó nap (üres: még érvényes).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

employee_idintegerCsak ennek a személynek a beosztásai.
work_unit_idintegerCsak ebben az egységben.
currentbooleantrue: csak a ma érvényes beosztások.

/api/v1/placements/{id}/end: valid_to (date) — A beosztás utolsó napja (Y-m-d).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/placements

{
    "employee_id": 345,
    "work_unit_id": 12,
    "is_primary": true,
    "valid_from": "2026-03-01"
}

Példaválasz

{
    "data": {
        "id": 901,
        "employee_id": 345,
        "work_unit_id": 12,
        "department_id": 1,
        "position_id": 1,
        "is_primary": true,
        "valid_from": "2026-03-01",
        "valid_to": "2026-05-01",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Távolléttípusok /leave-types

A cég által használt távolléttípusok, ahogyan az alkalmazásban be vannak állítva. Csak olvasható.

Hatókörök: leave_types:read

Végpontok

  • GET /api/v1/leave-types Lista
  • GET /api/v1/leave-types/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
codestring | nullcsak olvasható Rövid kód.
namestringcsak olvasható Név a kérés nyelvén (Accept-Language), ennek hiányában a cég nyelvén.
uses_balancebooleancsak olvasható Éves egyenlegből vonódnak-e le a napok.
default_entitlementnumber | nullcsak olvasható Napok száma egy teljes évnyi munka után.
is_paidbooleancsak olvasható Fizetett távollét.
requires_attachmentbooleancsak olvasható Dokumentumot kell csatolni (az ilyen kérelmeket az alkalmazásban kell benyújtani).
requires_referencebooleancsak olvasható Hivatkozási szám megadása kötelező.
requires_replacementbooleancsak olvasható Helyettesítő kolléga megadása kötelező.
is_activebooleancsak olvasható Igényelhető-e.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 1,
        "code": "CO",
        "name": "Concediu de odihnă",
        "uses_balance": true,
        "default_entitlement": 21,
        "is_paid": true,
        "requires_attachment": true,
        "requires_reference": true,
        "requires_replacement": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Távollétkérelmek /leave-requests

Távollétkérelmek, az alkalmazással azonos szabályok szerint: a rendszer megszámolja a munkanapokat, ellenőrzi az egyenleget és az átfedő kérelmeket, és elindítja a cég jóváhagyási folyamatát. A jóváhagyás és az elutasítás a kérelem folyamatát követi: a kulcsot létrehozó személynek az aktuális lépés jóváhagyójának kell lennie.

Hatókörök: leave_requests:read, leave_requests:write

Végpontok

  • GET /api/v1/leave-requests Lista
  • GET /api/v1/leave-requests/{id} Egy rekord
  • POST /api/v1/leave-requests Létrehozás
  • POST /api/v1/leave-requests/{id}/approve Jóváhagyja az aktuális lépést (a megjegyzés nem kötelező).
  • POST /api/v1/leave-requests/{id}/reject Elutasítja a kérelmet; a megjegyzés (az indoklás) kötelező.
  • POST /api/v1/leave-requests/{id}/cancel Visszavon egy függőben lévő vagy jóváhagyott kérelmet.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
employee_idintegerkötelező A távol lévő személy.
leave_type_idintegerkötelező A távollét típusa.
starts_ondatekötelező Első nap.
ends_ondatekötelező Utolsó nap.
half_startboolean Az első napon csak délután van távol (fél napnak számít).
half_endboolean Az utolsó napon csak délelőtt van távol (fél napnak számít).
daysnumbercsak olvasható Beszámított napok (munkanapok, munkaszüneti napok nélkül; a fél nap 0,5-nek számít).
hoursnumber | null Órában számolt típusnál: az órák, amennyit igénybe vesz (napjainak órái a munkavállaló munkarendje szerint). Létrehozáskor egynapos kérelem egy része.
for_childboolean Beteg gyermek miatt kérve (olyan típusnál, amely erre további egy hetet enged).
statuspending | approved | rejected | cancelledcsak olvasható pending, approved, rejected vagy cancelled.
replacement_employee_idinteger | null A helyettesítő kolléga.
referencestring | null Hivatkozási szám (például orvosi igazolásé).
notetext | null Megjegyzés.
has_certificateyes | no | pending | null Egészségügyi okú távollét: van-e orvosi igazolás (yes / no / pending); csak a sensitive hatókörrel.
certificate_fromdate | null Az igazolás első napja (ahol az ország nyilvántartja).
certificate_untildate | null Az igazolás utolsó napja.
eau_statusnot_retrieved | retrieved | confirmed | nullcsak olvasható Németország: lekérték-e az eAU-t az egészségbiztosítótól.
created_atdatetimecsak olvasható Benyújtva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

employee_idintegerCsak ennek a személynek a kérelmei.
statuspending | approved | rejected | cancelledCsak ezzel az állapottal.
fromdateErre a napra vagy későbbre is kiterjed.
todateErre a napra vagy korábbra is kiterjed.

/api/v1/leave-requests/{id}/approve: comment (text) — Nem kötelező megjegyzés a személynek.

/api/v1/leave-requests/{id}/reject: comment (text) — Az indoklás, amelyet a személy lát (kötelező).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/leave-requests

{
    "employee_id": 345,
    "leave_type_id": 1,
    "starts_on": "2026-07-06",
    "ends_on": "2026-07-10",
    "half_start": false,
    "half_end": false,
    "for_child": false
}

Példaválasz

{
    "data": {
        "id": 77,
        "employee_id": 345,
        "leave_type_id": 1,
        "starts_on": "2026-07-06",
        "ends_on": "2026-07-10",
        "half_start": false,
        "half_end": false,
        "days": 5,
        "hours": 12.5,
        "for_child": false,
        "status": "pending",
        "replacement_employee_id": 1,
        "reference": null,
        "note": null,
        "has_certificate": "yes",
        "certificate_from": "2026-05-01",
        "certificate_until": "2026-05-01",
        "eau_status": "not_retrieved",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Szabadságegyenlegek /leave-balances

Minden személy éves egyenlege minden olyan távolléttípusra, amely napokat számol. Egy év lekérdezése minden aktív személynél megnyitja az egyenleget, időarányosan és az áthozott napokkal, ahogyan az alkalmazás is; a felhasznált, a függőben lévő és a rendelkezésre álló napokat a rendszer számolja. Az éves keret, a korrekció és az áthozott napok módosíthatók – a kulcsot létrehozó személy saját egyenlegénél soha.

Hatókörök: leave_balances:read, leave_balances:write

Végpontok

  • GET /api/v1/leave-balances Lista
  • GET /api/v1/leave-balances/{id} Egy rekord
  • PATCH /api/v1/leave-balances/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
employee_idintegercsak olvasható A személy.
leave_type_idintegercsak olvasható A távolléttípus.
yearintegercsak olvasható Az év.
entitlementnumber Az év napjai (0–365).
adjustmentnumber Hozzáadott vagy levont napok (−365–365).
carried_overnumber Az előző évből áthozott napok.
carried_over_expires_ondate | null Meddig használhatók fel az áthozott napok.
carried_usablenumbercsak olvasható Ma még felhasználható áthozott napok.
earliernumbercsak olvasható Az előző évnél korábbi évekből megmaradt, ma még felhasználható napok.
earlier_expires_ondate | nullcsak olvasható Meddig vehetők ki ezek közül a legrégebbi napok.
usednumbercsak olvasható Kivett napok (jóváhagyva).
pendingnumbercsak olvasható Igényelt, jóváhagyásra váró napok.
availablenumbercsak olvasható Fennmaradó napok.
notestring | null Megjegyzés.
created_atdatetimecsak olvasható Megnyitva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

yearintegerAz év (alapértelmezés: az idei év).
employee_idintegerCsak ez a személy.
leave_type_idintegerCsak ez a távolléttípus.

Példaválasz

{
    "data": {
        "id": 55,
        "employee_id": 345,
        "leave_type_id": 1,
        "year": 2026,
        "entitlement": 21,
        "adjustment": 0,
        "carried_over": 3,
        "carried_over_expires_on": "2026-03-31",
        "carried_usable": 3,
        "earlier": 0,
        "earlier_expires_on": "2026-05-01",
        "used": 5,
        "pending": 2,
        "available": 17,
        "note": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Naptáresemények /calendar-events

A cég naptára. A résztvevők (vagy az egység) értesítést kapnak egy új eseményről, új időpontról vagy új helyszínről. Egy új esemény ismétlődhet: minden alkalom egy sorozat önálló eseménye lesz, amely külön módosítható, lemondható vagy törölhető.

Hatókörök: calendar_events:read, calendar_events:write

Végpontok

  • GET /api/v1/calendar-events Lista
  • GET /api/v1/calendar-events/{id} Egy rekord
  • POST /api/v1/calendar-events Létrehozás
  • PATCH /api/v1/calendar-events/{id} Frissítés
  • DELETE /api/v1/calendar-events/{id} Törlés
  • POST /api/v1/calendar-events/{id}/cancel Lemondja ezt az alkalmat; a résztvevők értesítést kapnak.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
event_type_idinteger | null Eseménytípus.
titlestringkötelező Cím.
descriptiontext | null Leírás (HTML; ugyanúgy megtisztítva, mint az alkalmazásban írt bármely szöveg).
locationstring | null Helyszín.
starts_atdatetimekötelező Kezdés (ISO 8601).
ends_atdatetimekötelező Befejezés (ISO 8601).
all_dayboolean Egész napos.
visibilityeveryone | unit | participantskötelező everyone, unit (az egység munkavállalói) vagy participants.
work_unit_idinteger | null Az egység, unit láthatóság esetén.
participantsarray A meghívott munkavállalók azonosítói.
rsvpboolean Megkérdezi, ki jön el.
recurrenceweekly | biweekly | monthly | yearly | null Csak létrehozáskor: weekly, biweekly, monthly vagy yearly.
recurrence_untildate | null Csak létrehozáskor: a sorozat utolsó napja (legfeljebb két évre előre).
series_idinteger | nullcsak olvasható A sorozat, amelyhez tartozik.
cancelled_atdatetime | nullcsak olvasható Mikor mondták le.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

fromdateEzen a napon vagy később ér véget.
todateEzen a napon vagy korábban kezdődik.
work_unit_idintegerCsak ennek az egységnek az eseményei.
cancelledbooleantrue: csak a lemondottak; false: csak a többi.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/calendar-events

{
    "title": "Inventar trimestrial",
    "description": "<p>Toată echipa.</p>",
    "starts_at": "2026-07-06T15:00:00Z",
    "ends_at": "2026-07-06T17:00:00Z",
    "visibility": "everyone",
    "participants": [
        345,
        346
    ]
}

Példaválasz

{
    "data": {
        "id": 410,
        "event_type_id": 1,
        "title": "Inventar trimestrial",
        "description": "<p>Toată echipa.</p>",
        "location": null,
        "starts_at": "2026-07-06T15:00:00Z",
        "ends_at": "2026-07-06T17:00:00Z",
        "all_day": true,
        "visibility": "everyone",
        "work_unit_id": 1,
        "participants": [
            345,
            346
        ],
        "rsvp": true,
        "recurrence": "weekly",
        "recurrence_until": "2026-05-01",
        "series_id": 1,
        "cancelled_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Teljesítmény

KPI-mutatók /kpi-metrics

Amit a cég mér: az egyes mutatók kulcsa és mértékegysége, hogy kikre vonatkozóan mérik (grain), és milyen gyakran (period). Csak olvasható; a mutatókat az alkalmazásban kell meghatározni. Az API-n keresztül csak olyan mutatókhoz küldhetők értékek, amelyek forrása „api”.

Hatókörök: kpi_metrics:read

Végpontok

  • GET /api/v1/kpi-metrics Lista
  • GET /api/v1/kpi-metrics/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
keystringcsak olvasható A mutató kulcsa, amelyet a képletek és az értékek küldése használ.
labelstringcsak olvasható Név a cég nyelvén.
descriptionstring | nullcsak olvasható Mit mér.
unitcurrency | percent | count | score | days | hours | ratiocsak olvasható Mértékegység: currency, percent, count, score, days, hours vagy ratio.
value_typedecimal | integer | percent | booleancsak olvasható Az érték fajtája: decimal, integer, percent vagy boolean.
grainemployee | team | department | work_unit | geo_area | companycsak olvasható Kire vonatkozóan mérik: employee, team, department, work_unit, geo_area vagy company.
periodday | week | month | quarter | yearcsak olvasható Milyen gyakran: day, week, month, quarter vagy year.
aggregationsum | avg | last | min | max | countcsak olvasható Hogyan összegződnek az értékek egy hosszabb időszakra.
source_typemanual | import | module | derived | api | objective | reviewcsak olvasható Honnan származnak az értékei (manual, import, api, egy modul…).
is_higher_betterbooleancsak olvasható A magasabb érték jobb-e.
is_activebooleancsak olvasható Használatban van-e.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

keystringPontos kulcs (a kis- és nagybetűk nem számítanak).
source_typemanual | import | module | derived | api | objective | reviewCsak az ilyen forrású mutatók.
is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 7,
        "key": "sales.actual",
        "label": "Sales",
        "description": null,
        "unit": "currency",
        "value_type": "decimal",
        "grain": "employee",
        "period": "month",
        "aggregation": "sum",
        "source_type": "api",
        "is_higher_better": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

KPI-értékek /metric-values

Egy mutató értéke egy alanyra egy időszakban. Létrehozáskor a rendszer beírja (vagy lecseréli az adott alanyra és időszakra már meglévő értéket); csak az „api” forrású mutatók fogadnak értékeket. A hiányzó érték (null) azt jelenti: „nincs adat”, soha nem nullát. Sok érték üzleti hivatkozás (törzsszám, egységkód) szerinti küldéséhez használja a POST /metrics/{key}/values végpontot.

Hatókörök: metric_values:read, metric_values:write

Végpontok

  • GET /api/v1/metric-values Lista
  • GET /api/v1/metric-values/{id} Egy rekord
  • POST /api/v1/metric-values Létrehozás

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
metricstringkötelező A mutató kulcsa.
subject_typeemployee | team | department | work_unit | geo_area | companycsak olvasható Az alany fajtája (a mutató grain értéke).
subject_idintegerkötelező Az alany azonosítója (munkavállaló, egység, osztály, terület vagy csapat azonosítója; a cégnél 0).
periodstringkötelező Az időszak kulcsa: 2026-09 (hónap), 2026-W38 (hét), 2026-Q3, 2026, 2026-09-14 (nap).
period_startdatecsak olvasható Az időszak első napja.
period_enddatecsak olvasható Az időszak utolsó napja.
valuescalar | null Az érték számként vagy szövegként („1234.5”, „1.234,5”, „87%”, true/false); nincs adat esetén null. Tizedes karakterláncként tárolva.
sourcemanual | import | module | derived | api | objective | reviewcsak olvasható Honnan származik.
recorded_atdatetimecsak olvasható Mikor írták be.

Szűrők

metricstringCsak ennek a mutatónak az értékei (a kulcsa).
periodstringCsak ez az időszak (a metric szűrővel együtt).
subject_idintegerCsak ez az alany.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/metric-values

{
    "metric": "sales.api",
    "subject_id": 345,
    "period": "2026-09",
    "value": "1234.5"
}

Példaválasz

{
    "data": {
        "id": 5120,
        "metric": "sales.api",
        "subject_type": "employee",
        "subject_id": 345,
        "period": "2026-09",
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "value": "1234.5",
        "source": "api",
        "recorded_at": "2026-05-01T08:00:00Z"
    }
}

KPI-értékelőlapok /kpi-scorecards

A KPI-értékelőlapok és minden változatuk (piszkozat, közzétett, archivált): az összetevők, amelyekből a pontszám áll, a súlyozásuk és a szintek, amelyekbe egy pontszám eshet. Csak olvasható; a KPI-értékelőlapokat az alkalmazásban kell összeállítani, és egy közzétett változat soha nem változik.

Hatókörök: kpi_scorecards:read

Végpontok

  • GET /api/v1/kpi-scorecards Lista
  • GET /api/v1/kpi-scorecards/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Ennek a változatnak az azonosítója.
familystringcsak olvasható A KPI-értékelőlap az összes változatán át.
versionintegercsak olvasható Változatszám.
namestringcsak olvasható Név.
descriptionstring | nullcsak olvasható Leírás.
grainemployee | team | department | work_unit | geo_area | companycsak olvasható Kit értékel.
periodday | week | month | quarter | yearcsak olvasható Milyen gyakran értékel.
statusdraft | published | archivedcsak olvasható draft, published vagy archived.
effective_fromdate | nullcsak olvasható Érvényesség kezdete.
effective_todate | nullcsak olvasható Érvényesség vége.
published_atdatetime | nullcsak olvasható Mikor tették közzé ezt a változatot.
componentsarraycsak olvasható Az összetevői: kulcs, címke, súlyozás (0–1), célérték, megjelenítési formátum, és hogy a munkavállaló látja-e.
levelsarraycsak olvasható A szintjei: név, a szint eléréséhez szükséges legkisebb pontszám, szín.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusdraft | published | archivedCsak az ilyen állapotú változatok.
familystringCsak ennek a KPI-értékelőlapnak a változatai.

Példaválasz

{
    "data": {
        "id": 4,
        "family": "9b2e0c1e-0f0a-4b47-9f3a-2c1d7e8a1b20",
        "version": 2,
        "name": "Pharmacist performance",
        "description": null,
        "grain": "employee",
        "period": "month",
        "status": "published",
        "effective_from": "2026-05-01",
        "effective_to": "2026-05-01",
        "published_at": "2026-05-01T08:00:00Z",
        "components": [
            {
                "key": "sales",
                "label": "Sales achievement",
                "weight": "0.55"
            }
        ],
        "levels": [
            {
                "name": "Good",
                "min_score": "85",
                "color": "#2B6CB0"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

KPI-eredmények /kpi-results

A KPI-értékelőlapok pontszámai: minden alany és időszak aktuális eredménye, az elért szint, valamint az egyes összetevők értéke és pontjai. Az adat nélküli összesítés vagy összetevő null, soha nem nulla. Csak olvasható; az eredmények egy időszak lezárásakor jönnek létre.

Hatókörök: kpi_results:read

Végpontok

  • GET /api/v1/kpi-results Lista
  • GET /api/v1/kpi-results/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
scorecard_idintegercsak olvasható A KPI-értékelőlap változata, amely értékelte.
scorecardstringcsak olvasható A neve.
subject_typeemployee | team | department | work_unit | geo_area | companycsak olvasható Az alany fajtája.
subject_idintegercsak olvasható Az alany azonosítója.
subjectstring | nullcsak olvasható Az alany neve.
perioddatecsak olvasható Az időszak első napja.
totalstring | nullcsak olvasható A pontszám tizedes karakterláncként; null, ha nincs adat.
levelstring | nullcsak olvasható Az elért szint.
level_colorstring | nullcsak olvasható A szint színe.
bonusstring | nullcsak olvasható A bónusz, ha a KPI-értékelőlap számol ilyet.
partsarraycsak olvasható Minden összetevő: kulcs, címke, érték és az általa hozott pontok (tizedes karakterláncok; nincs adat esetén null).
created_atdatetimecsak olvasható Mikor számolták ki.

Szűrők

scorecard_idintegerCsak ez a KPI-értékelőlap-változat.
perioddateAz időszak első napja (Y-m-d).
subject_typeemployee | team | department | work_unit | geo_area | companyCsak ez az alanyfajta.
subject_idintegerCsak ez az alany.

Példaválasz

{
    "data": {
        "id": 9811,
        "scorecard_id": 4,
        "scorecard": "Pharmacist performance",
        "subject_type": "employee",
        "subject_id": 345,
        "subject": "Ana Popescu",
        "period": "2026-09-01",
        "total": "92.40",
        "level": "Good",
        "level_color": "#2B6CB0",
        "bonus": null,
        "parts": [
            {
                "key": "sales",
                "label": "Sales achievement",
                "value": "104.2",
                "points": "57.31"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z"
    }
}

Prioritások /priorities

Merre tart egy időszakban a cég, egy terület, egy egység, egy osztály vagy egy munkatárs, és mely kulcseredmények mérik ezt, mindegyik állásával (haladás százalékban, és hol kellene tartania ma). Csak olvasás, valamint a move művelet a kézzel követett kulcseredményekhez; a KPI-mutatót olvasó kulcseredmény az adataival együtt mozdul. A piszkozatok nem jelennek meg.

Hatókörök: priorities:read, priorities:write

Végpontok

  • GET /api/v1/priorities Lista
  • GET /api/v1/priorities/{id} Egy rekord
  • POST /api/v1/priorities/{id}/move Kézzel követett kulcseredmény mozgatása: új érték egy számnál, elérve vagy sem egy lépésnél, nem kötelező megjegyzéssel.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
parent_idinteger | nullcsak olvasható A prioritás, amelyhez igazodik.
levelcompany | geo_area | work_unit | department | personcsak olvasható company, geo_area, work_unit, department vagy person.
subject_idintegercsak olvasható Kinek szól: a terület, az egység, az osztály vagy a munkatárs (0 a cégnél).
owner_idinteger | nullcsak olvasható A felelős fiók.
titlestringcsak olvasható Mit kell elérni.
descriptiontext | nullcsak olvasható Miért fontos.
period_typemonth | quarter | yearcsak olvasható month, quarter vagy year.
period_startdatecsak olvasható Az időszak első napja.
period_enddatecsak olvasható Utolsó nap.
statusactive | closed | cancelledcsak olvasható active, closed vagy cancelled.
progressnumber | nullcsak olvasható Az állás százalékban (null = még nincs adat).
expectednumbercsak olvasható Hol kellene tartania ma, százalékban.
key_resultsarraycsak olvasható Minden kulcseredmény: típus (manual, milestone, metric), cím, mértékegység, kiinduló és célérték, jelenlegi érték, haladás és az olvasott KPI-mutató.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

levelcompany | geo_area | work_unit | department | personCsak ez a szint.
statusactive | closed | cancelledCsak ez az állapot.
ondateCsak az ezen a napon futó prioritások (Y-m-d).

/api/v1/priorities/{id}/move: key_result_id (integer) — A prioritás kulcseredménye.; value (number) — Az új érték (számos kulcseredmény).; done (boolean) — Elérve vagy sem (egy lépés).; note (string) — Miért mozdult.

Példaválasz

{
    "data": {
        "id": 1,
        "parent_id": 1,
        "level": "company",
        "subject_id": 12,
        "owner_id": 1,
        "title": "text",
        "description": null,
        "period_type": "month",
        "period_start": "2026-05-01",
        "period_end": "2026-05-01",
        "status": "active",
        "progress": "62.5",
        "expected": "48.9",
        "key_results": [
            {
                "id": 7,
                "kind": "manual",
                "title": "Units taking online orders",
                "unit": null,
                "start_value": "0",
                "target_value": "12",
                "current": "7",
                "progress": "58.3",
                "metric_key": null
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Célok /objectives

Egy szabályhoz tartozó célok (például „kiemelt termékek”): az időszakuk, a paramétereik és az egységenkénti célértékek. A szabály és az időszak a létrehozás után nem változtatható. A record művelet rögzíti, mit értek el a személyek vagy az egységek; az értékelés az időszak értékelésekor történik. Egy már értékelt cél nem törölhető.

Hatókörök: objectives:read, objectives:write

Végpontok

  • GET /api/v1/objectives Lista
  • GET /api/v1/objectives/{id} Egy rekord
  • POST /api/v1/objectives Létrehozás
  • PATCH /api/v1/objectives/{id} Frissítés
  • DELETE /api/v1/objectives/{id} Törlés
  • POST /api/v1/objectives/{id}/record Rögzíti, mit értek el az alanyok: a mérőszámaik felülírják a korábban rögzítetteket; az üres mérőszámok törlik azt (ismét nincs adat).

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
rule_idintegerkötelező A szabály, amely értékeli (csak létrehozáskor).
rulestringcsak olvasható A szabály neve.
namestringkötelező Név.
descriptiontext | null Leírás.
periodstringkötelező Az időszak kulcsa a szabály időszakában (csak létrehozáskor), például 2026-09.
period_startdatecsak olvasható Első nap.
period_enddatecsak olvasható Utolsó nap.
paramsobject A szabály paramétereinek értékei, név szerint (a többit figyelmen kívül hagyja); ha elhagyja: a szabály alapértékei.
targetsarray Egységenkénti célértékek: {work_unit_id, target} elemek listája. Ha vannak célértékek, a cél csak ezekre az egységekre vonatkozik.
external_refstring | null Az Ön saját hivatkozása (csak létrehozáskor).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

rule_idintegerCsak ehhez a szabályhoz tartozók.
period_startdateAz időszak első napja (Y-m-d).
external_refstringAz Ön pontos hivatkozása.

/api/v1/objectives/{id}/record: achievements (array) — {subject_id, measures: {mérőszám neve: szám}} elemek listája; az alanyok a szabály szintjén, a célértékkel rendelkező egységekben.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/objectives

{
    "rule_id": 2,
    "name": "Vitamin C 1000",
    "period": "2026-09",
    "params": {
        "bonus": "2"
    },
    "targets": [
        {
            "work_unit_id": 12,
            "target": "30"
        }
    ],
    "external_ref": "CAMP-2026-09"
}

Példaválasz

{
    "data": {
        "id": 31,
        "rule_id": 2,
        "rule": "Focus products",
        "name": "Vitamin C 1000",
        "description": null,
        "period": "2026-09",
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "params": {
            "bonus": "2"
        },
        "targets": [
            {
                "work_unit_id": 12,
                "target": "30"
            }
        ],
        "external_ref": "CAMP-2026-09",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Értékelések /reviews

Az értékelési szempontrendszerek alapján adott értékelések: kit, ki, melyik időszakra értékelt, a pontok és az eredmény, valamint az egyes szempontokra adott válaszok. Csak olvasható; az értékeléseket az alkalmazásban kell elvégezni. A piszkozatok az értékelő folyamatban lévő munkái, és soha nem jelennek meg a listában.

Hatókörök: reviews:read

Végpontok

  • GET /api/v1/reviews Lista
  • GET /api/v1/reviews/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
form_idintegercsak olvasható A szempontrendszer változata.
formstringcsak olvasható A szempontrendszer neve.
employee_idintegercsak olvasható Az értékelt személy.
evaluator_idinteger | nullcsak olvasható Az értékelő felhasználói fiókja.
period_startdatecsak olvasható Az időszak első napja.
period_enddatecsak olvasható Utolsó nap.
statussubmitted | cancelledcsak olvasható submitted vagy cancelled.
total_pointsstring | nullcsak olvasható Elért pontok.
max_pointsstring | nullcsak olvasható Elérhető pontok.
resultstring | nullcsak olvasható Az eredmény (pontok, vagy százalék, ha a szempontrendszer azt ad).
commenttext | nullcsak olvasható Az értékelő megjegyzése, egyszerű szövegként.
submitted_atdatetime | nullcsak olvasható Mikor nyújtották be.
cancelled_atdatetime | nullcsak olvasható Mikor vonták vissza.
answersarraycsak olvasható Minden szempont: kulcs, a választott lehetőségek, egy érték, a pontjai és egy megjegyzés.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statussubmitted | cancelledsubmitted vagy cancelled.
employee_idintegerCsak ez a személy.
form_idintegerCsak ez a szempontrendszer-változat.
period_startdateAz időszak első napja (Y-m-d).

Példaválasz

{
    "data": {
        "id": 812,
        "form_id": 3,
        "form": "Monthly evaluation",
        "employee_id": 345,
        "evaluator_id": 12,
        "period_start": "2026-09-01",
        "period_end": "2026-09-30",
        "status": "submitted",
        "total_points": "8.00",
        "max_points": "10.00",
        "result": "80",
        "comment": null,
        "submitted_at": "2026-05-01T08:00:00Z",
        "cancelled_at": "2026-05-01T08:00:00Z",
        "answers": [
            {
                "criterion_key": "attitude",
                "selected": [
                    "teamwork"
                ],
                "value": null,
                "points": "2.00",
                "comment": null
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Versenyek

Versenyek /contests

A vállalat elindított versenyei (a piszkozatok nem jelennek meg): mit mérünk, ki versenyez, mely időszakokon és hogyan lehet nyerni. Csak olvasható — a versenyeket az alkalmazásban hozzák létre és vezetik.

Hatókörök: contests:read

Végpontok

  • GET /api/v1/contests Lista
  • GET /api/v1/contests/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név (a vállalat nyelvén).
descriptiontext | nullcsak olvasható Leírás.
statusscheduled | running | closing | to_confirm | final | cancelledcsak olvasható scheduled, running, closing (napok a késve érkező adatokra), to_confirm, final vagy cancelled.
grainemployee | team | work_unit | department | geo_areacsak olvasható Ki versenyez: employee, team, work_unit, department vagy geo_area.
period_typeweek | month | quartercsak olvasható week, month vagy quarter.
start_keystringcsak olvasható Az első időszak (2026-11, 2026-W45, 2026-Q1).
period_countintegercsak olvasható Hány egymást követő időszak.
starts_ondatecsak olvasható Első nap.
ends_ondatecsak olvasható Utolsó nap.
criterion_kindmetric | formula | scorecardcsak olvasható Mit mérünk: metric, formula vagy scorecard.
modethreshold | rankcsak olvasható threshold (mindenki nyer, aki eléri a célt) vagy rank (az első helyezések nyernek).
measurevalue | improvement_pct | improvement_abscsak olvasható value, improvement_pct vagy improvement_abs.
visibilityleaders | own | hiddencsak olvasható Mit látnak a résztvevők közben: leaders, own vagy hidden.
sponsor_idinteger | nullcsak olvasható A fő szponzor (lásd /merch-partners), ha van.
launched_atdatetimecsak olvasható Elindítva.
confirmed_atdatetime | nullcsak olvasható Mikor hagyták jóvá az eredményeket.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusstringCsak ezzel az állapottal.

Példaválasz

{
    "data": {
        "id": 4,
        "name": "Store of the month",
        "description": null,
        "status": "running",
        "grain": "work_unit",
        "period_type": "month",
        "start_key": "2026-11",
        "period_count": 1,
        "starts_on": "2026-05-01",
        "ends_on": "2026-05-01",
        "criterion_kind": "metric",
        "mode": "rank",
        "measure": "value",
        "visibility": "leaders",
        "sponsor_id": 3,
        "launched_at": "2026-05-01T08:00:00Z",
        "confirmed_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Versenyeredmények /contest-results

A jóváhagyott eredmények, résztvevőnként egy — a jóváhagyás után nem változnak. A NULL azt jelenti: nincs adat, sosem nulla. Egy személy eredményét API-n keresztüli olvasásként naplózzuk.

Hatókörök: contest_results:read

Végpontok

  • GET /api/v1/contest-results Lista
  • GET /api/v1/contest-results/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
contest_idintegercsak olvasható A verseny.
subject_typeemployee | team | work_unit | department | geo_areacsak olvasható employee, team, work_unit, department vagy geo_area.
subject_idinteger | nullcsak olvasható A résztvevő (anonimizálás után üres).
valuenumber | nullcsak olvasható A szempont értéke a versenyben.
baselinenumber | nullcsak olvasható A korábbi időszakok átlaga (fejlődési versenyek).
measurenumber | nullcsak olvasható Mit vetettünk össze: az értéket vagy a fejlődést.
placeinteger | nullcsak olvasható A helyezés (holtverseny esetén közös).
tier_keystring | nullcsak olvasható Az elért szint (szintes versenyek).
winsbooleancsak olvasható Nyert-e.
eligiblebooleancsak olvasható Jogosult volt-e.
ineligible_reasonstring | nullcsak olvasható Miért nem: excluded, inactive, not_placed, not_present, not_employed_long_enough, no_data vagy no_baseline.
period_keysarraycsak olvasható A verseny időszakai.
confirmed_atdatetimecsak olvasható Jóváhagyva.

Szűrők

contest_idintegerCsak ennek a versenynek.
winsbooleantrue: csak a nyertesek.

Példaválasz

{
    "data": {
        "id": 120,
        "contest_id": 4,
        "subject_type": "work_unit",
        "subject_id": 12,
        "value": 1240.5,
        "baseline": 12.5,
        "measure": 1240.5,
        "place": 1,
        "tier_key": null,
        "wins": true,
        "eligible": true,
        "ineligible_reason": null,
        "period_keys": [
            "2026-11"
        ],
        "confirmed_at": "2026-05-01T08:00:00Z"
    }
}

Versenynyeremények /contest-awards

A megnyert nyeremények, címzettenként egy. Egy bónusz összege csak a sensitive hatókörrel; adóról semmi. A deliver művelet átadottként jelöli a nyereményt, a kulcs létrehozójának nevében (akinek az alkalmazásban át kell tudnia adni nyereményeket).

Hatókörök: contest_awards:read, contest_awards:write

Végpontok

  • GET /api/v1/contest-awards Lista
  • GET /api/v1/contest-awards/{id} Egy rekord
  • POST /api/v1/contest-awards/{id}/deliver A nyeremény átadottként jelölése.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
contest_idintegercsak olvasható A verseny.
reward_idintegercsak olvasható A nyeremény (lásd /contest-rewards).
employee_idinteger | nullcsak olvasható Ki kapja (anonimizálás után üres).
subject_typestringcsak olvasható Mi nyert: a személy, vagy a csapata, egysége, osztálya, régiója.
subject_idinteger | nullcsak olvasható A nyertes résztvevő.
quantityintegercsak olvasható Mennyiség.
valuenumber | nullcsak olvasható Tájékoztató érték a nyeréskor.
amountnumber | nullcsak olvasható sensitive hatókörEgy bónusz összege (csak a sensitive hatókörrel).
currencystring | nullcsak olvasható Az érték vagy az összeg pénzneme.
daysnumber | nullcsak olvasható Egy szabadnap napjai.
statuspending | ready | delivered | acknowledged | declined | revokedcsak olvasható pending, ready, delivered, acknowledged, declined vagy revoked.
sponsor_may_knowbooleancsak olvasható Hozzájárult-e a nyertes, hogy a szponzor megtudja.
delivered_atdatetime | nullcsak olvasható Átadva.
acknowledged_atdatetime | nullcsak olvasható Átvéve, a nyertes megerősítette.
created_atdatetimecsak olvasható Létrehozva.

Szűrők

contest_idintegerCsak ennek a versenynek.
employee_idintegerCsak ennek a személynek.
statusstringCsak ezzel az állapottal.

Példaválasz

{
    "data": {
        "id": 55,
        "contest_id": 4,
        "reward_id": 7,
        "employee_id": 31,
        "subject_type": "employee",
        "subject_id": 31,
        "quantity": 1,
        "value": 150,
        "amount": 250,
        "currency": "RON",
        "days": 12.5,
        "status": "pending",
        "sponsor_may_know": false,
        "delivered_at": "2026-05-01T08:00:00Z",
        "acknowledged_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z"
    }
}

Nyereménykatalógus /contest-rewards

Amit a versenyek kioszthatnak: termékek, utalványok, bónuszok, szabadnapok, élmények vagy csak elismerés. Minden típus csak azt tartja meg, amit használ (a bónusz értéke az összege; az elismerésnek nincs értéke és készlete). A kulcs létrehozójának nevében íródik, akinek az alkalmazásban kezelnie kell a nyereményeket.

Hatókörök: contest_rewards:read, contest_rewards:write

Végpontok

  • GET /api/v1/contest-rewards Lista
  • GET /api/v1/contest-rewards/{id} Egy rekord
  • POST /api/v1/contest-rewards Létrehozás
  • PATCH /api/v1/contest-rewards/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
kindproduct | voucher | bonus | day_off | experience | recognitionkötelező product, voucher, bonus, day_off, experience vagy recognition.
namestringkötelező Megnevezés.
descriptiontext | null Leírás.
sponsor_idinteger | null A szponzor, aki adja (lásd /merch-partners); üres: a vállalat.
valuenumber | null Tájékoztató érték.
currencystring | null Az érték vagy az összeg pénzneme.
amountnumber | null sensitive hatókörEgy bónusz összege (csak a sensitive hatókörrel).
leave_type_idinteger | null Szabadnap: a szabadságtípus, amelynek keretéhez a napok adódnak.
daysnumber | null Szabadnap: egész vagy fél napok.
stockinteger | null Hány darab van; üres: korlátlan.
availableinteger | nullcsak olvasható Mennyi ígérhető még meg (csak olvasható).
is_activeboolean Kínálhatják-e új versenyek.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

kindstringCsak ebből a típusból.
is_activebooleantrue: csak az aktívak.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/contest-rewards

{
    "kind": "voucher",
    "name": "Book voucher",
    "sponsor_id": 3,
    "value": 150,
    "currency": "RON",
    "amount": 250,
    "stock": 10,
    "is_active": true
}

Példaválasz

{
    "data": {
        "id": 7,
        "kind": "voucher",
        "name": "Book voucher",
        "description": null,
        "sponsor_id": 3,
        "value": 150,
        "currency": "RON",
        "amount": 250,
        "leave_type_id": 1,
        "days": 12.5,
        "stock": 10,
        "available": 8,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Képzés, ellenőrzések és munkavédelem

Tanfolyamok /courses

A tanfolyamkatalógus. A cím és a leírás a cég nyelvén készül (a többi nyelvre az alkalmazásban fordítható); a fejezetek és a borítóképek az alkalmazásban készülnek. Egy tanfolyam csak addig törölhető, amíg még senkinek sem osztották ki – egyébként archiválja.

Hatókörök: courses:read, courses:write

Végpontok

  • GET /api/v1/courses Lista
  • GET /api/v1/courses/{id} Egy rekord
  • POST /api/v1/courses Létrehozás
  • PATCH /api/v1/courses/{id} Frissítés
  • DELETE /api/v1/courses/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
titlestringkötelező Cím.
descriptiontext | null Rövid leírás, egyszerű szöveg.
category_idinteger | null Kategória.
categorystring | nullcsak olvasható A kategória neve.
authorstring | null Szerző.
statusdraft | published | archivedkötelező draft, published vagy archived; csak közzétett tanfolyam osztható ki.
estimated_minutesinteger | null Becsült időtartam percben.
validity_monthsinteger | null Hány hónapig érvényes a tanúsítvány; üres: nem jár le.
issues_certificateboolean Kiállít-e tanúsítványt a teljesítéskor.
recertifiesboolean Újra beiratkoztatja-e a személyeket a tanúsítvány lejárta előtt.
pointsintegerkötelező A teljesítésért járó pontok.
chapters_countintegercsak olvasható Fejezetek száma.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusdraft | published | archivedCsak ezzel az állapottal.
category_idintegerCsak ebben a kategóriában.
qstringA cím egy része.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/courses

{
    "title": "Siguranța la incendiu",
    "status": "published",
    "estimated_minutes": 20,
    "validity_months": 12,
    "issues_certificate": true,
    "recertifies": false,
    "points": 10
}

Példaválasz

{
    "data": {
        "id": 7,
        "title": "Siguranța la incendiu",
        "description": null,
        "category_id": 1,
        "category": "Obligatorii",
        "author": null,
        "status": "published",
        "estimated_minutes": 20,
        "validity_months": 12,
        "issues_certificate": true,
        "recertifies": false,
        "points": 10,
        "chapters_count": 4,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Képzési kiosztások /learning-assignments

Egy közzétett tanfolyam (vagy önálló teszt), amelyet személyeknek osztanak ki: mindenkinek, egy egységnek, egy területnek, egy osztálynak, egy munkakörnek vagy megnevezett munkavállalóknak. A személyek beiratkozása azonnal megtörténik. Csak addig törölhető, amíg senki sem kezdte el.

Hatókörök: learning_assignments:read, learning_assignments:write

Végpontok

  • GET /api/v1/learning-assignments Lista
  • GET /api/v1/learning-assignments/{id} Egy rekord
  • POST /api/v1/learning-assignments Létrehozás
  • DELETE /api/v1/learning-assignments/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
course_idinteger | null A tanfolyam (vagy test_id).
test_idinteger | null Önálló teszt (vagy course_id).
available_fromdatekötelező Mikortól végezhető el.
due_ondate | null Határidő.
enrolls_newcomersboolean Automatikusan beiratkoztatja-e azokat, akik később megfelelnek a célcsoportnak.
targetsarraykötelező Kiknek: {type, id} elemek listája; a type értéke all, employee, position, work_unit, department vagy geo_area (all esetén az id üres).
enrollments_countintegercsak olvasható Beiratkozott személyek.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

course_idintegerCsak ehhez a tanfolyamhoz.
test_idintegerCsak ehhez a teszthez.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/learning-assignments

{
    "course_id": 7,
    "available_from": "2026-05-01",
    "due_on": "2026-05-31",
    "enrolls_newcomers": true,
    "targets": [
        {
            "type": "work_unit",
            "id": 12
        }
    ]
}

Példaválasz

{
    "data": {
        "id": 31,
        "course_id": 7,
        "test_id": 1,
        "available_from": "2026-05-01",
        "due_on": "2026-05-31",
        "enrolls_newcomers": true,
        "targets": [
            {
                "type": "work_unit",
                "id": 12
            }
        ],
        "enrollments_count": 14,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Beiratkozások /enrollments

Ki melyik tanfolyamra vagy tesztre van beiratkozva, és meddig jutott. Műveletek: későbbi határidő, még egy próbálkozás, felmentés valakinek, aki még nem kezdte el.

Hatókörök: enrollments:read, enrollments:write

Végpontok

  • GET /api/v1/enrollments Lista
  • GET /api/v1/enrollments/{id} Egy rekord
  • POST /api/v1/enrollments/{id}/extend Későbbi határidő megadása.
  • POST /api/v1/enrollments/{id}/grant-attempt Még egy tesztpróbálkozás engedélyezése (sikeres teszt után nem).
  • POST /api/v1/enrollments/{id}/excuse A személy felmentése (csak mielőtt elkezdi).

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
assignment_idinteger | nullcsak olvasható A kiosztás, amelyből származik.
employee_idintegercsak olvasható A személy.
course_idinteger | nullcsak olvasható A tanfolyam.
test_idinteger | nullcsak olvasható A teszt.
available_fromdate | nullcsak olvasható Elérhető ettől.
due_ondate | nullcsak olvasható Határidő.
statusassigned | in_progress | awaiting_grading | completed | failed | excusedcsak olvasható assigned, in_progress, awaiting_grading, completed, failed vagy excused.
started_atdatetime | nullcsak olvasható Elkezdve.
completed_atdatetime | nullcsak olvasható Befejezve.
scorenumber | nullcsak olvasható Teszteredmény (%).
passedboolean | nullcsak olvasható Sikeres volt-e a teszt.
extra_attemptsintegercsak olvasható Engedélyezett további próbálkozások.
is_overduebooleancsak olvasható Lejárt a határideje, és nincs befejezve.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

employee_idintegerCsak ez a személy.
course_idintegerCsak ez a tanfolyam.
test_idintegerCsak ez a teszt.
assignment_idintegerCsak ez a kiosztás.
statusassigned | in_progress | awaiting_grading | completed | failed | excusedCsak ezzel az állapottal.
completed_sincedateEttől a naptól (Y-m-d) teljesítettek.

/api/v1/enrollments/{id}/extend: due_on (date) — Az új határidő, nem lehet korábbi a beiratkozás megnyílásánál.

Példaválasz

{
    "data": {
        "id": 501,
        "assignment_id": 31,
        "employee_id": 345,
        "course_id": 7,
        "test_id": 1,
        "available_from": "2026-05-01",
        "due_on": "2026-05-31",
        "status": "completed",
        "started_at": "2026-05-01T08:00:00Z",
        "completed_at": "2026-05-01T08:00:00Z",
        "score": 90,
        "passed": true,
        "extra_attempts": 0,
        "is_overdue": false,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Tanúsítványok /certificates

Egy tanfolyam teljesítésével szerzett tanúsítványok, azzal a kóddal, amelyet bárki ellenőrizhet a tanúsítvány oldalán.

Hatókörök: certificates:read

Végpontok

  • GET /api/v1/certificates Lista
  • GET /api/v1/certificates/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
enrollment_idintegercsak olvasható A beiratkozás, amellyel megszerezték.
employee_idintegercsak olvasható A személy.
course_idintegercsak olvasható A tanfolyam.
numberstringcsak olvasható Tanúsítványszám.
verification_codestringcsak olvasható A nyilvános ellenőrzőkód.
issued_ondatecsak olvasható Kiállítás dátuma.
expires_ondate | nullcsak olvasható Érvényes eddig; üres: nem jár le.
is_validbooleancsak olvasható Ma érvényes.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

employee_idintegerCsak ez a személy.
course_idintegerCsak ez a tanfolyam.
issued_sincedateEttől a naptól (Y-m-d) kiállítottak.

Példaválasz

{
    "data": {
        "id": 88,
        "enrollment_id": 501,
        "employee_id": 345,
        "course_id": 7,
        "number": "FV-2026-0042",
        "verification_code": "K7Q2M9XA",
        "issued_on": "2026-05-12",
        "expires_on": "2027-05-12",
        "is_valid": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ellenőrzések /audits

Az egységek ellenőrzései a megállapításaikkal, tételenként. Csak olvasható: az ellenőrzést az alkalmazásban kell elvégezni.

Hatókörök: audits:read

Végpontok

  • GET /api/v1/audits Lista
  • GET /api/v1/audits/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
work_unit_idintegercsak olvasható Az ellenőrzött egység.
template_namestringcsak olvasható A használt ellenőrzőlista.
auditor_idinteger | nullcsak olvasható Ki végezte (felhasználó).
statusdraft | completedcsak olvasható draft vagy completed.
conducted_atdatetime | nullcsak olvasható Mikor zajlott.
completed_atdatetime | nullcsak olvasható Mikor zárult le.
scorenumber | nullcsak olvasható Pontszám (%).
pass_scorenumber | nullcsak olvasható Megfelelési határ (%).
passedboolean | nullcsak olvasható Megfelelt (csak lezárt ellenőrzéseknél).
critical_findingsintegercsak olvasható Nem teljesült kritikus tételek.
is_self_checkbooleancsak olvasható Olyan személy végezte, aki az egységben dolgozik vagy azt vezeti (nem számít bele az ellenőrzési KPI-kba).
notetext | nullcsak olvasható Megjegyzések.
findingsarraycsak olvasható Minden tétel: {id, section, item, weight, critical, result (ok, not_ok, na), comment}.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

work_unit_idintegerCsak ez az egység.
statusdraft | completedCsak ezzel az állapottal.
conducted_fromdateEzen a napon vagy később végezték.
conducted_todateEzen a napon vagy korábban végezték.

Példaválasz

{
    "data": {
        "id": 19,
        "work_unit_id": 12,
        "template_name": "Verificare lunară farmacie",
        "auditor_id": 1,
        "status": "completed",
        "conducted_at": "2026-05-01T08:00:00Z",
        "completed_at": "2026-05-01T08:00:00Z",
        "score": 88.89,
        "pass_score": 80,
        "passed": true,
        "critical_findings": 0,
        "is_self_check": true,
        "note": null,
        "findings": [
            {
                "section": "Frigider",
                "item": "Termometrul este calibrat",
                "weight": 2,
                "critical": true,
                "result": "not_ok",
                "comment": "Ultima calibrare în martie."
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ellenőrzési intézkedési tervek /audit-action-plans

Ellenőrzések után előírt javító intézkedések. Ugyanúgy haladnak, mint az ellenőrzés oldalán: megjegyzéssel elvégzettnek jelölik, igazolják, indoklással újranyitják vagy visszavonják őket.

Hatókörök: audit_action_plans:read, audit_action_plans:write

Végpontok

  • GET /api/v1/audit-action-plans Lista
  • GET /api/v1/audit-action-plans/{id} Egy rekord
  • POST /api/v1/audit-action-plans/{id}/mark-done Nyitott intézkedés elvégzettnek jelölése.
  • POST /api/v1/audit-action-plans/{id}/verify Elvégzett intézkedés elfogadása.
  • POST /api/v1/audit-action-plans/{id}/reopen Elvégzett intézkedés visszaküldése, indoklással.
  • POST /api/v1/audit-action-plans/{id}/cancel Nyitott vagy elvégzett intézkedés visszavonása.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
audit_idintegercsak olvasható Az ellenőrzés.
result_idinteger | nullcsak olvasható A megállapítás, amelyre válaszol.
descriptiontextcsak olvasható Mit kell elvégezni.
responsible_idinteger | nullcsak olvasható Kinek kell elvégeznie (felhasználó).
due_ondatecsak olvasható Határidő.
statusopen | done | verified | cancelledcsak olvasható open, done, verified vagy cancelled.
is_overduebooleancsak olvasható Nyitott, és lejárt a határideje.
done_notetext | nullcsak olvasható Mit végeztek el (és miért nyitották újra).
done_atdatetime | nullcsak olvasható Elvégzettnek jelölve.
verified_byinteger | nullcsak olvasható Ki igazolta (felhasználó).
verified_atdatetime | nullcsak olvasható Igazolva.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

audit_idintegerCsak ehhez az ellenőrzéshez.
statusopen | done | verified | cancelledCsak ezzel az állapottal.
responsible_idintegerCsak ennek a személynek.

/api/v1/audit-action-plans/{id}/mark-done: note (text) — Mit végeztek el.

/api/v1/audit-action-plans/{id}/reopen: reason (text) — Miért nem fogadható el.

Példaválasz

{
    "data": {
        "id": 4,
        "audit_id": 19,
        "result_id": 1,
        "description": "Calibrați termometrul frigiderului și păstrați certificatul.",
        "responsible_id": 1,
        "due_on": "2026-05-20",
        "status": "open",
        "is_overdue": true,
        "done_note": null,
        "done_at": "2026-05-01T08:00:00Z",
        "verified_by": 1,
        "verified_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Munkavédelmi típusok /ssm-types

A cég által nyilvántartott munkavédelmi oktatások és vizsgálatok fajtái, mindegyiknek az érvényességi idejével.

Hatókörök: ssm_types:read

Végpontok

  • GET /api/v1/ssm-types Lista
  • GET /api/v1/ssm-types/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név.
validity_monthsinteger | nullcsak olvasható Hány hónapig érvényes; üres: nem jár le.
is_requiredbooleancsak olvasható Mindenkinek kötelező.
is_activebooleancsak olvasható Használatban.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 2,
        "name": "Instruire periodică",
        "validity_months": 6,
        "is_required": true,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Munkavédelmi nyilvántartás /ssm-records

Ki melyik munkavédelmi oktatáson vagy vizsgálaton vett részt, mikor, és meddig érvényes (a típusból számolva). Hívásonként egy bejegyzés.

Hatókörök: ssm_records:read, ssm_records:write

Végpontok

  • GET /api/v1/ssm-records Lista
  • GET /api/v1/ssm-records/{id} Egy rekord
  • POST /api/v1/ssm-records Létrehozás
  • DELETE /api/v1/ssm-records/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
employee_idintegerkötelező A személy.
type_idintegerkötelező Az oktatás vagy vizsgálat.
done_ondatekötelező Mikor történt (nem lehet jövőbeli).
valid_untildate | nullcsak olvasható Érvényes eddig (a típusból).
statevalid | expiring | expired | missing | nonecsak olvasható Ma: valid, expiring, expired.
trainerstring | null Oktató vagy orvos.
notestring | null Megjegyzések.
recorded_byinteger | nullcsak olvasható Ki rögzítette (felhasználó).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

employee_idintegerCsak ez a személy.
type_idintegerCsak ez a típus.
valid_until_beforedateEzen a napon vagy korábban jár le.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/ssm-records

{
    "employee_id": 345,
    "type_id": 2,
    "done_on": "2026-04-15"
}

Példaválasz

{
    "data": {
        "id": 120,
        "employee_id": 345,
        "type_id": 2,
        "done_on": "2026-04-15",
        "valid_until": "2026-10-15",
        "state": "valid",
        "trainer": null,
        "note": null,
        "recorded_by": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Dokumentumok, igénylések, felmérések és kommunikáció

Dokumentumkategóriák /document-categories

A kategóriák, amelyekbe a dokumentumokat sorolják, az egész cégre vagy egységekre.

Hatókörök: document_categories:read

Végpontok

  • GET /api/v1/document-categories Lista
  • GET /api/v1/document-categories/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név a kért nyelven.
scopecompany | unitcsak olvasható company (céges dokumentumok) vagy unit (egységdokumentumok).
sortintegercsak olvasható Hely a listákban.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

scopecompany | unitCsak céges vagy csak egységkategóriák.

Példaválasz

{
    "data": {
        "id": 4,
        "name": "Autorizații",
        "scope": "company",
        "sort": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Dokumentumok /documents

Engedélyek, szerződések és szabályzatok, a lejáratukkal. Az API egy dokumentum adatait, valamint aktuális fájljának nevét, méretét és típusát olvassa; magát a fájlt az alkalmazásban lehet letölteni. A fájlt {"name", "content_base64"} formában kell küldeni (ugyanazok a típusok, mint az alkalmazásban – PDF, Office, képek, ZIP –, legfeljebb 50 MB); ha egy meglévő dokumentumhoz fájlt küld, új verzió jön létre. A törlés a lomtárba helyezi a dokumentumot, ahonnan az alkalmazásban visszaállítható.

Hatókörök: documents:read, documents:write

Végpontok

  • GET /api/v1/documents Lista
  • GET /api/v1/documents/{id} Egy rekord
  • POST /api/v1/documents Létrehozás
  • PATCH /api/v1/documents/{id} Frissítés
  • DELETE /api/v1/documents/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
titlestringkötelező Cím.
descriptiontext | null Leírás.
category_idinteger | null Kategória (lásd /document-categories).
work_unit_idinteger | null Az egység, amelyhez tartozik; céges dokumentumnál üres. Csak létrehozáskor adható meg.
is_internalboolean Csak a dokumentumokat kezelők látják.
expires_ondate | null Lejárati dátum.
expiry_statevalid | expiring | expired | nullcsak olvasható valid, expiring vagy expired (lejárati dátum nélkül üres).
repeat_monthsinteger | null Ennyi havonta megújítandó.
alert_daysarray | null Hány nappal a lejárat előtt mennek ki emlékeztetők (legfeljebb 6).
versionsintegercsak olvasható Hány verziója van a fájlnak.
file_namestring | nullcsak olvasható Az aktuális fájl neve.
file_sizeinteger | nullcsak olvasható A mérete bájtban.
file_mimestring | nullcsak olvasható A típusa.
filefilekötelező A fájl: {"name": "…", "content_base64": "…"}. Létrehozáskor kötelező; módosításkor új verziót ad hozzá.
version_notestring | null Megjegyzés a fájl verziójához (megjelenítve: az aktuális verzióé).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

work_unit_idintegerCsak ennek az egységnek a dokumentumai.
category_idintegerCsak ez a kategória.
companybooleantrue: csak céges dokumentumok; false: csak egységdokumentumok.
expires_beforedateEzen a napon vagy előtte lejár.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/documents

{
    "title": "Autorizație sanitară de funcționare",
    "category_id": 4,
    "work_unit_id": 12,
    "is_internal": false,
    "expires_on": "2026-12-31",
    "repeat_months": 12,
    "alert_days": [
        30,
        7
    ],
    "file": {
        "name": "document.pdf",
        "content_base64": "JVBERi0xLjQK…"
    }
}

Példaválasz

{
    "data": {
        "id": 31,
        "title": "Autorizație sanitară de funcționare",
        "description": null,
        "category_id": 4,
        "work_unit_id": 12,
        "is_internal": false,
        "expires_on": "2026-12-31",
        "expiry_state": "valid",
        "repeat_months": 12,
        "alert_days": [
            30,
            7
        ],
        "versions": 2,
        "file_name": "autorizatie.pdf",
        "file_size": 184220,
        "file_mime": "application/pdf",
        "version_note": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Szolgáltatáskategóriák /service-categories

Miről szólnak a szolgáltatásigénylések (karbantartás, informatika…), és kell-e hozzájuk előzetes jóváhagyás.

Hatókörök: service_categories:read

Végpontok

  • GET /api/v1/service-categories Lista
  • GET /api/v1/service-categories/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név a kért nyelven.
is_activebooleancsak olvasható Lehet-e ebben a kategóriában igénylést benyújtani.
needs_approvalbooleancsak olvasható Jóváhagyásra vár-e az igénylés, mielőtt megnyílik.
sortintegercsak olvasható Hely a listákban.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 2,
        "name": "Mentenanță și reparații",
        "is_active": true,
        "needs_approval": false,
        "sort": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Szolgáltatásigénylések /service-requests

Igénylések valaminek a javítására vagy biztosítására egy egységben, az előzményeikkel. A requested_by mezőben megadott személy nevében nyújtjuk be (akinek az adott egységre igénylést kell tudnia benyújtani), vagy a kulcs létrehozójának nevében; a kategória jóváhagyási folyamata érvényes. A move művelettel léptethető tovább, ahogyan a kulcs létrehozója a képernyőn teheti.

Hatókörök: service_requests:read, service_requests:write

Végpontok

  • GET /api/v1/service-requests Lista
  • GET /api/v1/service-requests/{id} Egy rekord
  • POST /api/v1/service-requests Létrehozás
  • POST /api/v1/service-requests/{id}/move Az igénylést másik állapotba helyezi (in_progress, resolved, unresolved, open, cancelled), ahogyan a kulcs létrehozója teheti. A megoldatlanként lezáráshoz és az újranyitáshoz megjegyzés szükséges.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
category_idintegerkötelező Kategória (lásd /service-categories).
work_unit_idintegerkötelező Az egység, amelyre vonatkozik.
titlestringkötelező Rövid cím.
descriptiontextkötelező Mi a hiba, vagy mire van szükség.
requested_byinteger A felhasználó, akinek a nevében benyújtják (a cég egy személye); ha elmarad, a kulcs létrehozója.
employee_idintegercsak olvasható A benyújtó munkavállalói adatlapja.
statusawaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelledcsak olvasható awaiting_approval, open, in_progress, resolved, unresolved, rejected vagy cancelled.
assigned_tointeger | nullcsak olvasható A felhasználó, aki elvállalta.
closed_atdatetime | nullcsak olvasható Mikor zárták le.
historyarraycsak olvasható Minden állapotváltás: honnan, hová, megjegyzés, ki, mikor.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusawaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelledCsak ezzel az állapottal.
category_idintegerCsak ez a kategória.
work_unit_idintegerCsak ez az egység.
closed_sincedateEttől a naptól (Y-m-d) lezártak.

/api/v1/service-requests/{id}/move: status (awaiting_approval | open | in_progress | resolved | unresolved | rejected | cancelled) — Az új állapot.; comment (text) — Indoklás (unresolved esetén és újranyitáskor kötelező).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/service-requests

{
    "category_id": 2,
    "work_unit_id": 12,
    "title": "Frigiderul de vaccinuri nu mai răcește",
    "description": "text",
    "requested_by": 17
}

Példaválasz

{
    "data": {
        "id": 88,
        "category_id": 2,
        "work_unit_id": 12,
        "title": "Frigiderul de vaccinuri nu mai răcește",
        "description": "text",
        "requested_by": 17,
        "employee_id": 345,
        "status": "open",
        "assigned_to": 1,
        "closed_at": "2026-05-01T08:00:00Z",
        "history": [
            {
                "status_from": "open",
                "status_to": "in_progress",
                "comment": "Vine tehnicianul mâine.",
                "user_id": 9,
                "at": "2026-05-04T08:00:00Z"
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Anyagok /materials

Amit az egységek igényelhetnek, az aktuális készlettel, ha azt nyilvántartják.

Hatókörök: materials:read

Végpontok

  • GET /api/v1/materials Lista
  • GET /api/v1/materials/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név.
descriptiontext | nullcsak olvasható Leírás.
unitstringcsak olvasható Mértékegység.
track_stockbooleancsak olvasható Nyilvántartják-e a készletet.
stocknumber | nullcsak olvasható Aktuális készlet (üres, ha nincs nyilvántartva).
is_activebooleancsak olvasható Igényelhető-e.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

is_activebooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 7,
        "name": "Mănuși nitril",
        "description": null,
        "unit": "cutie",
        "track_stock": true,
        "stock": 35,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Anyagigénylések /material-requests

Anyagigénylések a tételeikkel. A requested_by mezőben megadott személy (vagy a kulcs létrehozója) nevében nyújtjuk be, aktív anyagra és olyan egységre, amelyre igényelhet; ezután elvállalható, teljesíthető (ez levonja a készletet) vagy visszavonható, ahogyan a kulcs létrehozója a képernyőn teheti.

Hatókörök: material_requests:read, material_requests:write

Végpontok

  • GET /api/v1/material-requests Lista
  • GET /api/v1/material-requests/{id} Egy rekord
  • POST /api/v1/material-requests Létrehozás
  • POST /api/v1/material-requests/{id}/take Egy új igénylés elvállalása intézésre.
  • POST /api/v1/material-requests/{id}/complete Teljesítés: a nyilvántartott anyagok készlete csökken.
  • POST /api/v1/material-requests/{id}/cancel Egy még nem teljesített igénylés visszavonása.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
work_unit_idintegerkötelező Az egység, amelyre vonatkozik.
requested_byinteger A felhasználó, akinek a nevében benyújtják; ha elmarad, a kulcs létrehozója.
statusnew | taken | completed | cancelledcsak olvasható new, taken, completed vagy cancelled.
handled_byinteger | nullcsak olvasható A felhasználó, aki intézi.
notetext | null Megjegyzés.
itemsarraykötelező Az igényelt tételek: [{"material_id": 7, "quantity": 5}] (legalább egy).
completed_atdatetime | nullcsak olvasható Mikor teljesítették.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusnew | taken | completed | cancelledCsak ezzel az állapottal.
work_unit_idintegerCsak ez az egység.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/material-requests

{
    "work_unit_id": 12,
    "requested_by": 17,
    "items": [
        {
            "material_id": 7,
            "quantity": 5
        }
    ]
}

Példaválasz

{
    "data": {
        "id": 51,
        "work_unit_id": 12,
        "requested_by": 17,
        "status": "new",
        "handled_by": 1,
        "note": null,
        "items": [
            {
                "material_id": 7,
                "quantity": 5
            }
        ],
        "completed_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Felmérések /surveys

Közzétett és lezárt felmérések a kérdéseikkel, az eredményeik pedig csak összesítve: hányan választották az egyes válaszokat, egy skála átlaga, és hányan válaszoltak egy szabad szöveges kérdésre – azt soha, hogy mit írtak. Egy névtelen felmérés eredményei rejtve maradnak, amíg a válaszai lepecsételtek, és amíg 5-nél kevesebb válasz érkezett.

Hatókörök: surveys:read

Végpontok

  • GET /api/v1/surveys Lista
  • GET /api/v1/surveys/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
titlestringcsak olvasható Cím.
descriptiontext | nullcsak olvasható Leírás.
is_anonymousbooleancsak olvasható Névtelenek-e a válaszok.
is_mandatorybooleancsak olvasható Kötelező-e a kitöltés.
statuspublished | closedcsak olvasható published vagy closed.
opens_atdatetime | nullcsak olvasható Mikor nyílik meg.
closes_atdatetime | nullcsak olvasható Mikor zárul.
published_atdatetime | nullcsak olvasható Mikor tették közzé.
series_idinteger | nullcsak olvasható A kérdőívsorozat, amelynek kiadása; egyszeri kérdőívnél üres.
editioninteger | nullcsak olvasható A kiadás sorszáma a sorozatban.
questionsarraycsak olvasható A kérdések: id, type (single, multiple, scale, text), text, required, options.
resultsobjectcsak olvasható Összesítések: hidden, sealed, responses, assigned, completed, valamint kérdésenként hányan válaszoltak, a válaszlehetőségenkénti vagy skálaértékenkénti darabszám és az átlag.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statuspublished | closedpublished vagy closed.
is_anonymousbooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 5,
        "title": "Climatul de lucru",
        "description": null,
        "is_anonymous": true,
        "is_mandatory": false,
        "status": "closed",
        "opens_at": "2026-05-01T08:00:00Z",
        "closes_at": "2026-05-01T08:00:00Z",
        "published_at": "2026-05-01T08:00:00Z",
        "series_id": 1,
        "edition": 1,
        "questions": [
            {
                "id": 11,
                "type": "single",
                "text": "Ați recomanda compania?",
                "is_required": true,
                "options": [
                    {
                        "id": 31,
                        "label": "Da"
                    }
                ]
            }
        ],
        "results": {
            "hidden": false,
            "responses": 14,
            "questions": [
                {
                    "question_id": 11,
                    "answered": 14,
                    "counts": {
                        "31": 11
                    },
                    "average": null
                }
            ]
        },
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Felmérésválaszok /survey-responses

Névvel kitöltött felmérések válaszai, személyenként egy kitöltés a válaszaival. Egy névtelen felmérés válaszait soha nem adjuk ki egyenként – csak az összesítéseit, a /surveys végponton.

Hatókörök: survey_responses:read

Végpontok

  • GET /api/v1/survey-responses Lista
  • GET /api/v1/survey-responses/{id} Egy rekord

Mezők

NévTípusLeírás
idstringcsak olvasható Azonosító (UUID).
survey_idintegercsak olvasható A felmérés.
employee_idintegercsak olvasható Ki válaszolt.
submitted_atdatetime | nullcsak olvasható Mikor.
answersarraycsak olvasható A válaszok: kérdés, választott lehetőség, érték (skála) vagy szöveg.

Szűrők

survey_idintegerCsak ennek a felmérésnek a válaszai.
employee_idintegerCsak ennek a személynek a válaszai.

Példaválasz

{
    "data": {
        "id": "9b2f4c1e-6f0a-4e7c-9a51-3c2d1e0f7a88",
        "survey_id": 5,
        "employee_id": 345,
        "submitted_at": "2026-05-01T08:00:00Z",
        "answers": [
            {
                "question_id": 11,
                "option_id": 31,
                "value": null,
                "text": null
            }
        ]
    }
}

Bejegyzések /posts

Az egész cégnek szóló (nem csoportban lévő), közzétett közösségi bejegyzések. A kulcs létrehozója hozza létre: bejegyzést, illetve hírt, közleményt, promóciót vagy versenyt, ha jogosult közleményeket kiadni; a szöveg egyszerű szöveg, a bekezdések között üres sorral.

Hatókörök: posts:read, posts:write

Végpontok

  • GET /api/v1/posts Lista
  • GET /api/v1/posts/{id} Egy rekord
  • POST /api/v1/posts Létrehozás

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
typepost | news | announcement | promotion | contestkötelező post, news, announcement, promotion vagy contest.
titlestring | null Cím (nem kötelező).
bodytextkötelező A szöveg (olvasáskor egyszerű szövegként).
authorstring | nullcsak olvasható Ki írta.
comments_enabledboolean Lehet-e hozzászólni.
comments_countintegercsak olvasható Hány hozzászólás van.
published_atdatetime | null Mikor jelenik meg; egy jövőbeli időpont ütemezi.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

typepost | news | announcement | promotion | contestCsak ez a típus.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/posts

{
    "type": "announcement",
    "title": "Program de sărbători",
    "body": "Între 24 și 26 decembrie programul este 9–14.",
    "comments_enabled": true
}

Példaválasz

{
    "data": {
        "id": 120,
        "type": "announcement",
        "title": "Program de sărbători",
        "body": "Între 24 și 26 decembrie programul este 9–14.",
        "author": "Maria Matei",
        "comments_enabled": true,
        "comments_count": 3,
        "published_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Tudásbázis-cikkek /knowledge-articles

A tudásbázis közzétett cikkei (eljárások, útmutatók), a szöveggel egyszerű szövegként, a kért nyelven (Accept-Language) vagy a cég nyelvén.

Hatókörök: knowledge_articles:read

Végpontok

  • GET /api/v1/knowledge-articles Lista
  • GET /api/v1/knowledge-articles/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
category_idinteger | nullcsak olvasható Téma.
categorystring | nullcsak olvasható A téma neve.
titlestringcsak olvasható Cím.
summarytext | nullcsak olvasható Összefoglaló.
bodytext | nullcsak olvasható A cikk egyszerű szövegként.
is_featuredbooleancsak olvasható Kiemelt-e.
published_atdatetime | nullcsak olvasható Első közzététel.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

category_idintegerCsak ez a téma.
is_featuredbooleantrue vagy false.

Példaválasz

{
    "data": {
        "id": 9,
        "category_id": 2,
        "category": "Operațiuni",
        "title": "Recepția mărfii",
        "summary": null,
        "body": null,
        "is_featured": true,
        "published_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ügyfelek (CRM)

Ügyfelek /crm-contacts

Azok a személyek, akiket a cég kiszolgál – ügyfelek és érdeklődők. Egy e-mail-cím a cégen belül egyedi (egy második azonos címet elutasítunk). A marketinghozzájárulás soha nem íródik a rekorddal együtt: csak a consent műveleten keresztül változik, amely megőrzi az előzményeit (megadva vagy visszavonva, hogyan, mikor, ki által). Az erase művelet a személy kérésére törli az adatait, és nem vonható vissza: a név, az e-mail-cím, a telefonszám, a megjegyzések és mindaz, amit róla írtak, törlődik, a számadatok (vásárlások, üzleti lehetőségek értéke, pontszámok) megmaradnak, és a rekord többé nem módosítható.

Hatókörök: crm_contacts:read, crm_contacts:write

Végpontok

  • GET /api/v1/crm-contacts Lista
  • GET /api/v1/crm-contacts/{id} Egy rekord
  • POST /api/v1/crm-contacts Létrehozás
  • PATCH /api/v1/crm-contacts/{id} Frissítés
  • DELETE /api/v1/crm-contacts/{id} Törlés
  • POST /api/v1/crm-contacts/{id}/consent Rögzíti, hogy a személy megadta vagy visszavonta a marketinghozzájárulását, és hogyan.
  • POST /api/v1/crm-contacts/{id}/erase Törli a személy adatait a kérésére (GDPR). Nem vonható vissza.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
first_namestring | null Utónév.
last_namestring | null Vezetéknév.
emailstring | null E-mail-cím (a cégen belül egyedi, kisbetűvel tárolva).
phonestring | null Telefonszám, ahogyan megadták.
account_idinteger | null Az ügyfélcég, amelyhez tartozik (lásd /crm-accounts).
job_titlestring | null A szerepe ott.
citystring | null Település.
countrystring | null Ország, kétbetűs ISO-kóddal.
localestring | null A nyelv, amelyen megszólítjuk (ro, en…).
statuslead | customer | inactive lead, customer vagy inactive. Egy vásárlás vagy egy megnyert üzleti lehetőség az érdeklődőt ügyféllé teszi.
sourcewalk_in | website | phone | referral | campaign | event | partner | other | null Honnan érkezett: walk_in, website, phone, referral, campaign, event, partner vagy other.
work_unit_idinteger | null Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_idinteger | null A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
tagsarray Címkék (kisbetűvel, legfeljebb 20).
notestext | null Megjegyzések.
marketing_consentbooleancsak olvasható Hozzájárul-e jelenleg a marketinghez (csak olvasható – a consent műveleten keresztül változik).
consent_updated_atdatetime | nullcsak olvasható Mikor változott utoljára a hozzájárulás.
last_activity_atdatetime | nullcsak olvasható Mikor történt vele utoljára valami.
erased_atdatetime | nullcsak olvasható Mikor törölték az adatait kérésre (a rekord ezután csak olvasható).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

qstringEzt tartalmazó név, e-mail-cím vagy telefonszám.
emailstringPontosan ez az e-mail-cím (a kis- és nagybetű nem számít).
phonestringEz a telefonszám (csak a számjegyeket hasonlítjuk össze).
statuslead | customer | inactiveCsak ezzel az állapottal.
work_unit_idintegerCsak ennek az egységnek az ügyfelei.
owner_idintegerCsak ennek a felhasználónak az ügyfelei.
account_idintegerCsak ennek az ügyfélcégnek az ügyfelei.
tagstringCsak ezzel a címkével.
consentbooleantrue: csak akik hozzájárulnak a marketinghez; false: csak akik nem.

/api/v1/crm-contacts/{id}/consent: granted (boolean) — true: megadva; false: visszavonva.; channel (form | verbal | email | import | api | other) — Hogyan: form, verbal, email, import, api vagy other (ha elmarad: api).; note (string) — Megjegyzés (például hol őrzik az űrlapot).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/crm-contacts

{
    "first_name": "Ioana",
    "last_name": "Pop",
    "email": "ioana.pop@example.com",
    "phone": "0722 111 222",
    "account_id": 31,
    "city": "Cluj-Napoca",
    "country": "RO",
    "locale": "ro",
    "status": "customer",
    "source": "walk_in",
    "work_unit_id": 12,
    "owner_id": 17,
    "tags": [
        "loyalty"
    ]
}

Példaválasz

{
    "data": {
        "id": 120,
        "first_name": "Ioana",
        "last_name": "Pop",
        "email": "ioana.pop@example.com",
        "phone": "0722 111 222",
        "account_id": 31,
        "job_title": null,
        "city": "Cluj-Napoca",
        "country": "RO",
        "locale": "ro",
        "status": "customer",
        "source": "walk_in",
        "work_unit_id": 12,
        "owner_id": 17,
        "tags": [
            "loyalty"
        ],
        "notes": null,
        "marketing_consent": true,
        "consent_updated_at": "2026-05-01T08:00:00Z",
        "last_activity_at": "2026-05-01T08:00:00Z",
        "erased_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ügyfélcégek /crm-accounts

A cégek és intézmények, amelyeknek a vállalkozás értékesít. A név a cégen belül egyedi. Törléskor a kapcsolattartói és üzleti lehetőségei megmaradnak, a kapcsolat nélkül.

Hatókörök: crm_accounts:read, crm_accounts:write

Végpontok

  • GET /api/v1/crm-accounts Lista
  • GET /api/v1/crm-accounts/{id} Egy rekord
  • POST /api/v1/crm-accounts Létrehozás
  • PATCH /api/v1/crm-accounts/{id} Frissítés
  • DELETE /api/v1/crm-accounts/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név (a cégen belül egyedi).
registration_numberstring | null Cégjegyzékszám.
vat_numberstring | null Adószám.
industrystring | null Iparág.
emailstring | null E-mail-cím.
phonestring | null Telefonszám.
websitestring | null Weboldal.
addressstring | null Cím.
citystring | null Település.
countrystring | null Ország, kétbetűs ISO-kóddal.
work_unit_idinteger | null Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_idinteger | null A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
tagsarray Címkék (kisbetűvel, legfeljebb 20).
notestext | null Megjegyzések.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

qstringEzt tartalmazó név.
work_unit_idintegerCsak ennek az egységnek az ügyfélcégei.
owner_idintegerCsak ennek a felhasználónak az ügyfélcégei.
tagstringCsak ezzel a címkével.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/crm-accounts

{
    "name": "Hotel Sigma SRL",
    "registration_number": "J12/345/2019",
    "vat_number": "RO12345678",
    "industry": "Hospitality",
    "email": "office@sigma.example",
    "phone": "0264 000 111",
    "city": "Cluj-Napoca",
    "country": "RO",
    "work_unit_id": 12,
    "owner_id": 17,
    "tags": [
        "corporate",
        "events"
    ]
}

Példaválasz

{
    "data": {
        "id": 31,
        "name": "Hotel Sigma SRL",
        "registration_number": "J12/345/2019",
        "vat_number": "RO12345678",
        "industry": "Hospitality",
        "email": "office@sigma.example",
        "phone": "0264 000 111",
        "website": null,
        "address": null,
        "city": "Cluj-Napoca",
        "country": "RO",
        "work_unit_id": 12,
        "owner_id": 17,
        "tags": [
            "corporate",
            "events"
        ],
        "notes": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Értékesítési pipeline-ok /crm-pipelines

A pipeline-ok, amelyeken az üzleti lehetőségek végighaladnak, a szakaszaikkal (az alkalmazásban beállítva). Minden cégnek van egy alapértelmezett pipeline-ja. Egy szakasz nyitott (azzal az eséllyel, hogy az ott lévő üzleti lehetőség megnyerhető), vagy megnyertként, illetve elvesztettként lezárja az üzleti lehetőséget.

Hatókörök: crm_pipelines:read

Végpontok

  • GET /api/v1/crm-pipelines Lista
  • GET /api/v1/crm-pipelines/{id} Egy rekord

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringcsak olvasható Név.
is_defaultbooleancsak olvasható Ide kerülnek-e az új üzleti lehetőségek, ha nincs megadva pipeline.
sortintegercsak olvasható Hely a listákban.
stagesarraycsak olvasható A szakaszai sorrendben: id, name, kind (open, won vagy lost), probability (0–100) és sort.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Példaválasz

{
    "data": {
        "id": 1,
        "name": "Sales",
        "is_default": true,
        "sort": 1,
        "stages": [
            {
                "id": 3,
                "name": "Proposal sent",
                "kind": "open",
                "probability": 60,
                "sort": 20
            },
            {
                "id": 5,
                "name": "Won",
                "kind": "won",
                "probability": 100,
                "sort": 40
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Üzleti lehetőségek /crm-deals

Értékesítések, foglalások vagy szerződések, amelyek egy pipeline-on haladnak végig. A pipeline és a szakasz létrehozáskor választható (ha elmarad, az alapértelmezett pipeline első nyitott szakasza); utána az üzleti lehetőség csak a move, win, lose és reopen műveletekkel vált szakaszt. Az állapota mindig a szakaszát követi, a closed_at pedig megnyeréskor vagy elvesztéskor kap értéket. Egy üzleti lehetőség megnyerése a kapcsolattartóját ügyféllé teszi.

Hatókörök: crm_deals:read, crm_deals:write

Végpontok

  • GET /api/v1/crm-deals Lista
  • GET /api/v1/crm-deals/{id} Egy rekord
  • POST /api/v1/crm-deals Létrehozás
  • PATCH /api/v1/crm-deals/{id} Frissítés
  • DELETE /api/v1/crm-deals/{id} Törlés
  • POST /api/v1/crm-deals/{id}/move Az üzleti lehetőséget másik szakaszba helyezi (a saját pipeline-jában vagy egy másikban – ekkor az üzleti lehetőség is átkerül).
  • POST /api/v1/crm-deals/{id}/win Megnyertként jelöli az üzleti lehetőséget (a pipeline megnyert szakasza).
  • POST /api/v1/crm-deals/{id}/lose Elvesztettként jelöli az üzleti lehetőséget (a pipeline elvesztett szakasza), az okával.
  • POST /api/v1/crm-deals/{id}/reopen Egy lezárt üzleti lehetőséget visszavisz a pipeline utolsó nyitott szakaszába.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
titlestringkötelező Mit értékesítenek.
pipeline_idinteger A pipeline (lásd /crm-pipelines). Csak létrehozáskor adható meg.
stage_idinteger A szakasz. Csak létrehozáskor adható meg; utána a műveletekkel.
statusopen | won | lostcsak olvasható open, won vagy lost – a szakasza típusa.
contact_idinteger | null Az ügyfél (lásd /crm-contacts).
account_idinteger | null Az ügyfélcég (lásd /crm-accounts).
valuenumber | null Az értéke.
currencystring Az érték pénzneme (ISO-kód); ha elmarad, a cég CRM-pénzneme.
expected_close_ondate | null Mikorra várható a lezárása.
closed_atdatetime | nullcsak olvasható Mikor nyerték meg vagy vesztették el.
lost_reasonstring | nullcsak olvasható Miért veszett el.
sourcewalk_in | website | phone | referral | campaign | event | partner | other | null Honnan érkezett (mint az ügyfeleknél).
work_unit_idinteger | null Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_idinteger | null A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
notestext | null Megjegyzések.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

statusopen | won | lostCsak nyitott, megnyert vagy elvesztett.
pipeline_idintegerCsak ennek a pipeline-nak az üzleti lehetőségei.
stage_idintegerCsak ebben a szakaszban.
work_unit_idintegerCsak ennek az egységnek az üzleti lehetőségei.
owner_idintegerCsak ennek a felhasználónak az üzleti lehetőségei.
contact_idintegerCsak ennek az ügyfélnek az üzleti lehetőségei.
account_idintegerCsak ennek az ügyfélcégnek az üzleti lehetőségei.
closed_sincedateEzen a napon vagy utána lezárva.
closed_untildateEzen a napon vagy előtte lezárva.

/api/v1/crm-deals/{id}/move: stage_id (integer) — A célszakasz.

/api/v1/crm-deals/{id}/lose: lost_reason (string) — Miért veszett el.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/crm-deals

{
    "title": "Corporate rates 2027",
    "pipeline_id": 1,
    "stage_id": 3,
    "contact_id": 120,
    "account_id": 31,
    "value": 12500.5,
    "currency": "RON",
    "expected_close_on": "2026-12-15",
    "source": "referral",
    "work_unit_id": 12,
    "owner_id": 17
}

Példaválasz

{
    "data": {
        "id": 77,
        "title": "Corporate rates 2027",
        "pipeline_id": 1,
        "stage_id": 3,
        "status": "open",
        "contact_id": 120,
        "account_id": 31,
        "value": 12500.5,
        "currency": "RON",
        "expected_close_on": "2026-12-15",
        "closed_at": "2026-05-01T08:00:00Z",
        "lost_reason": null,
        "source": "referral",
        "work_unit_id": 12,
        "owner_id": 17,
        "notes": null,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ügyféltevékenységek /crm-activities

Ami az ügyfelekkel történt vagy történni fog: hívás, megbeszélés, látogatás, e-mail, megjegyzés, feladat és vásárlás. Egy feladat a teljesítéséig várakozik; minden más a rögzítéskor elvégzettnek számít (a done_at időpontban, ha meg van adva). Egy vásárláshoz meg kell adni az összegét, és a kapcsolattartóját ügyféllé teszi. Egy üzleti lehetőséghez tartozó tevékenység átveszi az üzleti lehetőség ügyfelét, ügyfélcégét és egységét, ha ezek nincsenek megadva.

Hatókörök: crm_activities:read, crm_activities:write

Végpontok

  • GET /api/v1/crm-activities Lista
  • GET /api/v1/crm-activities/{id} Egy rekord
  • POST /api/v1/crm-activities Létrehozás
  • PATCH /api/v1/crm-activities/{id} Frissítés
  • DELETE /api/v1/crm-activities/{id} Törlés
  • POST /api/v1/crm-activities/{id}/complete Elvégzettnek jelöl egy feladatot (most).
  • POST /api/v1/crm-activities/{id}/reopen Ismét el nem végzettnek jelöli (vásárlásnál nem).

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
typecall | meeting | visit | email | task | note | purchasekötelező call, meeting, visit, email, task, note vagy purchase.
subjectstringkötelező Rövid leírás.
bodytext | null Részletek.
contact_idinteger | null Az ügyfél.
account_idinteger | null Az ügyfélcég.
deal_idinteger | null Az üzleti lehetőség, amelyhez tartozik.
amountnumber | null Egy vásárlás összege a cég CRM-pénznemében (a többi típusnál üres).
due_atdatetime | null Egy feladat határideje.
done_atdatetime | null Mikor végezték el; egy még elvégzendő feladatnál üres.
work_unit_idinteger | null Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_idinteger | null A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

typecall | meeting | visit | email | task | note | purchaseCsak ez a típus.
work_unit_idintegerCsak ennek az egységnek a tevékenységei.
owner_idintegerCsak ennek a felhasználónak a tevékenységei.
contact_idintegerCsak ennek az ügyfélnek a tevékenységei.
deal_idintegerCsak ennek az üzleti lehetőségnek a tevékenységei.
donebooleantrue: csak az elvégzettek; false: csak a még elvégzendők.
due_beforedatetimeEz előtti határidővel.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/crm-activities

{
    "type": "purchase",
    "subject": "Receipt 1243",
    "contact_id": 120,
    "amount": 240,
    "due_at": "2026-11-03T09:00:00Z",
    "done_at": "2026-11-02T15:20:00Z",
    "work_unit_id": 12,
    "owner_id": 17
}

Példaválasz

{
    "data": {
        "id": 530,
        "type": "purchase",
        "subject": "Receipt 1243",
        "body": null,
        "contact_id": 120,
        "account_id": 1,
        "deal_id": 1,
        "amount": 240,
        "due_at": "2026-11-03T09:00:00Z",
        "done_at": "2026-11-02T15:20:00Z",
        "work_unit_id": 12,
        "owner_id": 17,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Ügyfél-visszajelzések /crm-feedback

Amit az ügyfelek mondtak: visszajelzések (0–10-es pontszám – mennyire valószínű, hogy ajánlanák a vállalkozást – és/vagy megjegyzés) és panaszok. Egy visszajelzéshez pontszám vagy megjegyzés szükséges. Egy panasz nyitott marad, amíg meg nem oldják, rögzítve, mi történt; újra megnyitható. A típus létrehozáskor dől el.

Hatókörök: crm_feedback:read, crm_feedback:write

Végpontok

  • GET /api/v1/crm-feedback Lista
  • GET /api/v1/crm-feedback/{id} Egy rekord
  • POST /api/v1/crm-feedback Létrehozás
  • PATCH /api/v1/crm-feedback/{id} Frissítés
  • DELETE /api/v1/crm-feedback/{id} Törlés
  • POST /api/v1/crm-feedback/{id}/resolve Megold egy panaszt, megadva, mi történt.
  • POST /api/v1/crm-feedback/{id}/reopen Újra megnyit egy megoldott panaszt.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
kindfeedback | complaintkötelező feedback vagy complaint. Csak létrehozáskor adható meg.
contact_idinteger | null Az ügyfél.
account_idinteger | null Az ügyfélcég.
scoreinteger | null 0 és 10 között.
commenttext | null Amit mondott.
channelin_person | phone | email | website | review_site | survey | other | null Hogyan érkezett: in_person, phone, email, website, review_site, survey vagy other.
received_ondate Mikor érkezett (ha elmarad, ma).
statusopen | resolvedcsak olvasható open (még meg nem oldott panasz) vagy resolved.
resolved_atdatetime | nullcsak olvasható Mikor oldották meg a panaszt.
resolutiontext | nullcsak olvasható Mit tettek az ügyben.
work_unit_idinteger | null Az egység (üzlet, szálloda, iroda), amely kiszolgálja; üres, ha nincs.
owner_idinteger | null A felelős felhasználó; ha létrehozáskor elmarad, a kulcs létrehozója.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utoljára módosítva.

Szűrők

kindfeedback | complaintCsak visszajelzések vagy csak panaszok.
statusopen | resolvedCsak nyitottak vagy csak megoldottak.
work_unit_idintegerCsak ennek az egységnek a visszajelzései.
contact_idintegerCsak ennek az ügyfélnek a visszajelzései.
received_sincedateEzen a napon vagy utána érkezett.

/api/v1/crm-feedback/{id}/resolve: resolution (text) — Mi történt.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/crm-feedback

{
    "kind": "feedback",
    "contact_id": 120,
    "score": 9,
    "comment": "Quick and friendly service.",
    "channel": "in_person",
    "received_on": "2026-11-02",
    "work_unit_id": 12,
    "owner_id": 17
}

Példaválasz

{
    "data": {
        "id": 64,
        "kind": "feedback",
        "contact_id": 120,
        "account_id": 1,
        "score": 9,
        "comment": "Quick and friendly service.",
        "channel": "in_person",
        "received_on": "2026-11-02",
        "status": "resolved",
        "resolved_at": "2026-05-01T08:00:00Z",
        "resolution": null,
        "work_unit_id": 12,
        "owner_id": 17,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Üzletterek és polcfelület

Partnerek /merch-partners

A gyártók és márkák, amelyek kampányai a cég bemutatófelületeire és polcaira kerülnek: egy lista mindkét modulhoz. A név a cégen belül egyedi. Az íráshoz a kulcs létrehozójának „Partnerek kezelése” jogosultsággal kell rendelkeznie.

Hatókörök: merch_partners:read, merch_partners:write

Végpontok

  • GET /api/v1/merch-partners Lista
  • GET /api/v1/merch-partners/{id} Egy rekord
  • POST /api/v1/merch-partners Létrehozás
  • PATCH /api/v1/merch-partners/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező A partner neve (a cégen belül egyedi).
codestring | null Belső kód.
contact_namestring | null Kapcsolattartó.
contact_emailstring | null A kapcsolattartó e-mail-címe.
contact_phonestring | null A kapcsolattartó telefonszáma.
notestext | null Megjegyzések.
crm_account_idinteger | null A megfelelő CRM-ügyfélcég (lásd /crm-accounts), ha van.
is_activeboolean Kaphat-e új kampányokat.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

qstringA név tartalmazza a szöveget.
is_activebooleantrue: csak az aktívak; false: csak az inaktívak.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/merch-partners

{
    "name": "Dermalab",
    "code": "DLB",
    "contact_name": "Ana Ionescu",
    "contact_email": "ana@dermalab.example",
    "contact_phone": "0722 000 111",
    "crm_account_id": 31,
    "is_active": true
}

Példaválasz

{
    "data": {
        "id": 3,
        "name": "Dermalab",
        "code": "DLB",
        "contact_name": "Ana Ionescu",
        "contact_email": "ana@dermalab.example",
        "contact_phone": "0722 000 111",
        "notes": null,
        "crm_account_id": 31,
        "is_active": true,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zónatípusok /space-zone-types

Üzletterek: a cég sok egységében előforduló zónafajták (kattanókeret, pultdisplay, totem) a szokásos méreteikkel és kapacitásukkal. A havi díjat csak az írhatja, aki látja a pénzügyi adatokat.

Hatókörök: space_zone_types:read, space_zone_types:write

Végpontok

  • GET /api/v1/space-zone-types Lista
  • GET /api/v1/space-zone-types/{id} Egy rekord
  • POST /api/v1/space-zone-types Létrehozás
  • PATCH /api/v1/space-zone-types/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név.
descriptiontext | null Leírás.
width_cmnumber | null Szélesség, centiméterben.
height_cmnumber | null Magasság, centiméterben.
depth_cmnumber | null Mélység, centiméterben.
facesinteger Oldalak száma (1 vagy 2: A, B).
capacityinteger Hány darab fér el egy oldalon.
capacity_labelstring | null Mit számol a kapacitás (pl. „A2-es plakát”).
is_displayboolean Bemutatófelület-e (fogadhat-e kampányokat).
monthly_pricenumber | null Egy kapacitásegység havi díja (javaslat a kampányok értékéhez).
is_activeboolean Használatban van-e még.
sortinteger Sorrend a listákban.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

is_activebooleantrue: csak a használatban lévők; false: csak a kivezetettek.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/space-zone-types

{
    "name": "Ramă click A2",
    "width_cm": 50,
    "height_cm": 70,
    "faces": 2,
    "capacity": 2,
    "capacity_label": "afișe A2",
    "is_display": true,
    "monthly_price": 150,
    "is_active": true,
    "sort": 10
}

Példaválasz

{
    "data": {
        "id": 2,
        "name": "Ramă click A2",
        "description": null,
        "width_cm": 50,
        "height_cm": 70,
        "depth_cm": 12.5,
        "faces": 2,
        "capacity": 2,
        "capacity_label": "afișe A2",
        "is_display": true,
        "monthly_price": 150,
        "is_active": true,
        "sort": 10,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Zónák az egységekben /space-zones

Üzletterek: az egyes egységek zónái (hol, mekkora, oldalanként mennyi fér el), csak azokban az egységekben, amelyek elrendezését a kulcs létrehozója kezeli. Egy zóna az egységében marad. Egy típus új zónája a hiányzó adatokhoz a típus méreteit veszi át. Ha kevesebb oldalt vagy helyet adna meg, mint amennyit a futó kampányai igényelnek, a kérés elutasításra kerül; kampányokat tartalmazó zóna nem törölhető.

Hatókörök: space_zones:read, space_zones:write

Végpontok

  • GET /api/v1/space-zones Lista
  • GET /api/v1/space-zones/{id} Egy rekord
  • POST /api/v1/space-zones Létrehozás
  • PATCH /api/v1/space-zones/{id} Frissítés
  • DELETE /api/v1/space-zones/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
work_unit_idintegerkötelező Az egység – csak létrehozáskor.
zone_type_idinteger | null A zónatípus (lásd /space-zone-types), ha van.
namestringkötelező Név (pl. „Totem az ajtótól jobbra”).
descriptiontext | null Leírás.
width_cmnumber | null Szélesség, centiméterben.
height_cmnumber | null Magasság, centiméterben.
depth_cmnumber | null Mélység, centiméterben.
area_m2number | null Terület, négyzetméterben.
facesinteger Oldalak száma (1 vagy 2).
capacityinteger Hány darab fér el egy oldalon.
capacity_labelstring | null Mit számol a kapacitás.
is_displayboolean Bemutatófelület-e.
monthly_pricenumber | null Havi díj (csak az írhatja, aki látja a pénzügyi adatokat).
statusactive | unavailable active vagy unavailable (átmenetileg).
pin_xnumber | nullcsak olvasható Hely az egység vázlatán, százalékban balról (az alkalmazásban helyezik el).
pin_ynumber | nullcsak olvasható Hely az egység vázlatán, százalékban felülről.
sortinteger Sorrend az egységen belül.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

work_unit_idintegerCsak ennek az egységnek a zónái.
zone_type_idintegerCsak ebből a típusból.
statusactive | unavailableCsak ezzel az állapottal.
is_displaybooleantrue: csak bemutatófelületek.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/space-zones

{
    "work_unit_id": 12,
    "zone_type_id": 2,
    "name": "Ramă click intrare",
    "width_cm": 50,
    "height_cm": 70,
    "faces": 2,
    "capacity": 2,
    "capacity_label": "afișe A2",
    "is_display": true,
    "monthly_price": 150,
    "status": "active",
    "sort": 100
}

Példaválasz

{
    "data": {
        "id": 41,
        "work_unit_id": 12,
        "zone_type_id": 2,
        "name": "Ramă click intrare",
        "description": null,
        "width_cm": 50,
        "height_cm": 70,
        "depth_cm": 12.5,
        "area_m2": 12.5,
        "faces": 2,
        "capacity": 2,
        "capacity_label": "afișe A2",
        "is_display": true,
        "monthly_price": 150,
        "status": "active",
        "pin_x": 42.5,
        "pin_y": 88,
        "sort": 100,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Berendezések és díjak /shelf-fixture-types

Polcfelületek: a berendezések fajtái (gondola, gondolavég, hűtő) a díjtáblázattal – facingenként vagy polcméterenként, havonta. A díjakat csak a polcárakra vonatkozó jogosultsággal rendelkezők írhatják.

Hatókörök: shelf_fixture_types:read, shelf_fixture_types:write

Végpontok

  • GET /api/v1/shelf-fixture-types Lista
  • GET /api/v1/shelf-fixture-types/{id} Egy rekord
  • POST /api/v1/shelf-fixture-types Létrehozás
  • PATCH /api/v1/shelf-fixture-types/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név.
face_pricenumber | null Díj facingenként, havonta.
meter_pricenumber | null Díj polcméterenként, havonta.
is_activeboolean Használatban van-e még.
sortinteger Sorrend a listákban.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

is_activebooleantrue: csak a használatban lévők.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/shelf-fixture-types

{
    "name": "Gondolă",
    "face_price": 25,
    "is_active": true,
    "sort": 10
}

Példaválasz

{
    "data": {
        "id": 1,
        "name": "Gondolă",
        "face_price": 25,
        "meter_price": 12.5,
        "is_active": true,
        "sort": 10,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Planogramok /shelf-planograms

Polcfelületek: egyszer leírt planogramok – a berendezés, a méretek, a polcok fentről lefelé, azzal, hogy mi fér el mindegyiken (facingek vagy centiméterek), és az árszorzójukkal. A polcok elküldése lecseréli a polcok listáját; kampányt tartalmazó polc nem vehető el. A név egyedi.

Hatókörök: shelf_planograms:read, shelf_planograms:write

Végpontok

  • GET /api/v1/shelf-planograms Lista
  • GET /api/v1/shelf-planograms/{id} Egy rekord
  • POST /api/v1/shelf-planograms Létrehozás
  • PATCH /api/v1/shelf-planograms/{id} Frissítés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
namestringkötelező Név (egyedi).
codestring | null Belső kód.
fixture_type_idinteger | null A berendezés típusa (lásd /shelf-fixture-types).
categorystring | null Termékkategória.
width_cmnumber | null Szélesség, centiméterben.
height_cmnumber | null Magasság, centiméterben.
depth_cmnumber | null Mélység, centiméterben.
capacity_unitfaces | cm faces: a polc kapacitása facingekben; cm: centiméterben.
instructionstext | null Hogyan kell kialakítani (formázott szöveg, megtisztítva).
is_activeboolean Felállítják-e még.
shelvesarraykötelező A polcok fentről lefelé: [{label, capacity, price_factor}] (a pozíció a lista sorrendjét követi; a price_factor értéket csak az írhatja, aki látja az árakat).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

fixture_type_idintegerCsak ezzel a berendezéssel.
is_activebooleantrue: csak az aktívak.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/shelf-planograms

{
    "name": "Capăt de raft vitamine",
    "code": "CR-VIT",
    "fixture_type_id": 2,
    "category": "Suplimente",
    "width_cm": 100,
    "height_cm": 180,
    "capacity_unit": "faces",
    "is_active": true,
    "shelves": [
        {
            "position": 1,
            "label": null,
            "capacity": 8,
            "price_factor": 1.2
        },
        {
            "position": 2,
            "label": "La nivelul ochilor",
            "capacity": 8,
            "price_factor": 1.5
        }
    ]
}

Példaválasz

{
    "data": {
        "id": 4,
        "name": "Capăt de raft vitamine",
        "code": "CR-VIT",
        "fixture_type_id": 2,
        "category": "Suplimente",
        "width_cm": 100,
        "height_cm": 180,
        "depth_cm": 12.5,
        "capacity_unit": "faces",
        "instructions": null,
        "is_active": true,
        "shelves": [
            {
                "position": 1,
                "label": null,
                "capacity": 8,
                "price_factor": 1.2
            },
            {
                "position": 2,
                "label": "La nivelul ochilor",
                "capacity": 8,
                "price_factor": 1.5
            }
        ],
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Felállított planogramok /shelf-placements

Polcfelületek: egy egységben felállított planogram saját címkével, megjegyzéssel és költségekkel, csak azokban az egységekben, amelyek elrendezését a kulcs létrehozója kezeli. A törlés kiveszi az egységből: a kampányai előzményei miatt megmarad, vagy véglegesen törlődik, ha nem volt kampánya; futó kampány alatt soha. A költségeket csak az írhatja, aki látja az árakat.

Hatókörök: shelf_placements:read, shelf_placements:write

Végpontok

  • GET /api/v1/shelf-placements Lista
  • GET /api/v1/shelf-placements/{id} Egy rekord
  • POST /api/v1/shelf-placements Létrehozás
  • PATCH /api/v1/shelf-placements/{id} Frissítés
  • DELETE /api/v1/shelf-placements/{id} Törlés

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
planogram_idintegerkötelező A planogram – csak létrehozáskor.
work_unit_idintegerkötelező Az egység – csak létrehozáskor.
labelstring | null Címke, amely megkülönbözteti ugyanannak a planogramnak egy másik felállításától az egységben.
statusactive | removedcsak olvasható active vagy removed.
installed_ondate | null A felállítás dátuma.
removed_ondate | nullcsak olvasható Az eltávolítás dátuma.
local_notetext | null Miben tér el itt a szokásos planogramtól.
setup_costnumber | null Telepítési költség.
monthly_costnumber | null Havi költség itt (karbantartás, értékcsökkenés).
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

work_unit_idintegerCsak ebben az egységben.
planogram_idintegerCsak ez a planogram.
statusactive | removedCsak ezzel az állapottal.

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/shelf-placements

{
    "planogram_id": 4,
    "work_unit_id": 12,
    "label": "lângă casă",
    "installed_on": "2026-02-18",
    "monthly_cost": 25
}

Példaválasz

{
    "data": {
        "id": 88,
        "planogram_id": 4,
        "work_unit_id": 12,
        "label": "lângă casă",
        "status": "active",
        "installed_on": "2026-02-18",
        "removed_on": "2026-05-01",
        "local_note": null,
        "setup_cost": 12.5,
        "monthly_cost": 25,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Kampányok /merch-campaigns

Mindkét modul kampányai (module: spaces – bemutatózónák; shelf – planogramok polcai), a kulcs létrehozójaként írva. A kampány piszkozatként indul: az egységei (units) és az azokon belüli helyeket megnevező szabályok (rules) adják a helyeit. A launch művelet ellenőrzi a helyet, és elküldi a kampányt minden egységnek; a cancel leállítja. Az elindított kampány megtartja a dátumait és a helyeit; csak a szövege, a partnere, a pénzügyi adatai és a fotókövetelmény változhat. Az értéket és a költséget csak az írhatja, aki látja a pénzügyi adatokat.

Hatókörök: merch_campaigns:read, merch_campaigns:write

Végpontok

  • GET /api/v1/merch-campaigns Lista
  • GET /api/v1/merch-campaigns/{id} Egy rekord
  • POST /api/v1/merch-campaigns Létrehozás
  • PATCH /api/v1/merch-campaigns/{id} Frissítés
  • DELETE /api/v1/merch-campaigns/{id} Törlés
  • POST /api/v1/merch-campaigns/{id}/launch A piszkozat elindítása: a hely ellenőrzése és elküldés minden egységnek.
  • POST /api/v1/merch-campaigns/{id}/cancel Elindított kampány visszavonása: ahol még nincs kihelyezve, el sem indul, ahol már ki van helyezve, ott leszerelik.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
modulespaces | shelfkötelező spaces vagy shelf – csak létrehozáskor.
titlestringkötelező A kampány címe.
partner_idinteger | null A fizető partner (lásd /merch-partners); üres: a cég saját kampánya.
instructionstext | null Megvalósítási útmutató (formázott szöveg, megtisztítva).
starts_ondatekötelező Első nap.
ends_ondatekötelező Utolsó nap.
implement_daysinteger Hány nap áll egy egység rendelkezésére a kihelyezésre a kezdettől számítva.
remove_daysinteger Hány nap áll egy egység rendelkezésére a leszerelésre a befejezés után.
proof_requiredboolean Kell-e az egységnek fotókat küldenie a visszaigazoláskor.
valuenumber | null Amit a partner a teljes kampányért fizet, áfa nélkül.
costnumber | null Amibe a cégnek kerül (anyagok, telepítés), áfa nélkül.
currencystringcsak olvasható Az összegek pénzneme (a modul beállításaiból).
statusdraft | launched | cancelledcsak olvasható draft, launched vagy cancelled.
phasedraft | scheduled | running | ended | cancelledcsak olvasható draft, scheduled, running, ended vagy cancelled.
unitsarray Az egységek (egységazonosítók), a rules mezővel együtt.
rulesarray A helyeket megnevező szabályok, a units mezővel együtt. spaces: [{zone_type_id vagy zone_id, face (A/B), quantity}]; shelf: [{planogram_id vagy placement_id, position (polc, felülről), quantity, products}].
targetsarraycsak olvasható Az eredményül kapott helyek: egységenként a zóna és az oldal, vagy a felállítás és a polc, a mennyiséggel.
launched_atdatetime | nullcsak olvasható Az indítás ideje.
cancelled_atdatetime | nullcsak olvasható A visszavonás ideje.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

modulespaces | shelfCsak ez a modul.
statusdraft | launched | cancelledCsak ezzel az állapottal.
partner_idintegerCsak ennek a partnernek a kampányai.
active_ondateCsak az ezen a napon futók (YYYY-MM-DD).

Példakérés

POST https://compania-mea.pulsika.eu/api/v1/merch-campaigns

{
    "module": "shelf",
    "title": "Dermalab – raftul de la ochi",
    "partner_id": 3,
    "starts_on": "2026-11-02",
    "ends_on": "2026-11-30",
    "implement_days": 3,
    "remove_days": 2,
    "proof_required": true,
    "value": 9600,
    "cost": 0,
    "units": [
        12,
        13
    ],
    "rules": [
        {
            "planogram_id": 4,
            "position": 2,
            "quantity": 6,
            "products": "Vitamina D3"
        }
    ]
}

Példaválasz

{
    "data": {
        "id": 15,
        "module": "shelf",
        "title": "Dermalab – raftul de la ochi",
        "partner_id": 3,
        "instructions": null,
        "starts_on": "2026-11-02",
        "ends_on": "2026-11-30",
        "implement_days": 3,
        "remove_days": 2,
        "proof_required": true,
        "value": 9600,
        "cost": 0,
        "currency": "RON",
        "status": "draft",
        "phase": "scheduled",
        "units": [
            12,
            13
        ],
        "rules": [
            {
                "planogram_id": 4,
                "position": 2,
                "quantity": 6,
                "products": "Vitamina D3"
            }
        ],
        "targets": [
            {
                "work_unit_id": 12,
                "placement_id": 88,
                "shelf_id": 210,
                "quantity": 6,
                "products": "Vitamina D3"
            }
        ],
        "launched_at": "2026-05-01T08:00:00Z",
        "cancelled_at": "2026-05-01T08:00:00Z",
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Megvalósítás az egységekben /merch-executions

Egy elindított kampány egy egységben: ki helyezi ki és mikorra, ki van-e helyezve, elutasították-e (indoklással), leszerelés alatt áll-e, vagy lezárult. A műveletek a kulcs létrehozójaként történnek (aki ott a megvalósító, illetve a reopen esetén, aki a kampányt vezeti). A fotókat base64-képként kell küldeni; a fotókat kérő kampány nélkülük nem igazolható vissza.

Hatókörök: merch_executions:read, merch_executions:write

Végpontok

  • GET /api/v1/merch-executions Lista
  • GET /api/v1/merch-executions/{id} Egy rekord
  • POST /api/v1/merch-executions/{id}/confirm Visszaigazolás, hogy ki van helyezve (fotókkal, ha kérik).
  • POST /api/v1/merch-executions/{id}/refuse Jelzés, hogy nem helyezhető ki, indoklással.
  • POST /api/v1/merch-executions/{id}/reopen Az elutasító egység ismételt felkérése (a kampányt vezető személy).
  • POST /api/v1/merch-executions/{id}/removed Visszaigazolás, hogy az anyagokat leszerelték.

Mezők

NévTípusLeírás
idintegercsak olvasható Azonosító.
campaign_idintegercsak olvasható A kampány (lásd /merch-campaigns).
modulespaces | shelfcsak olvasható spaces vagy shelf (a kampányé).
work_unit_idintegercsak olvasható Az egység.
implementer_idinteger | nullcsak olvasható Ki valósítja meg konkrétan; üres: az egység vezetői.
statuswaiting | pending | done | refused | removing | removed | cancelledcsak olvasható waiting (még nem kezdődött), pending (kihelyezendő), done (kihelyezve), refused, removing (leszerelendő), removed vagy cancelled.
latebooleancsak olvasható A határidő után helyezték-e ki, vagy nincs kihelyezve és a határidő lejárt.
due_ondate | nullcsak olvasható Kihelyezési határidő.
done_atdatetime | nullcsak olvasható A visszaigazolás ideje.
done_byinteger | nullcsak olvasható Ki igazolta vissza.
notetext | nullcsak olvasható Megjegyzések a visszaigazolásból.
refused_atdatetime | nullcsak olvasható Az elutasítás ideje.
refused_byinteger | nullcsak olvasható Ki utasította el.
refusal_reasontext | nullcsak olvasható Miért nem valósítható meg.
remove_due_ondate | nullcsak olvasható Leszerelési határidő.
removed_atdatetime | nullcsak olvasható A leszerelés visszaigazolásának ideje.
removed_byinteger | nullcsak olvasható Ki igazolta vissza a leszerelést.
created_atdatetimecsak olvasható Létrehozva.
updated_atdatetimecsak olvasható Utolsó módosítás.

Szűrők

campaign_idintegerCsak ennek a kampánynak a megvalósításai.
work_unit_idintegerCsak ebben az egységben.
statuswaiting | pending | done | refused | removing | removed | cancelledCsak ezzel az állapottal.
modulespaces | shelfCsak ez a modul.
latebooleantrue: csak a késésben lévők.

/api/v1/merch-executions/{id}/confirm: photos (array) — Fotók: [{name, content_base64}], JPEG/PNG/WebP, egyenként legfeljebb 10 MB, legfeljebb 10 darab.; note (text) — Megjegyzések.

/api/v1/merch-executions/{id}/refuse: reason (text) — Az indoklás.

/api/v1/merch-executions/{id}/removed: photos (array) — Fotók a leszerelés után (nem kötelező): [{name, content_base64}].

Példaválasz

{
    "data": {
        "id": 501,
        "campaign_id": 15,
        "module": "shelf",
        "work_unit_id": 12,
        "implementer_id": 17,
        "status": "pending",
        "late": false,
        "due_on": "2026-11-04",
        "done_at": "2026-05-01T08:00:00Z",
        "done_by": 1,
        "note": null,
        "refused_at": "2026-05-01T08:00:00Z",
        "refused_by": 1,
        "refusal_reason": null,
        "remove_due_on": "2026-05-01",
        "removed_at": "2026-05-01T08:00:00Z",
        "removed_by": 1,
        "created_at": "2026-05-01T08:00:00Z",
        "updated_at": "2026-05-01T08:00:00Z"
    }
}

Nézze meg, hogyan működik a Pulsika az Ön csapatában

Próbálja ki ingyen az összes modult, vagy kérjen bemutatót csapatunktól. Bankkártya nem szükséges.

vagy létrehozunk Önnek egy próbacéget a saját szervezeti felépítésével