Skip to content

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.

ParameterInTypeRequiredDescription
checkAuthorizationOnlyquerybooleanDoes 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.

ParameterInTypeRequiredDescription
officialIdquerystringSocial security number for the person: Henkilötunnus, HETU in Finnish
firstNamequerystringFirst name of the person
lastNamequerystringLast name of the person
emailquerystringContact e-mail
telephonequerystringTelephone number for the contact person
bankAccountIbanquerystringOptional bank account IBAN number.
bankAccountBicquerystring
startDatequerystringOptinal start date of the employment relation.
endDatequerystringOptinal end date of the employment relation.
languagequeryLanguageLanguage 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.

ParameterInTypeRequiredDescription
idpathstringyesID of the employer created worker.

Response: WorkerAccount

Try it: interactive reference

POST /v04/api/partner/clear/{partnerId} ​

Clears partner data.

ParameterInTypeRequiredDescription
partnerIdpathstringyesPartner id

Response: —

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.