Polska firma — tworzymy w Polsce

Czas i frekwencja

Czas pracy, urlopy, harmonogramy i święta — rejestruj i odczytuj frekwencję programowo.

Ta dokumentacja jest generowana ze schematu API. Opisy pól oraz wszelkie teksty, które nie zostały jeszcze przetłumaczone, są wyświetlane po angielsku.

Czas pracy

Endpoints

Czas pracy: Endpoints
Metoda	Ścieżka	Opis
GET	/employee-working-hours	Pobiera kolekcję zasobów WorkTime.
POST	/employee-working-hours	Tworzy zasób WorkTime.
GET	/employee-working-hours/{id}	Pobiera zasób WorkTime.
PATCH	/employee-working-hours/{id}	Aktualizuje zasób WorkTime.
DELETE	/employee-working-hours/{id}	Usuwa zasób WorkTime.
GET	/work-times	Pobiera kolekcję zasobów WorkTime.
POST	/work-times	Tworzy zasób WorkTime.
GET	/work-times/{id}	Pobiera zasób WorkTime.
PATCH	/work-times/{id}	Aktualizuje zasób WorkTime.
DELETE	/work-times/{id}	Usuwa zasób WorkTime.

Pola schematu

Czas pracy: Pola schematu
Pole	Typ	Opis
id	integer
employee*	string (iri-reference)
project*	string (iri-reference)
date*	string (date-time)
seconds*	integer
description	stringnull
projectTask	string,null (iri-reference)
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.

Urlop

Endpoints

Urlop: Endpoints
Metoda	Ścieżka	Opis
GET	/holidays	Pobiera kolekcję zasobów Holiday.
POST	/holidays	Tworzy zasób Holiday.
GET	/holidays/{id}	Pobiera zasób Holiday.
PATCH	/holidays/{id}	Aktualizuje zasób Holiday.
DELETE	/holidays/{id}	Usuwa zasób Holiday.
GET	/holidays/active	Pobiera kolekcję zasobów Holiday.

Pola schematu

Urlop: Pola schematu
Pole	Typ	Opis
id	integer
type*	string
employee*	string (iri-reference)
manager	string (iri-reference)
description	stringnull	#4548, and it is reachable two ways: written directly through `holiday:create`, and copied from the accepted request by `HolidayRequestDecider:47`. Both columns are VARCHAR(255), so bounding the request at 255 keeps that copy safe — this bounds the direct path.
dateFrom*	string (date-time)
dateTo*	string (date-time)
seconds	integernull
requestedSeconds	integernull
notify	boolean	Should this absence tell the employee it was created?
payrollEligible	boolean	May payroll act on this absence?
holidayRequests	array
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
employeeFullname	string
employeeReversedFullname	string
relatedEmployee	string,null (iri-reference)
deleted	boolean	Check if the entity has been soft deleted.

Harmonogram

Endpoints

Harmonogram: Endpoints
Metoda	Ścieżka	Opis
GET	/schedules	Pobiera kolekcję zasobów Schedule.
POST	/schedules	Tworzy zasób Schedule.
GET	/schedules/{id}	Pobiera zasób Schedule.
PATCH	/schedules/{id}	Aktualizuje zasób Schedule.
GET	/schedules/plan/{date}	Pobiera kolekcję zasobów Schedule.

Pola schematu

Harmonogram: Pola schematu
Pole	Typ	Opis
name	string
description	stringnull
numberOfDays	integer
regular	boolean
overwriteBankHolidays	boolean
scheduleRanges	array
scheduleEmployees	array

Dzień wolny od pracy

Endpoints

Dzień wolny od pracy: Endpoints
Metoda	Ścieżka	Opis
GET	/bank-holidays	Pobiera kolekcję zasobów BankHoliday.
POST	/bank-holidays	Tworzy zasób BankHoliday.
GET	/bank-holidays/{id}	Pobiera zasób BankHoliday.
PATCH	/bank-holidays/{id}	Aktualizuje zasób BankHoliday.
DELETE	/bank-holidays/{id}	Usuwa zasób BankHoliday.
GET	/holiday-days-frees	Pobiera kolekcję zasobów BankHoliday.
POST	/holiday-days-frees	Tworzy zasób BankHoliday.
GET	/holiday-days-frees/{id}	Pobiera zasób BankHoliday.
PATCH	/holiday-days-frees/{id}	Aktualizuje zasób BankHoliday.
DELETE	/holiday-days-frees/{id}	Usuwa zasób BankHoliday.

Pola schematu

Dzień wolny od pracy: Pola schematu
Pole	Typ	Opis
date*	string
publicNotes	stringnull
yearFrom	integernull
yearTo	integernull

Wniosek urlopowy

Endpoints

Wniosek urlopowy: Endpoints
Metoda	Ścieżka	Opis
GET	/holiday-requests	Pobiera kolekcję zasobów HolidayRequest.
POST	/holiday-requests	Tworzy zasób HolidayRequest.
GET	/holiday-requests/{id}	Pobiera zasób HolidayRequest.
PATCH	/holiday-requests/{id}	Aktualizuje zasób HolidayRequest.
DELETE	/holiday-requests/{id}	Usuwa zasób HolidayRequest.
POST	/holiday-requests/{id}/approve	Tworzy zasób HolidayRequest.
POST	/holiday-requests/{id}/reject	Tworzy zasób HolidayRequest.

Pola schematu

Wniosek urlopowy: Pola schematu
Pole	Typ	Opis
id	integer
status	string
employee	string (iri-reference)
holiday	string,null (iri-reference)
type*	string
description	stringnull
dateFrom*	string (date-time)
dateTo*	string (date-time)
seconds	integernull
requestedSeconds	integernull
holidayRequestLogs	array
createdAt	string (date-time)
updatedAt	string (date-time)
requestedAt	datetime

Rodzaj urlopu

Endpoints

Rodzaj urlopu: Endpoints
Metoda	Ścieżka	Opis
GET	/holiday-types	Pobiera kolekcję zasobów HolidayType.
POST	/holiday-types	Tworzy zasób HolidayType.
GET	/holiday-types/{id}	Pobiera zasób HolidayType.
PATCH	/holiday-types/{id}	Aktualizuje zasób HolidayType.

Pola schematu

Rodzaj urlopu: Pola schematu
Pole	Typ	Opis
status	string
name*	string
color	string
descriptionRequired	boolean
icon	stringnull
reducesWorkingTime	boolean	Does an absence of this type reduce the month's expected working hours?
requiresApproval	boolean	Does an absence of this type have to be approved by somebody?

Limit dni urlopowych

Endpoints

Limit dni urlopowych: Endpoints
Metoda	Ścieżka	Opis
GET	/holiday-days-limits	Pobiera kolekcję zasobów HolidayDaysLimit.
POST	/holiday-days-limits	Tworzy zasób HolidayDaysLimit.
GET	/holiday-days-limits/{id}	Pobiera zasób HolidayDaysLimit.
PATCH	/holiday-days-limits/{id}	Aktualizuje zasób HolidayDaysLimit.
DELETE	/holiday-days-limits/{id}	Usuwa zasób HolidayDaysLimit.

Pola schematu

Limit dni urlopowych: Pola schematu
Pole	Typ	Opis
id	integer
employee*	string (iri-reference)
seconds*	integer	Leave allowance in SECONDS, not whole days.
holidayType	string,null (iri-reference)
variant*	string
allowRequestWhenUsed	boolean
dateFrom	string (date-time)
notes	stringnull
createdAt	string (date-time)
updatedAt	string (date-time)
notApplicableReason	stringnull	Why this entitlement will not take effect yet, or NULL if it will.
vacationLimit	boolean	Is this row the ANNUAL LEAVE entitlement, as opposed to a granted balance of some other type?
relatedEmployee	string,null (iri-reference)

Domyślny limit dni urlopowych

Endpoints

Domyślny limit dni urlopowych: Endpoints
Metoda	Ścieżka	Opis
GET	/holiday-days-limit-defaults	Pobiera kolekcję zasobów HolidayDaysLimitDefault.
POST	/holiday-days-limit-defaults	Tworzy zasób HolidayDaysLimitDefault.
GET	/holiday-days-limit-defaults/{id}	Pobiera zasób HolidayDaysLimitDefault.
PATCH	/holiday-days-limit-defaults/{id}	Aktualizuje zasób HolidayDaysLimitDefault.
DELETE	/holiday-days-limit-defaults/{id}	Usuwa zasób HolidayDaysLimitDefault.

Pola schematu

Domyślny limit dni urlopowych: Pola schematu
Pole	Typ	Opis
id	string
holidayType	string (iri-reference)
seconds*	integer	Default leave allowance in SECONDS, not whole days. This entity moves with `HolidayDaysLimit` rather than after it: both are returned through the same line in `HolidaysHelper::getHolidayDaysLimit()`, so leaving one in days would put two units on one code path.
variant*	string
allowRequestWhenUsed	boolean
dateFrom	string (date-time)
createdAt	string (date-time)
updatedAt	string (date-time)

Pracownik harmonogramu

Endpoints

Pracownik harmonogramu: Endpoints
Metoda	Ścieżka	Opis
GET	/schedule-employees	Pobiera kolekcję zasobów ScheduleEmployee.
POST	/schedule-employees	Tworzy zasób ScheduleEmployee.
GET	/schedule-employees/{id}	Pobiera zasób ScheduleEmployee.
PATCH	/schedule-employees/{id}	Aktualizuje zasób ScheduleEmployee.
DELETE	/schedule-employees/{id}	Usuwa zasób ScheduleEmployee.

Pola schematu

Pracownik harmonogramu: Pola schematu
Pole	Typ	Opis
employee	string (iri-reference)
schedule	string (iri-reference)
dateFrom	string (date-time)
dateTo	string,null (date-time)
type	string
notifiedAt	string,null (date-time)

Zakres harmonogramu

Endpoints

Zakres harmonogramu: Endpoints
Metoda	Ścieżka	Opis
GET	/schedule-ranges	Pobiera kolekcję zasobów ScheduleRange.
POST	/schedule-ranges	Tworzy zasób ScheduleRange.
GET	/schedule-ranges/{id}	Pobiera zasób ScheduleRange.
PATCH	/schedule-ranges/{id}	Aktualizuje zasób ScheduleRange.
DELETE	/schedule-ranges/{id}	Usuwa zasób ScheduleRange.

Pola schematu

Zakres harmonogramu: Pola schematu
Pole	Typ	Opis
id	string
schedule	object
day	integer
timeFrom	integer
timeTo	integer
name	stringnull

Delegacja

Endpoints

Delegacja: Endpoints
Metoda	Ścieżka	Opis
GET	/delegations	Pobiera kolekcję zasobów Delegation.
POST	/delegations	Tworzy zasób Delegation.
GET	/delegations/{id}	Pobiera zasób Delegation.
PATCH	/delegations/{id}	Aktualizuje zasób Delegation.
DELETE	/delegations/{id}	Usuwa zasób Delegation.

Pola schematu

Delegacja: Pola schematu
Pole	Typ	Opis
id	integer
employee*	string (iri-reference)
project	string,null (iri-reference)	Nullable: a historical trip may name no project, and it must still be recorded.
projectTask	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
seconds	integernull	Optional: the source history carries days, not hours.
description	stringnull
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
days	integer	Calendar days covered, INCLUSIVE — a trip that starts and ends on the same day is one day, not zero. This is the unit the travel analytics report, because the source history counts days rather than hours.
deleted	boolean	Check if the entity has been soft deleted.