Skip to content

Calculator ​

Anonymous methods for calculating salary previews and testing without committing data to database.

Salaxy API v03, Finland only. 14 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/calculator/new ​

Factory method that creates a new Calculation object

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/recalculate ​

Takes in a calculation and recalculates it.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/recalculate-worktime ​

Recalculates the Worktime into the rest of the calculation: Mainly adds (recreates) rows for absences and holidays to the calculation.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/recalculate-worktime/{type} ​

Returns the planned absence, holiday salary or holiday compensations rows based on holiday/absence calendar and settings or given periods.

ParameterInTypeRequiredDescription
typepathstringyesType of the planned rows.

Request body: PlannedRowsRequest (required)

Response: UserDefinedRow[]

Try it: interactive reference

POST /v03/api/calculator/worktime ​

Gets the worktime data for Period recalculation from raw calc, holidays andabsences data. These determine how holiday salaries etc. and absence deductions will be added as rows to calculations. The idea is that user can still modify these before the actual calculation is done as often manual adjustments need to be made. Also, providers that do not use HolidayYears and Absences can skip this step and use recalculate-worktime directly. NOTE: This is the anonymous method that can be called without storage. There is a corresponding method in Calculations-service that fetches the holidayYear and Absences automatically.

Request body: PeriodRecalculationData (required)

Response: CalcWorktime

Try it: interactive reference

POST /v03/api/calculator/salary ​

Sets the salary for the calculation and returns it with full recalculated data.

ParameterInTypeRequiredDescription
kindquerySalaryKindType of the salary being calculated
amountquerynumberAmount of e.g. hours, months for the salary. Default is 1.
pricequerynumberPrice of one unit - e.g. hour, month.
unitquerystringE.g. hour, month. Typically this parameter can be left empty/null and the unit is set according to type.
messagequerystringOptional message for the salary row that is shown in reports. If null, will be set according to type.
isHouseholdDeductiblequerybooleanIf set to true, will calculate the household deduction. Applies only to natural persons - as oppsed to companies.
taxDeductionCategoriesqueryTaxDeductionWorkCategoriesIf tax IsHouseholdDeductible is set to true, please also select the category (categories). Note that "OwnPropety" is a default, it does not need to be set: Only set RelativesProperty if necessary.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/workerset ​

Sets the a worker with the specified ID to the given calculation and returns the calculation with full data.

ParameterInTypeRequiredDescription
profileIdquerystringText identifying the person that should be set as the Worker. Value is one of the following: 1) Guid: Identifier of the real existing Person object 2) "me": Sets the current authenticated user as the worker 3) "new": Creates a new Person object that is editable by the employer and sets that as the Worker 4) "example-[17/pensioner/default]": Sets the Person as one of the predefined example Persons

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/taxdeduction ​

Sets the household deduction true or false and returns the calculation with full data.

ParameterInTypeRequiredDescription
setHouseHoldDeductionquerybooleanIf true, the household deduction (kotitalousvähennys) is calculated as part of the salary calculation.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/work ​

Stores information about the work type start- and end date as well as Framework and returns the calculation with full data.

ParameterInTypeRequiredDescription
typequeryFrameworkAgreementType of the work framework
subTypequeryTesSubtypeSubtype when one framework has several options
isTesIncludedInSalaryquerybooleanMarker that the payments defined by framework agreement are included in the salary (will not be added by the calculation).
unionPaymentqueryUnionPaymentTypeType of the union payment
unionPaymentPercentquerynumberPercent of the union payment
numberOfDaysqueryintegerNumber of days may affect calculation of different payments calculated based on a Framework agreement
dailyTravelExpensesquerynumberTravel expences per day
dailyTravelExpensesKmquerynumberThe amount of kilometers travelled by day - used to define the amount of travel expenses in aomse framework agreements.
dailyExpensesquerynumberDaily expenses amount
isYksityisenHoidonTukiquerybooleanIf true will calculate the Finnish child care subsidy
yksityisenHoidonTukiAmountquerynumberAmount of Finnish child care subsidy
isEntrepreneurPensionContractquerybooleanIf true, the Worker has his own entrepreneur contract.
isEntrepreneurPensionContractForFarmerquerybooleanIf true, the Worker has his own Pension farmer contract.
isEntrepreneurPensionContractForAthletequerybooleanIf true, the Worker has his own Pension farmer contract.
startDatequerystringWork start date
endDatequerystringWork end date
descriptionquerystringDetail description of the work (e.g. when framework is Other).

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/setunionpayment ​

Changes the union payment for the calculation and returns it with full data recalculated.

ParameterInTypeRequiredDescription
paymentTypequeryUnionPaymentTypeType of the union payment - some known types also se the the percent (e.g. Raksa).
unionPaymentPercentquerynumberPercent for the union payment- default is zero.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/addrow ​

Adds a calculation row: An expenses, benefits or other such row and returns the recalculated calculation with full data.

ParameterInTypeRequiredDescription
rowTypequeryCalculationRowTypeType of the calculation row that should be added
messagequerystringMessage text for end user - used in salary calculation
pricequerynumberPrice for the row (e.g. €/h, €/km, €/month. Default is 0.
countquerynumberCount of the items - default is 1.
sourceIdquerystring

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v03/api/calculator/deleterow ​

Deletes a calculation row: Expenses, benefits etc. item and returns the recalculated calculation with full data.

ParameterInTypeRequiredDescription
rowIndexqueryintegerZero based row index of the row that should be deleted.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

GET /v03/api/calculator/yearlyNumbers/{forDate} ​

Gets salary calculation parameters that are changing yearly. The method is designed for the end-of-year and as such it only supports 2 years: the current / previous year (from Jan to Nov) OR current / next year (in approx. December).

ParameterInTypeRequiredDescription
forDatepathstringyesDate for which the numbers are fetched

Response: YearlyChangingNumbers

Try it: interactive reference

GET /v03/api/calculator/yearlyHolidays/{forDate} ​

Returns holidays for the given year.

ParameterInTypeRequiredDescription
forDatepathstringyesYear for which the holidays are fetched

Response: YearlyHolidays

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.