Skip to content

Employment ​

Employment relations between employers and workers. This is the primary method for Employers to manage their workers.

Salaxy API v03, Finland only. 9 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 /v03/api/employments ​

Performs an OData query to the employment relations in search index.

ParameterInTypeRequiredDescription
$searchquerystring
activeDatequerystringProvides a helper for filtering only active employment relations. You can provide an ISO date (yyyy-mm-dd) to list only employments that are active on a specific date. Set to "today" for today's date. Default "all" lists all employments: active and passive.
$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: PageResultOfEmploymentListItem

Try it: interactive reference

POST /v03/api/employments ​

Adds or Updates an employment relation this Employer has created (Owned by this employer). Workers cannot update employment relations.

Request body: Employment (required)

Response: Employment

Try it: interactive reference

GET /v03/api/employments/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object

Response: Employment

Try it: interactive reference

DELETE /v03/api/employments/{id} ​

Deletes a worker account that this Employer has created (Owned by this employer). The methods looks for the WorkerAccount, deletes it and also deletes all the employment relations, taxcards, holidays and absences. This method will fail if there are any calculations (paid or draft in WorkerAccount) or if the person is the contact person for the current company.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier of the worker account that will be deleted.

Response: string

Try it: interactive reference

POST /v03/api/employments/{id}/pay-stats/recalculate ​

Recalculates pay statistics for the given employment relation.

ParameterInTypeRequiredDescription
idpathstringyesEmployment relation

Response: Employment

Try it: interactive reference

POST /v03/api/employments/pay-stats/recalculate ​

Recalculates pay statistics for all employment relations of the current employer.

Response: boolean

Try it: interactive reference

GET /v03/api/employments/active ​

Gets all the active employment relations (the full payload).

ParameterInTypeRequiredDescription
datequerystringDate for which the employment relation should be active. Defaults to today.

Response: Employment[]

Try it: interactive reference

GET /v03/api/employments/employing ​

Performs an OData query to the employment relations for the current user (Worker). Worker can list and search all employers which have employed the worker.

Response: PageResultOfEmploymentListItem

Try it: interactive reference

GET /v03/api/employments/employing/{id} ​

Returns employer public employment profile for the employed Worker.

ParameterInTypeRequiredDescription
idpathstringyesId@owner for the employment.

Response: EmployingRelation

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.