← Référence API

Temps & Présence

Temps de travail, congés, plannings et jours fériés — enregistrez et lisez la présence par programmation.

Temps de Travail

Points de terminaison

GET	/employee-working-hours	Retrieves the collection of WorkTime resources.
POST	/employee-working-hours	Creates a WorkTime resource.
GET	/employee-working-hours/{id}	Retrieves a WorkTime resource.
PATCH	/employee-working-hours/{id}	Updates the WorkTime resource.
DELETE	/employee-working-hours/{id}	Removes the WorkTime resource.
GET	/work-times	Retrieves the collection of WorkTime resources.
POST	/work-times	Creates a WorkTime resource.
GET	/work-times/{id}	Retrieves a WorkTime resource.
PATCH	/work-times/{id}	Updates the WorkTime resource.
DELETE	/work-times/{id}	Removes the WorkTime resource.

Champs de schéma

Champ	Type	Description
id	integer
employee*	string (iri-reference)
project*	string (iri-reference)
date*	string (date-time)
seconds*	integer
description	stringnull
projectTask	string,null (iri-reference)	Optional link to a {@see ProjectTask}. Nullable; existing rows have no link. Set by the Surface 1 picker chip and by Surface 2's close-and-log panel. The validator {@see \App\Validator\WorkTime\WorkTi
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
deleted	boolean	Check if the entity has been soft deleted.

Congé

Points de terminaison

GET	/holidays	Retrieves the collection of Holiday resources.
POST	/holidays	Creates a Holiday resource.
GET	/holidays/{id}	Retrieves a Holiday resource.
PATCH	/holidays/{id}	Updates the Holiday resource.
DELETE	/holidays/{id}	Removes the Holiday resource.
GET	/holidays/active	Retrieves the collection of Holiday resources.

Champs de schéma

Champ	Type	Description
id	integer
type	string
employee*	string (iri-reference)
manager	string (iri-reference)
description	stringnull
dateFrom	string (date-time)
dateTo	string (date-time)
seconds	integernull
requestedSeconds	integernull
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.

Planning

Points de terminaison

GET	/schedules	Retrieves the collection of Schedule resources.
POST	/schedules	Creates a Schedule resource.
GET	/schedules/{id}	Retrieves a Schedule resource.
PATCH	/schedules/{id}	Updates the Schedule resource.
GET	/schedules/plan/{date}	Retrieves the collection of Schedule resources.

Champs de schéma

Champ	Type	Description
name	string
description	stringnull
numberOfDays	integer
regular	boolean
overwriteBankHolidays	boolean
scheduleRanges	array
scheduleEmployees	array

Jour Férié

Points de terminaison

GET	/bank-holidays	Retrieves the collection of BankHoliday resources.
POST	/bank-holidays	Creates a BankHoliday resource.
GET	/bank-holidays/{id}	Retrieves a BankHoliday resource.
PATCH	/bank-holidays/{id}	Updates the BankHoliday resource.
DELETE	/bank-holidays/{id}	Removes the BankHoliday resource.
GET	/holiday-days-frees	Retrieves the collection of BankHoliday resources.
POST	/holiday-days-frees	Creates a BankHoliday resource.
GET	/holiday-days-frees/{id}	Retrieves a BankHoliday resource.
PATCH	/holiday-days-frees/{id}	Updates the BankHoliday resource.
DELETE	/holiday-days-frees/{id}	Removes the BankHoliday resource.

Champs de schéma

Champ	Type	Description
date*	string
publicNotes	stringnull
yearFrom	integernull
yearTo	integernull