Skip to content

Payroll ​

Beta

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

Payroll Controller provides CRUD functionality as well as additional methods for Payroll objects

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

Performs an OData query to the search index.

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

Try it: interactive reference

POST /v04/api/payroll ​

Updates or creates a new Payroll object.

ParameterInTypeRequiredDescription
applyEmploymentDefaultRowsquerybooleanIf true, when creating a new payroll, the default rows from the employment should be updated.

Request body: PayrollDetails (required)

Response: PayrollDetails

Try it: interactive reference

GET /v04/api/payroll/{id} ​

Gets a single Payroll object based on identier.

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: PayrollDetails

Try it: interactive reference

DELETE /v04/api/payroll/{id} ​

Deletes a Payroll object from the storage

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object.

Response: string

Try it: interactive reference

GET /v04/api/payroll/new ​

Factory method that creates a new Payroll object

Response: PayrollDetails

Try it: interactive reference

POST /v04/api/payroll/{id}/employments ​

Adds new calculations based on given employments to the Payroll and saves the Payroll object.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.

Request body: string[] (required)

Response: CalculationListItem[]

Try it: interactive reference

GET /v04/api/payroll/{id}/calcs ​

Performs an OData query to the search index containing payroll calculations.

ParameterInTypeRequiredDescription
idpathstringyes
$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: PageResultOfCalculationListItem

Try it: interactive reference

POST /v04/api/payroll/{id}/calcs ​

Adds/updates the calculations for a Payroll and returns the added/updated calculations as list items.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.
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: PayrollCalculationsCollection (required)

Response: CalculationListItem[]

Try it: interactive reference

DELETE /v04/api/payroll/{id}/calcs/{calcId} ​

Removes the calculation from the payroll and saves the payroll object. This can only be done if the calculation and the payroll have not been paid yet.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.
calcIdpathstringyesThe id of the calculation to be removed from the Payroll list.
deletequerybooleanIf true the calculation is completely deleted, otherwise only unlinked.

Response: PayrollDetails

Try it: interactive reference

POST /v04/api/payroll/{id}/cancel-invoices ​

Cancels the invoice or payment processing for the given Payroll calculations.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.
excludePeriodicInvoicesquerybooleanIf true, does not return periodic invoices. Only calculation specific invoices are returned.

Request body: string[] (required)

Response: PayrollDetails

Try it: interactive reference

POST /v04/api/payroll/{id}/preview-invoices ​

Previews the invoices for the given Payroll calculations.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.
excludePeriodicInvoicesquerybooleanIf true, does not return periodic invoices. Only calculation specific invoices are returned.

Request body: string[] (required)

Response: InvoicePreview[]

Try it: interactive reference

POST /v04/api/payroll/{id}/create-invoices ​

Creates the invoices for the given Payroll calculations.

ParameterInTypeRequiredDescription
idpathstringyesThe id of the Payroll.
excludePeriodicInvoicesquerybooleanIf true, does not return periodic invoices. Only calculation specific invoices are returned.

Request body: string[] (required)

Response: Invoice[]

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.