Appearance
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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ageGroup | query | AgeGroupCode | Age group as in A,B,C or I for international. | |
isKilometersBased | query | boolean | If true, the calculation is kilometers based. | |
kilometers | query | integer | Number of kilometers is filled in only if that type of benefit calculation is used. | |
emissionsValue | query | number | Car 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. | |
deduction | query | number | Deduction from salary | |
kind | query | CarBenefitKind | ||
price | query | number | Row price | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deduction | query | number | Deduction from salary | |
taxable | query | number | Taxable amount of the benefit. | |
periodDivider | query | integer | Number of periods if Kind is PeriodicalDeduction. Otherwise this value is null. | |
kind | query | BicycleBenefitKind | ||
price | query | number | Row price | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
isPaid | query | boolean | If true, the absence is paid by the employer. If null, uses the default value from the absence cause. | |
isHolidayAccrual | query | boolean | If 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. | |
applyPricing | query | boolean | If true, resolves the price for the absence day from the employee's pricing rows or holiday year | |
bonusDaysCount | query | number | Number of Bonus days to be paid. This is applicable only for AbsenceCauseCode.AnnualLeaveAnnualLeave. | |
bonus | query | number | Resolved runtime. Bonus percent for holiday bonus. | |
notes | query | string | Additional information as recorded by the Employer. | |
hasDeductionRow | query | boolean | Resolved runtime. The deduction for the standard salary will be added. | |
deductionRowType | query | CalculationRowType | Resolved runtime. Deduction row type. | |
deductionType | query | string | Resolved runtime. Deduction type. | |
deductionKind | query | string | Resolved runtime. Deduction kind. | |
deductionPrice | query | number | Resolved runtime. Deduction price. | |
monthlySalary | query | number | Resolved runtime. Monthly salary used in pricing. | |
workDaysInMonth | query | integer | Resolved runtime. Work days in month. | |
wageBasis | query | WageBasis | Resolved runtime. Wage basis. | |
holidayYear | query | integer | Holiday year to consume, if the period is outside the normal holiday pay period for the holiday year. | |
usecaseId | query | string | Usecase id. | |
kind | query | AbsenceCauseCode | ||
start | query | string | Start date of the period | |
end | query | string | End date of the period. | |
daysCount | query | number | Number 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. | |
days | query | string[] | 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. | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
isHalf | query | boolean | If 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. | |
kind | query | DailyAllowanceKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deduction | query | number | Deduction from salary | |
taxablePrice | query | number | The taxable price calculated by the server. | |
isTaxValue | query | boolean | If true, the deduction from Worker salary corresponds to taxable value. | |
isTaxValueDeductionDone | query | boolean | If true, the deduction from Worker Salary has already been done or will be done and is not added to this calculation. | |
kind | query | MealBenefitKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | NonProfitOrgKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
deduction | query | number | Deduction from salary | |
taxable | query | number | Taxable amount of the benefit. | |
periodDivider | query | integer | Number of periods if Kind is PeriodicalDeduction. Otherwise this value is null. | |
kind | query | SubsidisedCommuteKind | ||
price | query | number | Row price | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
referenceNumber | query | string | Reference for the union payment. | |
recipientFullName | query | string | The full name of the union for payment purposes. | |
iban | query | string | The International Bank Account Number of the union. | |
paymentPercentage | query | number | Percentage of the total taxable amount to pay. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits. | |
maximumPayment | query | number | Maximum payment limit, or null if not desired. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits. | |
minimumPayment | query | number | Minimum payment limit, or null if not desired. Please note that this is only applicable for UnionPaymentKind.PercentageAndLimits. | |
kind | query | UnionPaymentKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
IrData.Code | query | integer | ||
IrData.Flags | query | IrFlags[] | ||
IrData.InsuranceExceptions | query | IrInsuranceExceptions[] | ||
IrData.DailyAllowance | query | AllowanceCode[] | ||
IrData.MealBenefitIsTaxValue | query | boolean | ||
IrData.CarBenefit.CarBenefitCode | query | CarBenefitCode | ||
IrData.CarBenefit.AgeGroupCode | query | AgeGroupCode | ||
IrData.CarBenefit.Kilometers | query | integer | ||
IrData.CarBenefit.EmissionsValue | query | number | ||
IrData.NoTransactionAmount | query | boolean | ||
IrData.TaxDefault | query | IrTaxDefault | ||
unit | query | Unit | IR unit. | |
kind | query | TransactionCode | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | BoardKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | RemunerationKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
taxDefault | query | IrTaxDefault | Overrides the tax default of the income type (e.g. no tax for late-payment interest). Only supported for CapitalIncomePayment. | |
kind | query | OtherCompensationKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | WorkingTimeCompensationKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | EmploymentTerminationKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
compensationRows | query | WorkingTimeCompensationRow[] | Collection of compensation rows. | |
pricing | query | WorkingTimeCompensationPricing | Pricing for the compensation row. | |
kind | query | WorkingTimeCompensationKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
unit | query | Unit | IR unit. | |
kind | query | PaidSickLeaveKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
unit | query | Unit | IR unit. | |
kind | query | TrainingKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
referenceNumber | query | string | Reference for the payment. | |
periodLength | query | integer | Length of the salary payment period. | |
dependantsCount | query | integer | Count of dependants of the debtor. Typically spouse and children. | |
protectedPortionBase | query | number | Amount of the protected portion for each day. | |
protectedPortionDependant | query | number | Amount of the protected portion for each dependant for each day. | |
incomeFromOtherSources | query | number | Income from other sources. | |
additionalAmountLeftToDebtor | query | number | Additional amount to be left to debtor. | |
kind | query | ForeclosureKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | query | string | Id for the pay statistics type. | |
periodLength | query | PayStatsPeriodLength | Period type for the pay statistics calculation. | |
periodDateKind | query | PeriodDateKind | Date kind for the period. | |
kind | query | PayStatsKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
rowType | query | CalculationRowType | Calculation row type for adjusting the amount. | |
message | query | string | Message for the row. | |
kind | query | TotalWorkerPaymentKind | ||
price | query | number | Row price | |
count | query | number | Row 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
taxValue | query | number | Tax value is either the fixed value (euro) or percentage (0-1) depending on the kind. | |
deductionPrice | query | number | Deduction for the tax at source: Fixed, Monthly or Daily | |
deductionCount | query | number | Count of deduction units: 1 or number of months or days. | |
deduction | query | number | Value of the deduction: Deduction * DeductionCount | |
totalTaxable | query | number | Total taxable value of the salary calculation. | |
EmploymentData.Percent | query | number | ||
EmploymentData.DeductionMonthly | query | number | ||
EmploymentData.DeductionDaily | query | number | ||
allowedKinds | query | string | List of allowed kinds (deductions based on source data). Currently as a comma separated string. | |
kind | query | TaxAtSourceKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message 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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
taxValue | query | number | Tax percent (0 - 1) TaxWithholdingKind.Percentage or fixed euro amount TaxWithholdingKind.FixedValue for tax with holding. | |
kind | query | TaxWithholdingKind | ||
price | query | number | Row price | |
count | query | number | Row count, default is 1 | |
message | query | string | Message for the usecase row. |
Request body: Calculation (required)
Response: Calculation
Try it: interactive reference

