Appearance
Test
Beta
Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.
Test methods for various purposes.
Salaxy API v04 (beta), Finland only. 20 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/test/token
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
token | query | string |
Response: string
Try it: interactive reference
GET /v04/api/test/hello
Basic hello world message
Response: string
Try it: interactive reference
GET /v04/api/test/hello/{message}
Basic hello world message
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
message | path | string | yes | This text is mirrored in response. |
Response: string
Try it: interactive reference
GET /v04/api/test/user-name
Gets the user name of the current user. Requires authorization.
Response: The user name of the current user.
Try it: interactive reference
GET /v04/api/test/user-name-allow-anon
Gets the user name of the current user. DOES NOT require authorization.
Response: The user name of the current user or "Anonymous" if not authenticated.
Try it: interactive reference
GET /v04/api/test/authorization
Basic welcome message with authorization.
Response: string
Try it: interactive reference
GET /v04/api/test/delay
Test a long lasting request. Returns the incoming parameter. Available in test environment only.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
seconds | query | integer | Delay in seconds. |
Response: integer
Try it: interactive reference
POST /v04/api/test/values
Test JSON serialization.
Request body: TestValues (required)
Response: TestValues
Try it: interactive reference
POST /v04/api/test/accounts
Creates a test account and returns test account details. Available in test environment only.
Request body: Onboarding (required)
Response: TestAccountInfo
Try it: interactive reference
DELETE /v04/api/test/accounts/{id}
Deletes a test account. Available in test environment only.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Identifier of the account. |
Response: string
Try it: interactive reference
GET /v04/api/test/exceptions/{type}
Throws an exception. Used in testing error handling and alert user interfaces.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
type | path | ApiTestErrorType | yes | Type of error to throw |
Response: Always throws an exception.
Try it: interactive reference
POST /v04/api/test/federation
Gets a test message for federation
Request body: FederationSampleViewModel (required)
Response: FederationSampleViewModel
Try it: interactive reference
GET /v04/api/test/metrics/{name}
Reports a metrics value for the AppInsight.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name of the metrics. |
value | query | number | Value of the metrics. |
Response: Text containg metrics name and value.
Try it: interactive reference
POST /v04/api/test/invoices/tax
Test environment only: rebuilds the current account's Tax invoice for a month from the month's paid salaries and releases it to the payment channel at once, also for the current month. This lets a partner or a customer test the Tax payment without waiting for the monthly run. A read or paid Tax invoice blocks the rebuild: cancel it first. Company accounts only, as in the AdminWeb rebuild.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
month | query | string | Any date in the month. Default: the current month. | |
channel | query | PaymentChannel | Channel for a new invoice. Default: the channel of the month's existing Tax invoice. |
Response: Invoice[]
Try it: interactive reference
GET /v04/api/test/odata
Tests the OData parsing as an nonymous method
| 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: Text containg metrics name and value.
Try it: interactive reference
GET /v04/api/test/serialization
Test JSON serialization using GET.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
intValue | query | integer | Test integer. | |
doubleValue | query | number | Test double. | |
decimalValue | query | number | Test decimal. | |
stringValue | query | string | Test string. | |
dateTimeValue | query | string | Test DateTime. | |
dateValue | query | string | Test Date. | |
boolValue | query | boolean | Test bool. | |
objectValue | query | object | Test object. | |
arrayValue | query | string[] | Test array | |
enumValue | query | TestEnum | Test enum | |
dictValue | query | object | Free values dictionary. |
Response: TestValues
Try it: interactive reference
POST /v04/api/test/serialization
Test JSON serialization using POST.
Request body: TestValues (required)
Response: TestValues
Try it: interactive reference
GET /v04/api/test/text/{lang}/{key}
Gets a text from the translations dictionary.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
lang | path | Language | yes | Language for which the text is fetched. |
key | path | string | yes | Translation key. E.g. "SALAXY.EMAIL.MailAfterPaymentHandledEmployer.subject" returns "Maksoit palkan työntekijällesi" in with "fi". |
Response: string
Try it: interactive reference
GET /v04/api/test/testList
Returns a list of test IDs as a comma-separated string.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
testIds | query | string[] | Array of test IDs. |
Response: string
Try it: interactive reference
POST /v04/api/test/testNullableBoolean
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
myValue | query | boolean |
Response: OK
Try it: interactive reference

