Skip to content

HolidayYears ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Holiday Years Controller provides CRUD functionality as well as additional methods for Holiday Year objects

Salaxy API v04 (beta), Finland only. 15 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v04/api/holidays ​

Performs an OData query to the search index.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfHolidayYearListItem

Try it: interactive reference

POST /v04/api/holidays ​

Updates or creates a new object

Request body: HolidayYear (required)

Response: HolidayYear

Try it: interactive reference

GET /v04/api/holidays/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object

Response: HolidayYear

Try it: interactive reference

DELETE /v04/api/holidays/{id} ​

Deletes an object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/holidays/new ​

Factory method that creates a new object

Response: HolidayYear

Try it: interactive reference

GET /v04/api/holidays/year/{year} ​

Gets all the Holiday Year objects of specified year.

ParameterInTypeRequiredDescription
yearpathintegeryesThe holiday year to filter

Response: HolidayYear[]

Try it: interactive reference

GET /v04/api/holidays/year/all ​

Gets all the Holiday Year objects.

Response: HolidayYear[]

Try it: interactive reference

POST /v04/api/holidays/employment/{employmentId} ​

Initializes the missing holiday years for an employment relation.

ParameterInTypeRequiredDescription
employmentIdpathstringyesIdentifier of the Employment relation that stores the holiday specification.

Request body: HolidaySpecificationForYear (required)

Response: HolidayYear[]

Try it: interactive reference

GET /v04/api/holidays/employment/{employmentId} ​

Gets the Holiday Year objects for a specific Employment relation.

ParameterInTypeRequiredDescription
employmentIdpathstringyesThe employment relation for which to list the Holiday Years.

Response: HolidayYear[]

Try it: interactive reference

GET /v04/api/holidays/employment/{employmentId}/default-spec ​

Gets a default holiday specification based on employment relation information. This is presented to the user before calling InitHolidaysForEmploymentId().

ParameterInTypeRequiredDescription
employmentIdpathstringyesThe employment relation ID from which the defaults are fetched.

Response: HolidaySpecificationForYear

Try it: interactive reference

GET /v04/api/holidays/employment/{employmentId}/available-holiday-accruals ​

Returns current remaining accrued holiday days and bonuses.

ParameterInTypeRequiredDescription
employmentIdpathstringyesThe employment relation ID from which the accruals are fetched.

Response: object[]

Try it: interactive reference

GET /v04/api/holidays/employment/set ​

Returns Holiday Year objects for given Employment relations.

ParameterInTypeRequiredDescription
employmentIdsquerystring[]Set of employmentIds for which to get the Holiday Year objects.

Response: HolidayYear[]

Try it: interactive reference

GET /v04/api/holidays/year/{year}/{employmentId}/holiday-pay-calc ​

Returns the holiday pay calculation report for the given employment relation and holiday year.

ParameterInTypeRequiredDescription
yearpathintegeryesThe holiday year for the calculation.
employmentIdpathstringyesThe employment relation for which to list the Holiday Years.

Response: HolidayPayCalculationReportData

Try it: interactive reference

POST /v04/api/holidays/year/{year}/{employmentId}/holiday-pay/recalculate ​

Recalculates holiday pay for the given employment relation and holiday year.

ParameterInTypeRequiredDescription
yearpathintegeryesHoliday year
employmentIdpathstringyesEmployment relation

Response: HolidayYear

Try it: interactive reference

POST /v04/api/holidays/year/{year}/holiday-pay/recalculate ​

Recalculates holiday pay for all employment relations for the given holiday year.

ParameterInTypeRequiredDescription
yearpathintegeryesHoliday year

Response: HolidayYear[]

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.