Skip to content

RowUsecases ​

Beta

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

Strongly typed and stand-alone test methods for the calculation rows usecases.

Salaxy API v04 (beta), Finland only. 22 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/row-usecases/CarBenefit ​

Stand-alone test method for CarBenefit usecase.

ParameterInTypeRequiredDescription
ageGroupqueryAgeGroupCodeAge group as in A,B,C or I for international.
isKilometersBasedquerybooleanIf true, the calculation is kilometers based.
kilometersqueryintegerNumber of kilometers is filled in only if that type of benefit calculation is used.
emissionsValuequerynumberCar emissions value The car emissions value must be greater than or equal to 0, and smaller than or equal to 100. The car emissions value can only be reported if the payment date or other reporting date is in 2022–2025.
deductionquerynumberDeduction from salary
kindqueryCarBenefitKind
pricequerynumberRow price
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/BicycleBenefit ​

Stand-alone test method for BicycleBenefit usecase.

ParameterInTypeRequiredDescription
deductionquerynumberDeduction from salary
taxablequerynumberTaxable amount of the benefit.
periodDividerqueryintegerNumber of periods if Kind is PeriodicalDeduction. Otherwise this value is null.
kindqueryBicycleBenefitKind
pricequerynumberRow price
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/AbsencePeriod ​

Stand-alone test method for AbsencePeriod usecase.

ParameterInTypeRequiredDescription
isPaidquerybooleanIf true, the absence is paid by the employer. If null, uses the default value from the absence cause.
isHolidayAccrualquerybooleanIf true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual. By default, you may leave this null and it always follows the IsPaid.
applyPricingquerybooleanIf true, resolves the price for the absence day from the employee's pricing rows or holiday year
bonusDaysCountquerynumberNumber of Bonus days to be paid. This is applicable only for AbsenceCauseCode.AnnualLeaveAnnualLeave.
bonusquerynumberResolved runtime. Bonus percent for holiday bonus.
notesquerystringAdditional information as recorded by the Employer.
hasDeductionRowquerybooleanResolved runtime. The deduction for the standard salary will be added.
deductionRowTypequeryCalculationRowTypeResolved runtime. Deduction row type.
deductionTypequerystringResolved runtime. Deduction type.
deductionKindquerystringResolved runtime. Deduction kind.
deductionPricequerynumberResolved runtime. Deduction price.
monthlySalaryquerynumberResolved runtime. Monthly salary used in pricing.
workDaysInMonthqueryintegerResolved runtime. Work days in month.
wageBasisqueryWageBasisResolved runtime. Wage basis.
holidayYearqueryintegerHoliday year to consume, if the period is outside the normal holiday pay period for the holiday year.
usecaseIdquerystringUsecase id.
kindqueryAbsenceCauseCode
startquerystringStart date of the period
endquerystringEnd date of the period.
daysCountquerynumberNumber of days in the range. Depending of the context, this may be mathematical (end - start) or explicitly specified (typically working days). Typically an integer, and calculations and UI's may choose to round it.
daysquerystring[]The collection of days contained in the DateRange if specified by the user. Alternative to DaysCount. If set, should also set DaysCount for backward compatibility.
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/DailyAllowance ​

Stand-alone test method for DailyAllowance usecase.

ParameterInTypeRequiredDescription
isHalfquerybooleanIf true, the daily allowance is paid in half: The Worker has received 2 free meals (1 if PartialDailyAllowance). This information is currently not reported to Incomes Register, it is only as information for calculation.
kindqueryDailyAllowanceKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/MealBenefit ​

Stand-alone test method for MealBenefit usecase.

ParameterInTypeRequiredDescription
deductionquerynumberDeduction from salary
taxablePricequerynumberThe taxable price calculated by the server.
isTaxValuequerybooleanIf true, the deduction from Worker salary corresponds to taxable value.
isTaxValueDeductionDonequerybooleanIf true, the deduction from Worker Salary has already been done or will be done and is not added to this calculation.
kindqueryMealBenefitKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/NonProfitOrg ​

Stand-alone test method for NonProfitOrg usecase.

ParameterInTypeRequiredDescription
kindqueryNonProfitOrgKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/SubsidisedCommute ​

Stand-alone test method for SubsidisedCommute usecase.

ParameterInTypeRequiredDescription
deductionquerynumberDeduction from salary
taxablequerynumberTaxable amount of the benefit.
periodDividerqueryintegerNumber of periods if Kind is PeriodicalDeduction. Otherwise this value is null.
kindquerySubsidisedCommuteKind
pricequerynumberRow price
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/UnionPayment ​

Stand-alone test method for UnionPayment usecase.

ParameterInTypeRequiredDescription
referenceNumberquerystringReference for the union payment.
recipientFullNamequerystringThe full name of the union for payment purposes.
ibanquerystringThe International Bank Account Number of the union.
paymentPercentagequerynumberPercentage of the total taxable amount to pay. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits.
maximumPaymentquerynumberMaximum payment limit, or null if not desired. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits.
minimumPaymentquerynumberMinimum payment limit, or null if not desired. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits.
kindqueryUnionPaymentKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/IrIncomeType ​

Stand-alone test method for IrIncomeType usecase.

ParameterInTypeRequiredDescription
IrData.Codequeryinteger
IrData.FlagsqueryIrFlags[]
IrData.InsuranceExceptionsqueryIrInsuranceExceptions[]
IrData.DailyAllowancequeryAllowanceCode[]
IrData.MealBenefitIsTaxValuequeryboolean
IrData.CarBenefit.CarBenefitCodequeryCarBenefitCode
IrData.CarBenefit.AgeGroupCodequeryAgeGroupCode
IrData.CarBenefit.Kilometersqueryinteger
IrData.CarBenefit.EmissionsValuequerynumber
IrData.NoTransactionAmountqueryboolean
IrData.TaxDefaultqueryIrTaxDefault
unitqueryUnitIR unit.
kindqueryTransactionCode
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/Board ​

Stand-alone test method for Board usecase.

ParameterInTypeRequiredDescription
kindqueryBoardKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/Remuneration ​

Stand-alone test method for Remuneration usecase.

ParameterInTypeRequiredDescription
kindqueryRemunerationKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/OtherCompensation ​

Stand-alone test method for OtherCompensation usecase.

ParameterInTypeRequiredDescription
taxDefaultqueryIrTaxDefaultOverrides the tax default of the income type (e.g. no tax for late-payment interest). Only supported for CapitalIncomePayment.
kindqueryOtherCompensationKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/WorkingTimeCompensation ​

Stand-alone test method for WorkingTimeCompensation usecase.

ParameterInTypeRequiredDescription
kindqueryWorkingTimeCompensationKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/EmploymentTermination ​

Stand-alone test method for EmploymentTermination usecase.

ParameterInTypeRequiredDescription
kindqueryEmploymentTerminationKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/HourlySalaryWithWorkingTimeCompensation ​

Stand-alone test method for HourlySalaryWithWorkingTimeCompensation usecase.

ParameterInTypeRequiredDescription
compensationRowsqueryWorkingTimeCompensationRow[]Collection of compensation rows.
pricingqueryWorkingTimeCompensationPricingPricing for the compensation row.
kindqueryWorkingTimeCompensationKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/PaidSickLeave ​

Stand-alone test method for PaidSickLeave usecase.

ParameterInTypeRequiredDescription
unitqueryUnitIR unit.
kindqueryPaidSickLeaveKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/Training ​

Stand-alone test method for Training usecase.

ParameterInTypeRequiredDescription
unitqueryUnitIR unit.
kindqueryTrainingKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/Foreclosure ​

Stand-alone test method for Foreclosure usecase.

ParameterInTypeRequiredDescription
referenceNumberquerystringReference for the payment.
periodLengthqueryintegerLength of the salary payment period.
dependantsCountqueryintegerCount of dependants of the debtor. Typically spouse and children.
protectedPortionBasequerynumberAmount of the protected portion for each day.
protectedPortionDependantquerynumberAmount of the protected portion for each dependant for each day.
incomeFromOtherSourcesquerynumberIncome from other sources.
additionalAmountLeftToDebtorquerynumberAdditional amount to be left to debtor.
kindqueryForeclosureKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/PayStats ​

Stand-alone test method for PayStats usecase.

ParameterInTypeRequiredDescription
idquerystringId for the pay statistics type.
periodLengthqueryPayStatsPeriodLengthPeriod type for the pay statistics calculation.
periodDateKindqueryPeriodDateKindDate kind for the period.
kindqueryPayStatsKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/TotalWorkerPayment ​

Stand-alone test method for TotalWorkerPayment usecase.

ParameterInTypeRequiredDescription
rowTypequeryCalculationRowTypeCalculation row type for adjusting the amount.
messagequerystringMessage for the row.
kindqueryTotalWorkerPaymentKind
pricequerynumberRow price
countquerynumberRow count, default is 1

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/TaxAtSource ​

Stand-alone test method for TaxAtSource usecase.

ParameterInTypeRequiredDescription
taxValuequerynumberTax value is either the fixed value (euro) or percentage (0-1) depending on the kind.
deductionPricequerynumberDeduction for the tax at source: Fixed, Monthly or Daily
deductionCountquerynumberCount of deduction units: 1 or number of months or days.
deductionquerynumberValue of the deduction: Deduction * DeductionCount
totalTaxablequerynumberTotal taxable value of the salary calculation.
EmploymentData.Percentquerynumber
EmploymentData.DeductionMonthlyquerynumber
EmploymentData.DeductionDailyquerynumber
allowedKindsquerystringList of allowed kinds (deductions based on source data). Currently as a comma separated string.
kindqueryTaxAtSourceKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

Try it: interactive reference

POST /v04/api/row-usecases/TaxWithholding ​

Stand-alone test method for TaxWithholding usecase.

ParameterInTypeRequiredDescription
taxValuequerynumberTax percent (0 - 1) TaxWithholdingKind.Percentage or fixed euro amount TaxWithholdingKind.FixedValue for tax with holding.
kindqueryTaxWithholdingKind
pricequerynumberRow price
countquerynumberRow count, default is 1
messagequerystringMessage for the usecase row.

Request body: Calculation (required)

Response: Calculation

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.