İçeriğe geç

İzin

İzin uçları: parametreler, alanlar ve örnek yanıtlar.

Geliştirici belgesi

İzin bakiyelerini listeler

GET /api/v1/leave-balances

Kapsam: leave:read

Bakiye tutan izin türlerinde çalışan başına bakiye. Sıra çalışan ve tür kimliğine göredir. Türü gizli iznin bakiyesi yalnız field:health kapsamı ve rolün health alan sınıfı olan anahtara döner. Örnek kayıtlar listeye girmez.

Parametreler

leave_balances.list: Parametreler
AlanTürAçıklama
employee_id (sorgu)string (uuid)Yalnız bu çalışanın bakiyeleri.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

leave_balances.list: Listedeki her öğe (data[])
AlanTürAçıklama
employee_idstring (uuid)zorunlu
leave_type_idstring (uuid)zorunlu
unitstringzorunlu Değerler: day, hour
balancenumberzorunluDefter toplamı; ileri tarihli onaylı izinler düşülmüştür.
reservednumberzorunluOnay bekleyen taleplerin toplamı.
availablenumberzorunluKullanılabilir bakiye: balance eksi reserved.
Örnek yanıt
{
  "data": [
    {
      "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "leave_type_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
      "unit": "day",
      "balance": 9,
      "reserved": 2,
      "available": 7
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

İzin taleplerini listeler

GET /api/v1/leave-requests

Kapsam: leave:read

Anahtarın kapsamındaki çalışanların izin talepleri. Not ve belge dönmez. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez. Örnek kayıtlar listeye girmez.

Parametreler

leave_requests.list: Parametreler
AlanTürAçıklama
employee_id (sorgu)string (uuid)Yalnız bu çalışanın talepleri.
from (sorgu)string (date)Bitişi bu günden önce olmayan talepler (YYYY-MM-DD).
status (sorgu)stringYalnız bu durumdaki talepler; süzgeç görünen duruma bakar. Türü gizli talep awaiting_document ve rejected ile eşleşmez; pending ve cancelled ile eşleşir. Değerler: awaiting_document, pending, approved, rejected, cancelled
to (sorgu)string (date)Başlangıcı bu günden sonra olmayan talepler (YYYY-MM-DD).
updated_since (sorgu)string (date-time)Yalnız updated_at değeri bu andan büyük ya da eşit olan kayıtlar (saat dilimi taşıyan ISO 8601). Kapsayıcıdır: son gördüğünüz updated_at değerini gönderin ve kimlikle tekilleştirin.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

leave_requests.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
employee_idstring (uuid)zorunlu
type_hiddenbooleanzorunlutrue ise izin türü bu anahtara gizlidir: leave_type_id, half_day, amount, unit ve paid null gelir; "belge bekliyor" durumu pending, ret cancelled görünür (olay akışında da öyle).
leave_type_idstring (uuid)zorunlunull olabilirİzin türü; tür gizliyse null.
statusstringzorunluawaiting_document: belge bekleniyor; pending: onay bekliyor; approved: onaylandı; rejected: reddedildi; cancelled: iptal edildi. Değerler: awaiting_document, pending, approved, rejected, cancelled
start_datestring (date)zorunlu
end_datestring (date)zorunlu
half_daybooleanzorunlunull olabilir
amountnumberzorunlunull olabilirSüre, unit biriminde (gün ya da saat).
unitstringzorunlunull olabilir Değerler: day, hour
paidbooleanzorunlunull olabilir
is_demobooleanzorunluTalep örnek veriyle gelen bir çalışanındır. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluTalebin bu anahtara görünen hâlinin son değiştiği an (UTC). Türü gizli talepte yalnız açılış, karar ve iptal bu değeri değiştirir.
Örnek yanıt
{
  "data": [
    {
      "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "type_hidden": false,
      "leave_type_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
      "status": "approved",
      "start_date": "2026-07-06",
      "end_date": "2026-07-10",
      "half_day": false,
      "amount": 5,
      "unit": "day",
      "paid": true,
      "is_demo": false,
      "created_at": "2026-06-15T11:20:00.000Z",
      "updated_at": "2026-06-16T08:05:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek izin talebini döndürür

GET /api/v1/leave-requests/{id}

Kapsam: leave:read

Not ve belge dönmez. Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

leave_requests.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluİzin talebinin kimliği.

Yanıtlar

200 Başarılı

leave_requests.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
employee_idstring (uuid)zorunlu
type_hiddenbooleanzorunlutrue ise izin türü bu anahtara gizlidir: leave_type_id, half_day, amount, unit ve paid null gelir; "belge bekliyor" durumu pending, ret cancelled görünür (olay akışında da öyle).
leave_type_idstring (uuid)zorunlunull olabilirİzin türü; tür gizliyse null.
statusstringzorunluawaiting_document: belge bekleniyor; pending: onay bekliyor; approved: onaylandı; rejected: reddedildi; cancelled: iptal edildi. Değerler: awaiting_document, pending, approved, rejected, cancelled
start_datestring (date)zorunlu
end_datestring (date)zorunlu
half_daybooleanzorunlunull olabilir
amountnumberzorunlunull olabilirSüre, unit biriminde (gün ya da saat).
unitstringzorunlunull olabilir Değerler: day, hour
paidbooleanzorunlunull olabilir
is_demobooleanzorunluTalep örnek veriyle gelen bir çalışanındır. Liste uçları örnek kayıtları döndürmez; tek kayıt okuması döndürür ve bu alan true olur.
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluTalebin bu anahtara görünen hâlinin son değiştiği an (UTC). Türü gizli talepte yalnız açılış, karar ve iptal bu değeri değiştirir.
Örnek yanıt
{
  "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
  "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "type_hidden": false,
  "leave_type_id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
  "status": "approved",
  "start_date": "2026-07-06",
  "end_date": "2026-07-10",
  "half_day": false,
  "amount": 5,
  "unit": "day",
  "paid": true,
  "is_demo": false,
  "created_at": "2026-06-15T11:20:00.000Z",
  "updated_at": "2026-06-16T08:05:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

İzin türlerini listeler

GET /api/v1/leave-types

Kapsam: leave:read

Hazır türler (company_id null) ve anahtarın kapsamındaki şirketlerin kendi türleri. Sıra kimliğe göredir ve kararlıdır; toplam sayı dönmez.

Parametreler

leave_types.list: Parametreler
AlanTürAçıklama
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

leave_types.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlunull olabilirTürün şirketi; hazır türde null.
codestringzorunlunull olabilir
namestringzorunlu
paidbooleanzorunlu
unitstringzorunlu Değerler: day, hour
requires_documentbooleanzorunlu
tracks_balancebooleanzorunlu
allow_half_daybooleanzorunlu
calendar_visibilitystringzorunluhidden: bu türdeki talebin türü, tutarı ve belge durumu yalnız field:health kapsamı ve rolün health alan sınıfı olan anahtara gider. Değerler: named, hidden
activebooleanzorunlu
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "data": [
    {
      "id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
      "company_id": null,
      "code": null,
      "name": "Mazeret izni",
      "paid": true,
      "unit": "day",
      "requires_document": false,
      "tracks_balance": true,
      "allow_half_day": true,
      "calendar_visibility": "named",
      "active": true,
      "created_at": "2026-01-05T08:00:00.000Z",
      "updated_at": "2026-01-05T08:00:00.000Z"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Tek izin türünü döndürür

GET /api/v1/leave-types/{id}

Kapsam: leave:read

Anahtarın görmediği kayıt ile var olmayan kayıt aynı 404 yanıtını alır.

Parametreler

leave_types.get: Parametreler
AlanTürAçıklama
id (yol)string (uuid)zorunluİzin türünün kimliği.

Yanıtlar

200 Başarılı

leave_types.get: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlunull olabilirTürün şirketi; hazır türde null.
codestringzorunlunull olabilir
namestringzorunlu
paidbooleanzorunlu
unitstringzorunlu Değerler: day, hour
requires_documentbooleanzorunlu
tracks_balancebooleanzorunlu
allow_half_daybooleanzorunlu
calendar_visibilitystringzorunluhidden: bu türdeki talebin türü, tutarı ve belge durumu yalnız field:health kapsamı ve rolün health alan sınıfı olan anahtara gider. Değerler: named, hidden
activebooleanzorunlu
created_atstring (date-time)zorunlu
updated_atstring (date-time)zorunluKaydın kendi alanlarının son değiştiği an (UTC).
Örnek yanıt
{
  "id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
  "company_id": null,
  "code": null,
  "name": "Mazeret izni",
  "paid": true,
  "unit": "day",
  "requires_document": false,
  "tracks_balance": true,
  "allow_half_day": true,
  "calendar_visibility": "named",
  "active": true,
  "created_at": "2026-01-05T08:00:00.000Z",
  "updated_at": "2026-01-05T08:00:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout