Skip to content

Import ​

Beta

Salaxy API v04 is in beta: it may change, and it is not used in production yet. Build on v03, the current version.

Controller for mass imports.

Salaxy API v04 (beta), Finland only. 8 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/import/companies ​

Creates or assures the posted customer companies in the system. Checks required authorizations for the calling account. Please note that this method is only for TRUSTED partners.

Request body: CompanyImport[] (required)

Response: CompanyImport[]

Try it: interactive reference

POST /v04/api/import/workers ​

Creates or assures the posted worker employment relations in the system.

Request body: WorkerImport[] (required)

Response: WorkerImport[]

Try it: interactive reference

POST /v04/api/import/calculations ​

Adds posted calculations to a new or existing payroll object. The existing payroll object is search by company official id, salary date and source id

ParameterInTypeRequiredDescription
isMergequerybooleanIf true, the included calculations should be merged into the existing calculations.
rowMergeOptionqueryRowMergeOptionMerging option for the rows.
sourceIdquerystringSource id for the merged rows. Please note that if the RowMergeOption is RemoveImportedRows and the source ID is set, only the rows with the given source ID will be removed, otherwise if the source ID is not set, all rows with any source ID will be removed.
applyEmploymentDefaultRowsquerybooleanIf true, any calculation should be added with the default rows from the employment.
applyWorktimequerybooleanIf true, resolves, recalculates and updates holidays and absences to the given calculations.

Request body: CalculationImport[] (required)

Response: CalculationImport[]

Try it: interactive reference

POST /v04/api/import/invoicing/{channel} ​

Creates invoices for given payroll objects.

ParameterInTypeRequiredDescription
channelpathPaymentChannelyesPayment channel to use.

Request body: InvoicingRequest[] (required)

Response: InvoicingRequest[]

Try it: interactive reference

POST /v04/api/import/einvoicing ​

Sends the invoices as einvoices.

Request body: EInvoicingRequest[] (required)

Response: EInvoicingRequest[]

Try it: interactive reference

POST /v04/api/import/invoice-settings-check/{type} ​

Checks the invoice settings for the company.

ParameterInTypeRequiredDescription
typepathstringyesCheck target: "sepa" for sepa-payments, or "eInvoice" for eInvoice -payments.

Request body: InvoiceSettingsCheck[] (required)

Response: InvoiceSettingsCheck[]

Try it: interactive reference

POST /v04/api/import/workers-check ​

Checks the existence of given workers. The id for worker can be worker ID, social security number of employment ID.

Request body: WorkerCheck[] (required)

Response: WorkerCheck[]

Try it: interactive reference

GET /v04/api/import/einvoice/receiver ​

Queries the eInvoice address for the given official id (Y-tunnus).

ParameterInTypeRequiredDescription
officialIdquerystringThe official identifier of the company (Y-tunnus).

Response: EInvoiceAddress[]

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.