Appearance
Partner
Beta
Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.
Methods restricted to Authroized partners. NOTE: With production data, these methods require Approved Partner status!
Salaxy API v04 (beta), Finland only. 4 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.
POST /v04/api/partner/company
TRUSTED PARTNERS: Gets the public company account information if account has already been created for the company official Id (Y-tunnus in Finnish). If the account does not exist, an account stub is created based on the official Id. In production, this method is available to trusted partners only. NOTE: This method cannot be called with Partner's own Company ID (as of 07/2019) to assure access to partners own account. This would be a security risk in some partner scenarios and the action does not make sense: Just use the partner account directly.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
checkAuthorizationOnly | query | boolean | Does not create a new company, but checks the authorization for the given company. |
Request body: AssureCompanyAccountRequest (required)
Response: PartnerCompanyAccountInfo
Try it: interactive reference
POST /v04/api/partner/assureworker
TRUSTED PARTNERS: Assures that there is a Worker account to which Salaxy can pay salaries. If the account does not exist, an account stub is created based on the official Id. In production, this method is available to trusted partners only.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
officialId | query | string | Social security number for the person: Henkilötunnus, HETU in Finnish | |
firstName | query | string | First name of the person | |
lastName | query | string | Last name of the person | |
email | query | string | Contact e-mail | |
telephone | query | string | Telephone number for the contact person | |
bankAccountIban | query | string | Optional bank account IBAN number. | |
bankAccountBic | query | string | ||
startDate | query | string | Optinal start date of the employment relation. | |
endDate | query | string | Optinal end date of the employment relation. | |
language | query | Language | Language preference. |
Response: WorkerAccount
Try it: interactive reference
POST /v04/api/partner/assureworker/{id}
TRUSTED PARTNERS: Assures that there is a Worker account to which Salaxy can pay salaries. If the account does not exist, an account stub is created based on the existing employer created worker. In production, this method is available to trusted partners only.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID of the employer created worker. |
Response: WorkerAccount
Try it: interactive reference
POST /v04/api/partner/clear/{partnerId}
Clears partner data.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
partnerId | path | string | yes | Partner id |
Response: —
Try it: interactive reference

