DecCF./ˈdɛk.ɛf/

Nordic household and housing

Use modules['nordic-household'].nordicHousehold(options) to declare a household with local income, payments, housing and loans. It returns an ordinary model. Select this module in model settings; its national dependencies are included. The Nordic household · local cash and assessments example uses one model source and five editable country scenarios.

Choose one country and its local currency. Amounts are local units, never FX conversions. Use plain numeric inputs when the same input structure will be used for different local currencies; explicit Money retains its denomination and a foreign currency fails. Periods are monthly, start on the first day and stay in

  1. A selected mortgage rule must already be effective on the model date.

The salary payment above is DKK 20,000 per month. The classified annual AM tax basis, DKK 238,812, is already after DKK 99 monthly ATP; this classification is explicit data, not inferred from the bank payment. The entered withholding and employee premium are each paid once. The null pension profile explicitly omits pension assessment while retaining the entered ATP cash payment.

Arguments and local profiles

country, currency, timeline, members, loans, ruleVersions, tax, pension, housing and expenses are required. name defaults to Nordic household; openingCash defaults to zero. preconditions optionally provides your named inputs or input domain; other referenced input roots are collected automatically. scenarios accepts the ordinary maximum of five named scenario suggestions. Optional incomes.salary / incomes.pension replace the member cash sources with declared period sources, such as curves; they do not change the separately supplied classified tax bases.

Optional calculator accepts the standard calculator metadata, including defaultRun. The example is ready to run 64 Monte Carlo simulations with Sobol. Saved run settings still take precedence over model defaults.

Members are a keyed input.objectArray with id, name, dateOfBirth, salary, pension, taxPayment and pensionPayment. The four amounts are monthly local payments; pension is an actual pension payout and pensionPayment is the employee's actual pension/insurance premium. Extra member fields can supply the national profiles through members.item.data. Add or edit rows to recalculate each person's assessment and postings. Loans are another keyed objectArray with id, openingBalance, nominal fractional annualRate, contractual monthly payment and optional monthly extraPayment. Payments stop at repayment.

Optional loanRateAdjustment accepts a finite number, numeric input or numeric calculation. Each month it adds the same annual rate change to every loan row's annualRate, floored at zero. Its units are decimal percentage points: 0.01 adds one percentage point. The loan plan converts this nominal annual rate to monthly interest. Contractual payments stay unchanged; the interest/principal split and remaining debt change. Omit the option to retain the original row rates exactly. Nonfinite values, unsupported sources and undeclared calculation dependencies fail normal validation.

In the example bind.sample shares one annual market shock across all loans, including a partial first year. Ordinary unseeded calculation uses its zero mean, so the baseline row rates stay unchanged. Hidden distributions still need to be declared in preconditions; uncertainty parameters are not form controls. This option does not alter policy stress rates, tax rules or the supported 2026 timeline.

ruleVersions, tax, pension and housing.conditions are country-keyed maps. The selected country's entries are mandatory; unselected countries are not evaluated. Rule choices are distinct from the installed module's package version. Profile values can contain ordinary input references and repeated row projections. Tax/pension data must be available before period-end payments. Swedish taxBases accept annual amount sources only, without {amount, period} wrappers. Unknown basis names fail rather than silently removing taxable income. Dates and birth years come from the member/timeline; contradictory profile identities or years fail.

CountryCurrencyTax rule choice and local requirementsPension sliceMortgage version / conditions
SESEK2025; taxBases.employment, taxBases.pension, actual rules.municipalRate; explicit project2025Rules:true for the 2026 planning timelineDated occupational agreement id, basisSource, inputs; pension version equals the selected profile's validFrom2026-04-01; purpose
DKDKK2026.1; full-year residency, classified annual salary/pension, actual municipal rate, single civil status and explicit false senior/single-parent supplements2026.1.0, atp-a-monthly, covered monthly hours and payroll basis source2025-11-18; propertyType
FIEUR2026.1; full-year, mainland, actual municipal rate and annual salary/pension; the native package rejects mixed positive income classes2026.1.0, tyel-accrual, insured annual earnings and basis source2025-03-24; firstHome
ISISK2026.1; full-year, annual period, classified salary/pension, actual municipal rate; pension deductions use actual payments2026.1.0, mandatory-minimum, insured monthly earnings and basis source2025-11-04; firstTimeBuyer, loanType
NONOK2026.1; full-year, classified annual salary, explicit region; actual false trial-selection confirmation for affected birth years. Pension-income tax is unsupported2026.1.0, national-insurance-accrual, annual pensionable earnings, supported birth cohort and basis source2024-12-31; loanType

The native tax and pension references document all additional optional fields, defaults, rounding and exclusions. No country uses a Swedish fallback. Swedish 2025 tax projected into 2026 remains clearly labelled as a planning assumption, not verified 2026 tax law. Finland's older mortgage source decision is retained explicitly rather than described as a newly verified rule.

Payments, assessments and balances

Each person has a bank, income and expense accounts. Net cash is transferred to the shared household through balanced owner contributions; an individual deficit is funded in the reverse direction. Housing, living costs and posted loan plans use the shared bank. Loan principal reduces a liability, while interest remains an expense. Opening home value and loan principal establish balances, not income or consumption. There is no automatic savings/pension asset revaluation.

Published metricMeaningAnnual aggregation
grossIncomeSalary plus actual pension payoutsSum
taxPaymentsEntered cash withholding/tax paymentsSum
pensionPaymentsEntered employee pension/insurance premiumsSum
disposableIncomeGross minus those two paymentsSum
housingPaymentsEntered housing cost excluding loansSum
loanPaymentsActual contractual loan cash paymentsSum
interestPayments, principalPaymentsPaid interest and principal, shown separatelySum
otherExpensesEntered living costsSum
leftToLiveOnDisposable minus housing, loans and living costsSum
cashBalance, loanBalanceClosing bank balance / outstanding principalLast

All metrics are local money. Each person's published assessment record has payments.kind:'cash' / period:'monthly', separate annual tax.kind:'assessment' and a pension record retaining its native kind and period. Source URLs, rule versions, rounding and partial coverage travel with the record. Annual assessments are snapshots of explicit annual bases: do not sum repeated snapshots as monthly liabilities. They never add tax payments, current pension income or a personal pension-capital account. Employee premiums included in a tax burden assessment are not booked again.

For a presentation of a returned model named model, the repeated public outputs model.components.people.outputs.taxAssessment, .pensionAssessment and .pensionValues work as RecordTable sources. The first two expose each person's native period, rule version, coverage and ruleSource; pension also exposes basisSource. Pension valuePeriods and valueKinds map each numeric value key to its actual monthly/annual period and native operation/result kind. The record's period is that common period or mixed when its values have different periods; for example, ITP 1 premiums are monthly, while a defined-benefit result includes annual amounts and payableMonthly. .pensionValues retains the native numeric contribution/accrual map. Use sourceLabel:'owner' to show current person labels and allowEmpty:true for an empty household. The included presentation shows these sources and values.

nationalContext publishes the country, currency, versions and dated mortgage policy's scope, source links, numeric limits and support classifications. The policy creates no payment or support award and does not certify underwriting; the loan's entered contractual payment is preserved. Loan indexation, automatic regulatory amortization adjustments, tax-card calculations, final settlement dates, cross-border tax, multiple residencies and FX are not supplied by this facade. Use the native packages to author those explicitly where supported.

Living costs require expenses.source: name your own entered amounts or the applicable verified local evidence. No Swedish Consumer Agency budget is used automatically. Negative/nonfinite payments, foreign Money, missing local facts, unknown versions, unsupported profiles and uncovered dates fail explicitly. For an intentional pension omission, use selected pension: null and pension version 'none'; the reported coverage is not-modelled.

Inspect supported local inputs

nordicHouseholdSupport() takes no arguments and returns an immutable map of the five countries, currencies, versions, required native fields, validity and partial coverage. It makes no calculation or eligibility choice.