Skip to content

Settings ​

View and update settings for the service.

Salaxy API v03, Finland only. 21 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/settings/company ​

Returns the main account settings for company employers. This is the full set of employer settings.

Response: CompanyAccountSettings

Try it: interactive reference

POST /v03/api/settings/company ​

Saves the main account settings for company employers.

Request body: CompanyAccountSettings (required)

Response: CompanyAccountSettings

Try it: interactive reference

GET /v03/api/settings/irCertificate ​

Get current Incomes Register certificate details.

Response: object

Try it: interactive reference

POST /v03/api/settings/irCertificate ​

Create a new Incomes Register certificate.

ParameterInTypeRequiredDescription
transferIdquerystring
transferPasswordquerystring

Response: object

Try it: interactive reference

POST /v03/api/settings/irCertificate/renew ​

Renews an existing Incomes Register certificate.

Response: object

Try it: interactive reference

GET /v03/api/settings/brands ​

Returns all brands in service models.

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: PageResultOfBrandListItem

Try it: interactive reference

GET /v03/api/settings/layout/{id} ​

Gets the layout template.

ParameterInTypeRequiredDescription
idpathstringyesId of the layout template in format id@owner

Response: ReportingLayoutTemplate

Try it: interactive reference

Gets the logo for the layout template.

ParameterInTypeRequiredDescription
idpathstringyesId of the logo in format id@owner

Response: string

Try it: interactive reference

GET /v03/api/settings/primary-partners ​

Returns the primary partners.

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: PageResultOfPrimaryPartnerListItem

Try it: interactive reference

GET /v03/api/settings/ytj-companies ​

Makes a search to ytj for companies.

ParameterInTypeRequiredDescription
searchquerystringSarch text. Company name or business id.

Response: AccountInIndex[]

Try it: interactive reference

GET /v03/api/settings/partners ​

Returns the partners.

ParameterInTypeRequiredDescription
searchquerystringSearch text. Company name or business id.

Response: AccountInIndex[]

Try it: interactive reference

GET /v03/api/settings/dimensions ​

Returns all the cost accounting dimensions for the account.

Response: CostAccountingDimensionDefinition[]

Try it: interactive reference

POST /v03/api/settings/dimensions ​

Saves a single cost accounting dimensions for the account.

Request body: CostAccountingDimensionDefinition (required)

Response: CostAccountingDimensionDefinition

Try it: interactive reference

GET /v03/api/settings/dimensions/{id} ​

Returns a single cost accounting dimension for the account.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for the dimension.

Response: CostAccountingDimensionDefinition

Try it: interactive reference

DELETE /v03/api/settings/dimensions/{id} ​

Removes a single cost accounting dimension from the account.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier for the dimension.

Response: string

Try it: interactive reference

POST /v03/api/settings/dimensions/all ​

Saves the cost accounting dimensions for the account. Please note that this method replaces all the dimensions with the posted dimensions.

Request body: CostAccountingDimensionDefinition[] (required)

Response: CostAccountingDimensionDefinition[]

Try it: interactive reference

GET /v03/api/settings/pensionContracts ​

Returns all the pension contracts for the account.

Response: PensionContract[]

Try it: interactive reference

POST /v03/api/settings/pensionContracts ​

Saves a single pension contract for the account.

Request body: PensionContract (required)

Response: PensionContract

Try it: interactive reference

GET /v03/api/settings/pensionContracts/{contractNumber} ​

Returns a single pension contract for the account.

ParameterInTypeRequiredDescription
contractNumberpathstringyesPension contract number.

Response: PensionContract

Try it: interactive reference

DELETE /v03/api/settings/pensionContracts/{contractNumber} ​

Removes a single pension contract from the account.

ParameterInTypeRequiredDescription
contractNumberpathstringyesThe number for the pension contract.

Response: string

Try it: interactive reference

POST /v03/api/settings/pensionContracts/all ​

Saves the pension contracts for the account. Please note that this method replaces all the pension contracts with the posted pension contracts.

Request body: PensionContract[] (required)

Response: PensionContract[]

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.