Appearance
Account
Read and update access to Palkkaus-account: Person or Company accounts that are currently in use as well as Worker Accounts that are created under this account.
Salaxy API v03, Finland only. 24 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/accounts/company
Gets the current company account if the current account is a company
Response: CompanyAccount
Try it: interactive reference
POST /v03/api/accounts/company
Saves the company account.
Request body: CompanyAccount (required)
Response: CompanyAccount
Try it: interactive reference
GET /v03/api/accounts/person
Gets the current Person account: Either the current account or the Primary contact person account if the current account is a company.
Response: PersonAccount
Try it: interactive reference
POST /v03/api/accounts/person
Saves the person account.
Request body: PersonAccount (required)
Response: PersonAccount
Try it: interactive reference
POST /v03/api/accounts/avatar
Saves the avatar file for the account, does not save the account and avatar.
Request body: object (required)
Response: Avatar
Try it: interactive reference
POST /v03/api/accounts/switchRole
Switches the role of the current user between Worker and Household
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
role | query | WebSiteUserRole | The user role |
Response: WebSiteUserRole
Try it: interactive reference
POST /v03/api/accounts/certificate
Issues a new X.509 certificate for the account in PFX (PKCS12) format for Microsoft / Windows systems.
Request body: Certificate (required)
Response: Certificate
Try it: interactive reference
GET /v03/api/accounts/certificate
Lists existing X.509 certificates for the account.
Response: Certificate[]
Try it: interactive reference
POST /v03/api/accounts/certificate/pem
Issues a new certificate for the account and provides the certificate in PEM format. For this method, also the Certificate Signing Request (CSR) may be passed in the certificate Text field.
Request body: Certificate (required)
Response: IssuedCertificate
Try it: interactive reference
DELETE /v03/api/accounts/certificate/{id}
Revokes existing X.509 certificate from the account.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Certificate (thumbprint) to revoke. |
Response: string
Try it: interactive reference
GET /v03/api/accounts/authorizingAccount
Lists all accounts on behalf of which this account has been authorized to act.
Response: AccountBase[]
Try it: interactive reference
DELETE /v03/api/accounts/authorizingAccount/{id}
Deletes the account. Restricted to the test system only.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Id of the account which should be deleted. |
Response: string
Try it: interactive reference
GET /v03/api/accounts/authorizedAccount
Lists all accounts to which this account has given authorizations.
Response: AuthorizedAvatar[]
Try it: interactive reference
POST /v03/api/accounts/authorizedAccount
Allow an account to act on behalf of this account.
Request body: AuthorizedAvatar (required)
Response: AuthorizedAvatar
Try it: interactive reference
DELETE /v03/api/accounts/authorizedAccount/{id}
Disallow an account to act on behalf of this account.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Account who is no more authorized to act on behalf of this account. |
Response: string
Try it: interactive reference
GET /v03/api/accounts/credential
Lists all credentials which can access to this account.
Response: SessionUserCredential[]
Try it: interactive reference
POST /v03/api/accounts/credential
Updates the credential.
Request body: SessionUserCredential (required)
Response: SessionUserCredential
Try it: interactive reference
DELETE /v03/api/accounts/credential/{id}
Remove the credential linked to the account.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Credential (id) to remove. |
Response: string
Try it: interactive reference
POST /v03/api/accounts/credential/{id}/avatar
Changes the avatar file for the credential, does not save the credential. It requires a separate save.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Request body: object (required)
Response: SessionUserCredential
Try it: interactive reference
POST /v03/api/accounts/credential/avatar
Changes the avatar file for the credential, does not save the credential. It requires a separate save.
Request body: object (required)
Response: SessionUserCredential
Try it: interactive reference
GET /v03/api/accounts/workflows
Returns workflow data for the given API object.
Response: WorkflowData
Try it: interactive reference
POST /v03/api/accounts/workflows
Adds or updates workflow event for the given API object.
Request body: WorkflowEvent (required)
Response: WorkflowData
Try it: interactive reference
GET /v03/api/accounts/workflows/events/{eventId}
Returns workflow event for the given API object and event id.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
eventId | path | string | yes | Unique id for the event. |
Response: WorkflowEvent
Try it: interactive reference
DELETE /v03/api/accounts/workflows/{eventIdOrType}
Deletes the workflow event from the given API object.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
eventIdOrType | path | string | yes | Id or type of the event to delete. |
Response: string
Try it: interactive reference

