Skip to content

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 ​

ParameterInTypeRequiredDescription
tokenquerystring

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

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

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

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

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

ParameterInTypeRequiredDescription
namepathstringyesName of the metrics.
valuequerynumberValue 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.

ParameterInTypeRequiredDescription
monthquerystringAny date in the month. Default: the current month.
channelqueryPaymentChannelChannel 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

ParameterInTypeRequiredDescription
$searchquerystring
$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: Text containg metrics name and value.

Try it: interactive reference

GET /v04/api/test/serialization ​

Test JSON serialization using GET.

ParameterInTypeRequiredDescription
intValuequeryintegerTest integer.
doubleValuequerynumberTest double.
decimalValuequerynumberTest decimal.
stringValuequerystringTest string.
dateTimeValuequerystringTest DateTime.
dateValuequerystringTest Date.
boolValuequerybooleanTest bool.
objectValuequeryobjectTest object.
arrayValuequerystring[]Test array
enumValuequeryTestEnumTest enum
dictValuequeryobjectFree 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.

ParameterInTypeRequiredDescription
langpathLanguageyesLanguage for which the text is fetched.
keypathstringyesTranslation 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.

ParameterInTypeRequiredDescription
testIdsquerystring[]Array of test IDs.

Response: string

Try it: interactive reference

POST /v04/api/test/testNullableBoolean ​

ParameterInTypeRequiredDescription
myValuequeryboolean

Response: OK

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.