Appearance
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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
$search | query | string | ||
$filter | query | string | Specifies the logic to pull back a subset of records. | |
$orderby | query | string | Specifies the values used to sort the collection of entries. | |
$select | query | string | The $select system query option allows the clients to requests a limited set of properties for each entry. | |
$top | query | number | Specifies the subset of entries by count. | |
$skip | query | number | Specifies the count of entries to skip. | |
$count | query | boolean | Indicates 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
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object |
Response: HolidayYear
Try it: interactive reference
DELETE /v04/api/holidays/{id}
Deletes an object from the storage
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | path | integer | yes | The 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
employmentId | path | string | yes | Identifier 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
employmentId | path | string | yes | The 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().
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
employmentId | path | string | yes | The 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
employmentId | path | string | yes | The 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
employmentIds | query | string[] | 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | path | integer | yes | The holiday year for the calculation. |
employmentId | path | string | yes | The 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | path | integer | yes | Holiday year |
employmentId | path | string | yes | Employment 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
year | path | integer | yes | Holiday year |
Response: HolidayYear[]
Try it: interactive reference

