Model editor reference
Use these model-building names in the portal model editor. Select a domain module in model settings to make its names available; the portal prepares the selected module for the model automatically.
Core model editor
Use these names in the portal model editor when writing a model.
| Model editor name | Purpose and model value shape |
|---|---|
deccf.account | Declares a model account with an optional opening amount. initial accepts a finite number or Money, existing supported input/calculation/expression sources, an initializer callback, or a parameter/once binding. Parameter and once initializers are registered during preparation and resolved before periods start, with normal finite-value and currency checks. Historical previous/history bindings cannot initialize an account. Declare parameters captured by a once callback in the model as well. Existing initializer callbacks retain the broad calculation context and account-dependency checks. Returns the account reference; see the execution guide for a callable parameter/once initializer example.
|
| |
deccf.actions | Provides state and field actions that lifecycle callbacks can schedule. Use these helpers inside a lifecycle transition or event.
|
| |
deccf.actions.activate | Schedules a flow to become active as a lifecycle action.
|
| |
deccf.actions.deactivate | Schedules a flow to stop as a lifecycle action.
|
| |
deccf.actions.setField | Sets a declared entity field when a lifecycle action runs.
|
| |
deccf.actions.setState | Moves an entity into a declared state when a lifecycle action runs.
|
| |
deccf.addMoney | Adds two Money values of the same currency and returns a Money value. Amounts must be finite; mismatched currencies are rejected. Retains an explicit valuation date only when both operands have the same date; otherwise the result is undated. Adding amounts does not convert their purchasing power. Attach a date explicitly with money() when the resulting total needs a valuation date.
|
| |
deccf.agreement | Declares an agreement attached to an entity, with optional parties, dates, terms, and boundary actions.
|
| |
deccf.agreementTerm | Wraps a value as a term attached to an agreement. Use it when agreement details should be declared separately from model calculations.
|
| |
deccf.allocation | allocation({amount, method, limits?, ...options}) returns a component: outputs shares (keyed Money), requested, allocated, unallocated, explanation and optional unmetRequest. Register it. amount is a model-currency monetary source; method is proportional() or priority(). limits caps recipients (default none); redistribute defaults true, signed false, unit 0.01 currency units for rounding. Signed proportional weights cannot use limits. name labels the calculation; schedule/phase follow calculation defaults. Invalid amounts, methods, options or constraints reject. Calculates shares without payment. Keyed values accept a keyed source map, an ordinary repeated column or a repeated calculation/flow output map; numeric leaves are finite numbers or Money in the model currency. Source repeat keys identify recipients, including inside enclosing repeats and after input reordering. Register source repeats as components. Nonnumeric leaves, wrong currencies and unknown recipient keys reject. Existing keyed maps and columns retain their meaning.
|
| |
deccf.analysis | Ordinary scalar metrics that re-evaluate the same authored graph in fresh state. All analysis metrics are excluded in candidate runs. Values emit once at the final model period. Mark their names in monteCarlo.baselineMetrics to evaluate them only once during simulation.
|
| |
deccf.analysis.first | Tests every integer in ascending order between ceil(from) and floor(to), without assuming monotonicity. Requires an integer input; safe integer bounds may span at most 10000. Returns the first feasible integer, including zero, or emits no value when none is feasible. Returns an ordinary numeric metric declaration for defineModel.metrics, evaluated once in the final model period. Candidate runs execute the same authored financial graph in fresh state, excluding every analysis metric. Inputs, Money, arrays and object shape are preserved without mutating the baseline; changes is an optional array of {input,value}, targeting declared scalar leaves. Values, bounds and thresholds accept finite numbers, declared inputs or input-only arithmetic expressions; changed values also accept Money, text and booleans. Unknown inputs/metrics, duplicate changes, analysis-to-analysis selection, text metrics and invalid values fail validation. A candidate with no emitted metric produces no analysis value. Mark analysis metric names in monteCarlo.baselineMetrics so searches run once during the ordinary baseline instead of once per trial. Monetary scenario outputs keep their currency and explicit valuation date; output purchasing-power conversion applies once. Built-in total retains the candidate cashflows’ per-period valuation and npv retains its base-date amount; neither aggregate is deflated again at the final period. A compare callback receives nominal values, including nominal aggregate totals. Optional compare(value,baselineContext) performs a pure financial comparison of the candidate scalar (scenario) or found input value (goal), returning number, Money or undefined. It does not run when no feasible value exists. label and unit are optional presentation metadata. Requires an integer input and from/to bounds. Tests every integer in ascending order from ceil(from) through floor(to), without requiring monotonicity. atLeast defaults to 1; alternatively supply atMost, but never both. Returns the earliest feasible integer including zero, or emits no value if none is feasible. Bounds must be ordered safe integers spanning at most 10000 candidates. The result uses the searched input's units.
|
| |
deccf.analysis.scenario | Selects the final nominal candidate metric after scalar input changes. Money/date are retained; normal result valuation applies once. Built-in total retains per-period valuation and npv its base-date amount. A compare callback receives nominal values. No emitted target value yields no analysis value. Returns an ordinary numeric metric declaration for defineModel.metrics, evaluated once in the final model period. Candidate runs execute the same authored financial graph in fresh state, excluding every analysis metric. Inputs, Money, arrays and object shape are preserved without mutating the baseline; changes is an optional array of {input,value}, targeting declared scalar leaves. Values, bounds and thresholds accept finite numbers, declared inputs or input-only arithmetic expressions; changed values also accept Money, text and booleans. Unknown inputs/metrics, duplicate changes, analysis-to-analysis selection, text metrics and invalid values fail validation. A candidate with no emitted metric produces no analysis value. Mark analysis metric names in monteCarlo.baselineMetrics so searches run once during the ordinary baseline instead of once per trial. Monetary scenario outputs keep their currency and explicit valuation date; output purchasing-power conversion applies once. Built-in total retains the candidate cashflows’ per-period valuation and npv retains its base-date amount; neither aggregate is deflated again at the final period. A compare callback receives nominal values, including nominal aggregate totals. Optional compare(value,baselineContext) performs a pure financial comparison of the candidate scalar (scenario) or found input value (goal), returning number, Money or undefined. It does not run when no feasible value exists. label and unit are optional presentation metadata. Selects metric after applying changes. onInvalid defaults to error; omit suppresses only candidate input validation failures, leaving the metric absent. Financial callback/runtime failures still propagate. Optional compare(candidate,baselineContext) is a pure financial calculation returning number, Money or undefined; candidate preserves nominal Money/date and the context reads baseline financial values. For example compare:(candidate,ctx)=>(candidate.amount-ctx.get(initialCapital).amount)/100 calculates a financial difference without authoring run orchestration.
|
| |
deccf.analysis.threshold | Bisects a bounded decimal, rate or fraction input and returns its feasible edge in input units. Returns an already feasible selected endpoint immediately, or emits no value if the opposite endpoint is infeasible. Stops at tolerance or maxIterations and always retains the feasible side. Returns an ordinary numeric metric declaration for defineModel.metrics, evaluated once in the final model period. Candidate runs execute the same authored financial graph in fresh state, excluding every analysis metric. Inputs, Money, arrays and object shape are preserved without mutating the baseline; changes is an optional array of {input,value}, targeting declared scalar leaves. Values, bounds and thresholds accept finite numbers, declared inputs or input-only arithmetic expressions; changed values also accept Money, text and booleans. Unknown inputs/metrics, duplicate changes, analysis-to-analysis selection, text metrics and invalid values fail validation. A candidate with no emitted metric produces no analysis value. Mark analysis metric names in monteCarlo.baselineMetrics so searches run once during the ordinary baseline instead of once per trial. Monetary scenario outputs keep their currency and explicit valuation date; output purchasing-power conversion applies once. Built-in total retains the candidate cashflows’ per-period valuation and npv retains its base-date amount; neither aggregate is deflated again at the final period. A compare callback receives nominal values, including nominal aggregate totals. Optional compare(value,baselineContext) performs a pure financial comparison of the candidate scalar (scenario) or found input value (goal), returning number, Money or undefined. It does not run when no feasible value exists. label and unit are optional presentation metadata. Searches a decimal, rate or fraction input between ordered finite from/to bounds. atLeast defaults to 1, or supply atMost; the two options are mutually exclusive. select defaults to minimum, with maximum also supported. Feasibility must be monotonic across the supplied interval: minimum assumes infeasible then feasible; maximum assumes feasible then infeasible. An already feasible selected endpoint returns immediately; if the opposite endpoint is infeasible, no result is emitted. Bisection retains the feasible side and stops at positive absolute tolerance (default 1e-6 in input units) or maxIterations (default 80, integer 1..256). Both controls accept input references or input expressions. Returns the feasible bound even if the iteration limit is reached before tolerance.
|
| |
deccf.bind | Declares current, historical, parameter and once-per-execution reads for static callbacks.
|
| |
deccf.bind.history | Immutable chronological snapshot of completed calculation values strictly before this period. Omitted reference means the current calculation; the first snapshot is [], and inactive scheduled periods are omitted. Creates a binding to a frozen chronological array of completed calculation values strictly before the current period. Omitted reference selects the current calculation; its first history is []. Only calculation references are supported; inactive scheduled periods are omitted. It adds no same-period dependency. A final report appends its current row explicitly instead of copying accumulated history into every period state.
|
| |
deccf.bind.once | Resolves synchronous data once per execution/trial, shared by readers. Nested functions, Promises and class instances are rejected. Input references must belong to the model; captured parameter bindings must also be declared. Time-varying curves and time/account/flow/calculation reads are unavailable. draw/sample use the initialization period without an owner. Declares a synchronous configuration callback resolved at most once per execution or Monte Carlo trial and shared by readers of that binding. The restricted context exposes get for declared inputs and parameter/once bindings, plus draw/sample; it has no time, ledger balances, flow or calculation reads and rejects time-varying curves. Sampling uses the initialization period without an owner. Plain records and arrays are snapshotted immutably; scalar values and model references are retained. Functions are rejected at every nesting level, as are Promises and class instances. Precompute reusable annual sampled values as data; callbacks requiring current time, owner or balances belong in explicit dynamic execution. Bind row projections directly so repeated components can rebind them. Runtime parameter data cannot supply callbacks. No resolved once value crosses executions.
|
| |
deccf.bind.parameter | Declares a finite numeric runtime parameter, separate from structural model inputs. Values retain their authored units; decimal rates use 0.02 for 2%. Declares a typed runtime parameter. Missing values without a default, unknown names, invalid values and conflicting declarations are errors. It cannot change topology, schedules or timeline. Declares a named runtime value with required valueType using the calculation result schema and optional defaultValue. Values retain their authored units: decimal rates use 0.02 for 2%, and Money retains currency. Supply replacements through run or prepared.run parameters. Missing values without a default, unknown supplied names, invalid values and conflicting declarations of one name fail. Parameter bindings cannot change the compiled model structure, timeline or schedules. A parameter used inside bind.once must also occur in declarative bindings.
|
| |
deccf.bind.previous | Reads the prior completed calculation or account value. Omitted reference means the current calculation; its first value is 0. Accounts start at their initial balance. Creates a historical binding for a declared calculation, calculation projection or account. Optional reference defaults to the current calculation; this self form is valid only inside a calculation. Call bind.previous().project(path) to select a field of the prior self result, bind.previous(calculation.project(path)) for an explicit target, or chain project calls. Paths are nonempty dotted strings or arrays of field names checked against the result schema at preparation. The first-period calculation sentinel remains 0 even for projections. An inactive preceding period uses inactiveValue or fails when none is supplied. Accounts return opening balances, starting with their declared initial balance, and cannot project fields. It adds no same-period dependency and does not read future values.
|
| |
deccf.bind.sample | Samples a declared distribution once per model period (default), or reuses the first represented period's sample for every date in a calendar year. Readers share model-wide coordinates independent of owner and evaluation order. Unseeded runs use the distribution center; input overrides retain precedence. Declares a numeric static distribution sample with optional {calendar:'period'|'annual'}, default period. Period sampling has one coordinate per model period; annual sampling reuses the first represented period coordinate throughout each calendar year, including partial years. Consumers share model-wide coordinates independently of owner or evaluation order. Unseeded runs use the distribution center, and input replacements take precedence. The input must be a declared distribution; other inputs, unknown options and unsupported calendars fail. Rates retain decimal units, for example 0.03 means 3%. For annually resetting financial returns, combine an editable rate mean with a declared input.normal({mean:0,stdev:0.15},{visible:false}) shock and bind.sample(shock,{calendar:'annual'}); literal volatility stays out of the editable form. A fixed contractual rate or horizon-wide WACC instead uses bind.once(ctx=>ctx.draw(shock)). ctx.get(distribution) and ordinary bindings read the center and create no sampled spread. Compound each period against the previous balance or a native running product; never apply the latest draw to the full elapsed horizon. Useful uncertain apps can choose calculator:{defaultRun:{mode:'monte-carlo',trials:64,sampling:'sobol'}}. Global seeded trial and Sobol coordinates match general, indexed and worker execution. It returns a binding reference for calculation/flow bindings, without introducing another input. See the annual financial returns example in Static execution for a complete callable model and separate standard presentation.
|
| |
deccf.calculation | Declares a synchronous calculation. phase defaults to "period"; "periodEnd" runs after cashflow postings, account settlement and options. Static callbacks receive (values, {time,currency}); bindings infer dependencies and allowed account reads. Use dynamic:true for the broad CalculationContext, with explicit dependsOn and readsAccountsFrom. Combining dynamic:true and bindings is invalid. A period calculation reads opening balances, while a periodEnd calculation reads settled current-period balances. ctx.previous(account) always reads the opening balance. A period calculation or flow cannot depend on a periodEnd result. publish defaults to false; true captures values in deterministic.calculations. The optional schedule limits active periods; a read outside it fails unless inactiveValue is supplied. Static callbacks are the default: bindings:{name:source} supplies the first callback argument and the second is {time,currency}. Sources are declared inputs, calculations/projections, accounts, flows, expressions, terms, bind references or scalar literals. Dependencies and account-read permissions are inferred and validated before execution. Period calculations read opening balances; periodEnd calculations read settled balances. Set dynamic:true for the broad CalculationContext and explicitly declare its dependencies. Dynamic and bindings cannot be combined. The result is a reusable calculation reference with the declared resultType; values remain subject to finite-number, shape and Money/currency validation. See Static bindings and explicit dynamic callbacks for callable examples and migration.
|
| |
deccf.calculation.project | calculation.project provides project in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.cashflow | Declares a scheduled cash movement or balanced postings. Static callbacks receive (values, {time,currency}) and infer read dependencies from bindings. Set dynamic:true for the broad CalculationContext, including trigger source and booking amount. Dynamic declarations cannot have bindings. Static amount, active and booking callbacks receive (values,{time,currency}); bindings declares and orders their reads. Dynamic:true instead supplies the broad CalculationContext, including trigger source and the booking base amount. Dynamic and bindings cannot be combined. Flow groups propagate their execution mode and bindings. Balanced-posting, finite-number, currency and dependency checks apply in both modes. Constants and expressions remain valid amounts. Returns the declared flow reference. See Static bindings and explicit dynamic callbacks for callable examples.
|
| |
deccf.category | Creates a reporting category reference for grouping accounts and cashflows. An optional label supplies a display name in results.
|
| |
deccf.column | A keyed field map from declared rows; no repeated component is required.
|
| |
deccf.compileModel | Validates model declarations and compiles their dependency order. Use it to catch configuration errors before running repeated calculations.
|
| |
deccf.component | Composes entities, accounts, flows, calculations, and outputs into a reusable model component.
|
| |
deccf.convertMoney | Converts Money using an explicit finite target-units-per-source-unit rate and a target Currency reference; no exchange rate is fetched. Returns Money with the multiplied amount, target currency and original optional valuation date. Invalid Money, Currency or non-finite rates are rejected. Conversion changes denomination without adjusting purchasing power.
|
| |
deccf.createInputValue | Returns a fresh frozen typed value for an input reference. Optional mode defaults to 'initial'; 'newItem' requires an objectArray reference, and other modes are rejected. A variant object initially uses its first catalogue schema; typed variant arrays initially return []. For a variant array, 'newItem' creates the first variant using its authored defaults, including decimal rates (0.02 means 2%), instead of the ordinary homogeneous array's zero/empty new-row policy. When an ID needs generating, supply generateId:()=>string; a missing generator or invalid generated ID produces an explicit error. Declared/saved identities are not replaced, and generation does not mutate the original variant or any standalone choice. This helper creates a value only; it does not append it to a collection or change a Calculator draft.
|
| |
deccf.currencies | Provides the built-in currency values used by money inputs and model reporting. The available codes are listed by the public type declaration.
|
| |
deccf.currency | Creates a currency value from a three-letter uppercase code. Use it when a model needs a reporting or input denomination.
|
| |
deccf.defineModel | Collect declarations into an ordinary model with a required timeline and currency. currency accepts a Currency value or a declared fixed currency-code input, such as input.enum('DKK', {options:[{value:'DKK',label:'DKK'},{value:'EUR',label:'EUR'}]}). Input codes must use three uppercase letters. Their value is resolved before binding accounts and flows on each run, including compiled-model input overrides. This selects the denomination of entered local amounts and never converts Money; explicit foreign Money still fails. The input must be declared in preconditions. describeModel with includeExecutionContext reports the default resolved code. Existing Currency values retain their behavior and run-level reporting relabels remain a separate option; jurisdiction-specific models may reject those relabels. Collects model declarations; currency and timeline are required and declaration maps are optional. Optional inflation is an annual decimal rate (0.02 means 2%), either a finite number greater than -1 or a scalar numeric input reference registered anywhere in this model's inputs. Omission defaults to 0. Reuse an existing reference in its own group, tab or page; no special Inflation field is added. Input overrides resolve the effective rate for each run. A distribution input uses its central value, not an automatic draw; curves, Money, derived references and undeclared references are unsupported. This setting supplies output purchasing-power conversion; financial callbacks must explicitly use inflation if they also need it for future nominal costs or income. Returns the model definition. Optional calculator.defaultRun sets initial interactive mode, trials, seed and sampling; saved selections take precedence. See Initial Calculator run settings and Show money in today's value for examples, defaults and validation. Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments.
|
| |
deccf.derived | Declares an input-like value calculated from other declared references before simulation. Use it for values users should not edit directly.
|
| |
deccf.describeModel | Returns a frozen editor-facing description of a model's inputs, Calculator defaults and optional scenarios without simulating it. Requires a model returned by defineModel(); other values are rejected. Optional includeExecutionContext defaults to false. When true, resolves default currency, timeline dates and annual decimal inflation from the model's declared inputs; inflation defaults to 0. Execution context fields can be absent when the model defaults cannot resolve them, allowing inputs that need saved or uploaded values to remain editable. Actual run input overrides and validation are applied by run(), not describeModel().
|
| |
deccf.directions | Groups the built-in inflow and outflow values. Use `inflow` or `outflow` to describe the sign of a cash movement.
|
| |
deccf.entity | Creates an entity reference and its public factories for assets, parties, bundles, and related entity kinds.
|
| |
deccf.entity.asset | entity.asset provides asset in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.entity.bundle | entity.bundle provides bundle in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.entity.party | entity.party provides party in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.entity.reference | entity.reference provides reference in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.event | Declares an event that runs actions once on a schedule or when its condition becomes true.
|
| |
deccf.expr | expr is a model value for expr in the Core model API editor.
|
| |
deccf.expr.add | expr.add provides add in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.amount | expr.amount provides amount in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.balance | expr.balance provides balance in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.divide | expr.divide provides divide in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.eq | expr.eq provides eq in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.flow | expr.flow provides flow in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.max | expr.max provides max in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.min | expr.min provides min in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.money | expr.money provides money in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.multiply | expr.multiply provides multiply in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.netCash | expr.netCash provides net cash in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.subtract | expr.subtract provides subtract in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.sum | expr.sum provides sum in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.expr.when | expr.when provides when in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.field | Declares a stateful numeric field with an initial value and optional period-to-period update callback.
|
| |
deccf.flowGroup | Groups flows and named inputs under shared settings such as owner, direction, or schedule. Its preconditions may reuse input handles already declared in an input domain; the group reads the same declared input rather than creating another input.
|
| |
deccf.flows | Flattens nested flow groups into flow references while preserving inherited defaults for defineModel().
|
| |
deccf.frequencies | Provides named period frequencies used by time and schedule helpers.
|
| |
deccf.funding | Allocates funding from one or more sources to a target while recording the resulting transfers.
|
| |
deccf.inflow | Marks a cashflow as money entering the model owner's cash position.
|
| |
deccf.input | Provides typed factories for model inputs, including numbers, enums, objects, arrays, dates, and distributions.
|
| |
deccf.input.aspect | Declares a named object of typed inputs using the aspect layout. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.boolean | Declares an editable true-or-false input, optionally displayed as a switch or checkbox.
|
| |
deccf.input.boolen | Alias of boolean, retained for existing models.
|
| |
deccf.input.curve | input.curve provides curve in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.date | input.date provides date in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.decimal | Declares an editable decimal input with optional numeric limits and display metadata.
|
| |
deccf.input.domain | Declares a named object of typed inputs using the domain layout. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.enum | Declares a choice input from explicit stored values and display labels.
|
| |
deccf.input.familyRole | input.familyRole provides family role in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.fraction | input.fraction provides fraction in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.group | Declares a named object of typed inputs using the group layout. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.groups | groups(source, fields, options={}) returns an ordinary connected keyed object-array: {id,name,...fields} per selected source row. source is a keyed object-array with a string label field; label defaults to 'name'. fields contains typed inputs, including nested lists/objects. id/name are reserved protected fields: hidden id follows the source key, name its label/heading. where is an all-match scalar-equality map (default no filter). rows defaults to []: typed objectArray initial maps require id:input.id(...) or input.str(...) matching a source; optional name cannot override its label. Other groups use field defaults. ui, visible, required, title, type ('cards' default or 'table') retain ordinary semantics; other options reject. Rename/reorder preserves surviving nested edits; additions use defaults, removals remove groups. Outer add/remove controls are absent; nested lists retain theirs. Register both inputs. item.data, repeat(), column(), JSON, saved cases and scenarios work as for objectArray. Money stays Money; rates are fractions (0.02=2%). Invalid sources, fields, label/where, reserved fields or typed rows reject at declaration; submitted values retain input/connection validation.
|
| |
deccf.input.id | input.id provides id in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.integer | Declares an editable whole-number input.
|
| |
deccf.input.lockable | input.lockable provides lockable in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.logNormal | input.logNormal provides log normal in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.money | Declares an editable money input with a typed currency. Optional ui.initialValueFrom copies a missing saved UI field from an absolute object-field path before using its declared default. Optional ui.initialValueScale defaults to 1 and multiplies a copied finite number or Money amount, preserving currency and other Money data; it must be finite and positive. Invalid scales, unsupported source values and nonfinite results use the declared default. Explicit target values, including zero, win and are never scaled. Unknown or malformed paths, accessors, inherited properties and array-row paths use the normal default. Saved scenario selections of a retired hidden leaf follow its unique editable replacement alias and scale; explicit replacement selections win. Protected ancestors, readonly fields, connected values and array-row selections retain their normal restrictions. Saved inputs are not mutated. This affects opening case and scenario drafts only; direct calculation input validation is unchanged.
|
| |
deccf.input.normal | input.normal provides normal in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.object | Declares a named object of typed inputs using the object layout. Variant catalogues contain ordinary input.Object(fields, {label}) references (input.object is the lowercase alias). Each needs a non-empty label and a unique non-empty string type declared with input.hidden('isk'), for example. Values are ordinary objects with a hidden type discriminator; rates are decimal fractions, so input.rate(0.02) means 2%. Empty or malformed catalogues, missing labels, missing/non-hidden/non-string/duplicate type values, incompatible options and unknown saved type values produce explicit errors. Saved malformed or unknown choices remain visible for correction rather than defaulting to the first choice. The active variant controls nested input validation, hidden/readonly fields, locks and money currency handling. New variant declarations do not support connectedSource or connectionBinding; these produce explicit errors, including bindings inside variant fields. Existing ordinary connected arrays retain their behavior. Switching an editable choice preserves identity and common field values only when names, value types and units/currencies match; target-specific fields use their declared initial defaults and inactive fields are removed. There is no cache of inactive edits. Preserved values outside target bounds remain available with normal validation errors. Generated collection identities never change the original variant reference or its standalone choice value. Object(variants, {title}?) and object(variants, {title}?) return one alternative object input, defaulting to the first catalogue entry. Its always-editable selector uses title as its label; the active fields follow in normal layout flow. A standalone choice has no generated collection id. Object(fields, options?) and object(fields, options?) still group ordinary fields, including the existing sumdropdown layout. describeModel() exposes discriminator:'type', variants:[{value,label,schema}], and fallback fields/value from the first variant; active fields come from the selected variant schema. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.Object | Declares a named object of typed inputs using the Object layout. Variant catalogues contain ordinary input.Object(fields, {label}) references (input.object is the lowercase alias). Each needs a non-empty label and a unique non-empty string type declared with input.hidden('isk'), for example. Values are ordinary objects with a hidden type discriminator; rates are decimal fractions, so input.rate(0.02) means 2%. Empty or malformed catalogues, missing labels, missing/non-hidden/non-string/duplicate type values, incompatible options and unknown saved type values produce explicit errors. Saved malformed or unknown choices remain visible for correction rather than defaulting to the first choice. The active variant controls nested input validation, hidden/readonly fields, locks and money currency handling. New variant declarations do not support connectedSource or connectionBinding; these produce explicit errors, including bindings inside variant fields. Existing ordinary connected arrays retain their behavior. Switching an editable choice preserves identity and common field values only when names, value types and units/currencies match; target-specific fields use their declared initial defaults and inactive fields are removed. There is no cache of inactive edits. Preserved values outside target bounds remain available with normal validation errors. Generated collection identities never change the original variant reference or its standalone choice value. Object(variants, {title}?) and object(variants, {title}?) return one alternative object input, defaulting to the first catalogue entry. Its always-editable selector uses title as its label; the active fields follow in normal layout flow. A standalone choice has no generated collection id. Object(fields, options?) and object(fields, options?) still group ordinary fields, including the existing sumdropdown layout. describeModel() exposes discriminator:'type', variants:[{value,label,schema}], and fallback fields/value from the first variant; active fields come from the selected variant schema. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.objectArray | Creates mixed rows from object variants. `type` is `manyOfAnyChangeable`, `manyOfAny` or `anyOf`. Example: `deccf.input.objectArray([isk, vp], {type: "manyOfAnyChangeable", title: "Sparande"})`. Variant catalogues contain ordinary input.Object(fields, {label}) references (input.object is the lowercase alias). Each needs a non-empty label and a unique non-empty string type declared with input.hidden('isk'), for example. Values are ordinary objects with a hidden type discriminator; rates are decimal fractions, so input.rate(0.02) means 2%. Empty or malformed catalogues, missing labels, missing/non-hidden/non-string/duplicate type values, incompatible options and unknown saved type values produce explicit errors. Saved malformed or unknown choices remain visible for correction rather than defaulting to the first choice. The active variant controls nested input validation, hidden/readonly fields, locks and money currency handling. New variant declarations do not support connectedSource or connectionBinding; these produce explicit errors, including bindings inside variant fields. Existing ordinary connected arrays retain their behavior. Switching an editable choice preserves identity and common field values only when names, value types and units/currencies match; target-specific fields use their declared initial defaults and inactive fields are removed. There is no cache of inactive edits. Preserved values outside target bounds remain available with normal validation errors. Generated collection identities never change the original variant reference or its standalone choice value. objectArray(rows, options?) retains homogeneous initial rows, optional item/key schema, cards/table views and dynamic membership unless options.type is explicitly manyOfAnyChangeable, manyOfAny or anyOf. These three calls interpret the first array as a variant catalogue, return a keyed array input and start empty. Optional title labels the collection. manyOfAnyChangeable adds the first variant immediately, permits repeated types and gives each card an editable selector. manyOfAny offers variant labels in the add menu, permits repeated types and fixes each existing card's type. anyOf uses that menu and fixed cards but allows at most one row per type; used types are disabled, deletion reenables a type and add is disabled when all are present. Uniqueness is also validated on submitted calculation data. Fixed cards restrict draft editing, not otherwise valid replacement calculation inputs. New rows use the selected variant's authored initial values, rather than homogeneous-array zero/empty new-row defaults. Without an explicit key, each newly added row receives a fresh hidden id; saved identities remain stable and describing/compiling generates no IDs. Existing explicit keys are supported. describeModel() exposes selectionMode matching options.type, view:'cards' and an alternative object item with discriminator:'type' and variants:[{value,label,schema}]. Within repeat(rows, component), rows.item.value supplies the complete immutable typed row to calculation or cashflow bindings. It retains the stable row key, active variant discriminator and all selected variant fields, nested objects/arrays and Money values; inactive variant fields are absent. Branch on row.type when variants have different financial assumptions. rows.item.data.<field> remains the existing symbolic field view, not the whole row, and is not expanded with inactive fields. Nested row/object views also expose value and resolve in their own enclosing row scope. Reordering, replacing or deleting rows refreshes bindings at each run; an empty collection creates no components. Use expr.sum with an explicit resultType (and currency for Money) for a typed zero over empty outputs. These row references require their declared collection and a matching repeat row scope; merely declaring or separately repeating the collection does not supply a current row, and a missing scope rejects with DECCF_UNDECLARED_REFERENCE. Whole-row Money follows the selected run currency exactly as ordinary input reads; foreign-currency values stay unchanged. Invalid input rows retain ordinary input validation errors.
|
| |
deccf.input.rate | Declares an editable rate input, usually representing an annual or period rate. Optional ui.initialValueFrom initializes a missing saved UI field from an absolute object-field path before using its declared default; supplied target values, including zero, win. It defaults to absent. Optional ui.initialValueScale defaults to 1 and multiplies a copied finite number or Money amount while preserving currency. The scale must be finite and positive; invalid scales, unsupported source values and nonfinite results use the declared default. Explicit target values are never scaled. Unknown or malformed paths, accessors, inherited properties and array-row paths use the normal default. Reads do not mutate saved inputs. This is UI draft initialization only; direct calculation input validation is unchanged.
|
| |
deccf.input.readonly | input.readonly provides readonly in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.readOnly | input.readOnly provides read only in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.section | Declares a named object of typed inputs using the section layout. Optional constraints defaults to [] and declares relations {left,relation,right,message?} between leaves inside this object. Paths are relative safe dot-separated field names; array traversal, prototype keys, unknown paths, accessors and incompatible endpoint types are rejected at declaration. Supported relations are <, <=, >, >=, == and !=. Numeric scalar kinds can be mixed; Money endpoints must use the same currency and compare nominal amounts; dates compare chronological instants (a year-month means its first day). After input normalization and leaf validation, each failed relation adds DECCF_INPUT_DOMAIN at its left leaf path using message or a generated relation. Optional missing or already invalid endpoints produce no duplicate relation error. Rules and resolved values remain immutable; no callback is needed. Constraints can be attached to concrete object variants, but not the variant chooser or a path crossing variants. Optional ui.note displays plain text after this object's fields, at the end of its group, tab or page. It defaults to absent; blank and non-string values display nothing. Notes add no stored input or calculation value and are not supported on scalars, arrays or custom widgets. A compact sumdropdown object does not display a note. See Organize inputs into pages, tabs and groups for a callable example.
|
| |
deccf.input.sni | An empty value asks domain methods to infer the industry from account history.
|
| |
deccf.input.str | Declares an editable string input. ui.choicesFrom displays names from an input list, storing stable string keys: {path, key, label, where?}. path is an exact absolute input path; key is an ID/string field, label a string field. where is an optional all-match scalar-equality map (default all rows). Static ui.choices entries {value,label} remain available with empty sources or no matches. Values must be nonempty and unique across both lists. Renaming/reordering refreshes labels, retaining keys. Removed/filtered-out selections stay Unavailable and invalid until corrected; never automatically reassigned. Empty sources without static choices disable the control; zero filter matches offer no source rows. Invalid paths, fields, filters or duplicate keys show configuration errors. Blank labels show Unnamed item plus a number. Ordinary string input metadata only; domain components validate key meaning.
|
| |
deccf.input.tableToSie | input.tableToSie provides table to sie in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.textfile | input.textfile provides textfile in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.triangular | input.triangular provides triangular in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.input.uniform | input.uniform provides uniform in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.lifecycle | Declares states, an initial state, transitions, and optional actions for an entity lifecycle.
|
| |
deccf.lookup | Declares a keyed lookup whose values can be resolved during model evaluation.
|
| |
deccf.metric | Declares a scalar or text result evaluated after simulation. Supply exactly one of calculate or value. periodLength and frequency default to 1 model period. An optional calendar schedule selects which of those otherwise-eligible periods to evaluate; it supports fixed dates and declared input/derived dates. The schedule intersects frequency and the requirement for a complete periodLength window. Omitting it preserves evaluation in every otherwise-eligible period. A skipped period does not create a context or call the metric callback; its series value is null. The summary keeps the last defined emitted value, or omits the metric if none is emitted. Trigger-relative schedules and undeclared schedule inputs fail validation. label/unit are optional presentation metadata; annualAggregation defaults to last, and fiscalYearStartMonth defaults to the owner's setting or January. Callbacks are synchronous and may return a number, Money or undefined; valueType:"text" permits a string or undefined.
|
| |
deccf.ModelError | Creates a model error with a stable code and a human-readable message. Optional details default to an empty object. path and period identify a known location; cause retains the underlying failure. During a calculation, inputReference can identify a declared input without knowing its name in the containing model. For an object-array field, also supply its unique inputRowId and an inputFieldPath array of declared field names (default: the input itself). The calculation resolves a verified source to the full input path. Unknown references, duplicate row IDs and undeclared fields cannot identify an input. Source resolution applies to input-validation codes such as DECCF_INPUT_DOMAIN; ordinary calculation error codes keep their calculation location. The error itself does not change a value; Calculator Apps can use a valid model default or omit an affected card and explain that choice in Results.
|
| |
deccf.money | Creates a typed Money value from a finite numeric amount and a Currency reference. Optional third argument {date: 'YYYY-MM-DD'} attaches an explicit valuation date; omission leaves the amount undated. The date must be a valid calendar date (an ISO year-month is also accepted). This date describes when the nominal money amount is valued, including future amounts inside a published record produced on an earlier model date. With run moneyValue:'today', it takes precedence over the output series point date or the final metric evaluation date. The returned Money retains its amount, currency and optional date; money() itself performs no inflation conversion. Plain numbers do not acquire monetary meaning. Currency conversion still requires convertMoney() with an explicit exchange rate.
|
| |
deccf.option | Declares a conditional payoff series that can be exercised when its condition changes from false to true.
|
| |
deccf.outflow | Marks a cashflow as money leaving the model owner's cash position.
|
| |
deccf.periods | Creates a timeline with a calendar, start date, and number of periods.
|
| |
deccf.periods.annual | Creates an annual timeline from a start date and period count.
|
| |
deccf.periods.daily | Creates a daily timeline from a start date and period count.
|
| |
deccf.periods.monthly | Creates a monthly timeline from a start date and period count.
|
| |
deccf.periods.quarterly | Creates a quarterly timeline from a start date and period count.
|
| |
deccf.periods.weekly | Creates a weekly timeline from a start date and period count.
|
| |
deccf.phase | Declares a named phase used to group model periods and scheduled behavior.
|
| |
deccf.prepare | Prepares a model's fixed structure, input overrides, calendar, bindings and validation once. Returns an immutable object with run({parameters?,seed?,trial?}) and withParameters(parameters). Scoped parameter handles validate and snapshot supplied values once; source mutations cannot change them. Missing required names are deferred until run. Each run replaces only supplied names, validates those replacements and leaves the scoped snapshot unchanged. The run method rejects structural overrides: prepare again to change ordinary inputs, schedules, timeline, currency or output selection. Without outputs each run returns the complete result. With outputs:{name:reference}, each run returns only a frozen named record of final account/calculation/projection values, without report construction. Account values are numbers; structured calculation values and Money retain their native types and nominal amounts. Missing/undeclared/unsupported outputs and invalid runtime parameters are errors. Selected outputs still execute the native timeline and balanced postings; dynamic readers retain the bookkeeping they need. Prepares fixed model structure, structural input overrides, calendar and read bindings for reuse. options accepts ordinary run settings plus optional outputs:{name:accountOrCalculationOrProjection}. Returns an immutable object with run({parameters?,seed?,trial?}) and withParameters(parameters); other per-run keys are rejected. withParameters validates and snapshots supplied names once and returns a new immutable handle; chaining inherits prior names, and later source-object mutations cannot change the snapshot. Each run validates only supplied overrides, replacing each complete named value without merging nested records or changing the scoped defaults. Unknown names and invalid values fail immediately; missing required parameters may remain unset until run. Currency is fixed by preparation; seed/trial can change per run, while balances, history and once values remain independent. Without outputs it returns a complete result; with outputs it returns a frozen record of final native values, with numeric account balances and unchanged typed Money, without report valuation or series wrappers. Unknown output references and invalid parameters fail. Each execution starts fresh, including balances, history and bind.once values. Changing timeline, schedules, accounts or structural inputs requires preparing again. Selected outputs retain the native simulation and validation; unused report bookkeeping is omitted only where no reader needs it. Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits.
|
| |
deccf.priority | priority({order, requests?}) returns an allocation method. order is an array of unique nonempty recipient IDs. requests supplies nonnegative amounts by ID; omitted requests take the remaining amount in order, subject to limits. Creates no postings. Keyed values accept a keyed source map, an ordinary repeated column or a repeated calculation/flow output map; numeric leaves are finite numbers or Money in the model currency. Source repeat keys identify recipients, including inside enclosing repeats and after input reordering. Register source repeats as components. Nonnumeric leaves, wrong currencies and unknown recipient keys reject. Existing keyed maps and columns retain their meaning.
|
| |
deccf.proportional | proportional({weights, overrides?, zeroBasis?}) returns an allocation/funding method. weights defines recipients and relative nonnegative weights. overrides reserves fixed amounts by recipient before distributing the remainder (default none). zeroBasis defaults to 'error'; 'equal' splits a zero-weight remainder equally. Empty weights leave the amount unallocated. Keyed values accept a keyed source map, an ordinary repeated column or a repeated calculation/flow output map; numeric leaves are finite numbers or Money in the model currency. Source repeat keys identify recipients, including inside enclosing repeats and after input reordering. Register source repeats as components. Nonnumeric leaves, wrong currencies and unknown recipient keys reject. Existing keyed maps and columns retain their meaning.
|
| |
deccf.repeat | Repeats a component over the rows of an object-array input and exposes each row's outputs.
|
| |
deccf.run | Evaluates a model or compiled plan and returns a complete deterministic result with series, metrics, accessors and timings. Optional moneyValue accepts 'nominal' (default) or 'today'; other values are rejected. 'today' converts declared monetary outputs to purchasing power at the first resolved timeline date using the model's effective annual inflation, amount / (1 + inflation) ** elapsedYears. Whole calendar anniversaries count as full years, with actual days used for a partial anniversary year. An explicit money() valuation date wins; otherwise series use their point dates and custom money metrics use their last evaluated window date. Typed Money leaves in structured calculations, cashflows, accounts, options and monetary summaries are converted. Plain numeric outputs, ages, rates and text retain their values. model.total sums converted cashflows; model.npv already represents base-date present value and remains unchanged. Inputs, state and economic callbacks keep their nominal values. Zero inflation gives identical amounts; negative inflation greater than -1 is supported. The result exposes moneyValue, inflation and moneyValueBaseDate, also in serialized output. Existing currency, discountRate, overrides, deterministic input settings, seed and trial options remain supported; see Run configuration for validation. Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits.
|
| |
deccf.runMonteCarlo | Optional third argument controls defaults to {}: runMonteCarlo(model, options, {onProgress}). The call stays synchronous and returns the unchanged MonteCarloResult. onProgress receives immutable completed-work snapshots: phase ('preparing', 'baseline', 'trials', 'finalizing' or 'complete'), completedTrials, totalTrials, completedWork, totalWork and baselineComplete. For N trials, totalTrials is N and totalWork is trials + 2: one baseline, N trials and one final summary. completedWork counts only finished units; baselineComplete becomes true after the ordinary base calculation. Counts measure completed work, not estimated elapsed time; baseline order follows the selected execution strategy. Events may be coalesced. Observer errors do not affect results and return values are not awaited; keep callbacks brief. Failed calculations never emit complete. Omission disables observations. Controls stay separate from calculation options, result data, receipts and cache identities. Synchronous observations alone cannot make a progress indicator paint during the call. The Calculator owns automatic progress display; financial model code needs no UI logic or custom simulation loop. See Calculation progress for timing and opt-in Web API framing. Runs synchronously, optionally reporting completed work through onProgress in a separate third control argument. Events may be coalesced; baseline timing follows the selected execution strategy. An observer does not make a window paint during synchronous execution. Failed calculations never emit complete. Runs repeated sampled calculations and returns the complete ordinary base result plus sampled metric summaries, percentiles, histograms and timings. Requires trials, a positive integer, and an explicit integer seed. Optional sampling is pseudo-random (default) or sobol; Sobol trials must be a power of two, at most 2^32. Supports the same moneyValue:'nominal'|'today' option as run(), defaulting to 'nominal'. For 'today', each trial converts its monetary results before computing statistics using the effective overridden model inflation; a distribution inflation input uses its central value; the base result uses central input values. Rates and other plain numeric metrics retain their units. Base-date NPV is unchanged. Metadata moneyValue, inflation and moneyValueBaseDate describes the base calculation. See Simulate uncertainty for other sampling options and limits. Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits. Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments.
|
| |
deccf.runScenarios | Runs named scenarios with shared run options and returns {name, result} entries with per-scenario timings and a timings property on the array. Each scenario has a name and optional overrides Map keyed by declared InputReference values; scalar and curve overrides follow normal input validation. Optional moneyValue:'nominal'|'today' defaults to 'nominal'. Every scenario independently resolves its inflation input and converts its monetary outputs and summaries at its own first resolved timeline date. Pass trials with Monte Carlo settings to simulate every scenario; monetary statistics are computed from converted trial values. Inputs and callbacks retain nominal values, plain numeric outputs retain their units, and base-date NPV is unchanged. Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits. Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments.
|
| |
deccf.scaleMoney | Multiplies a Money value by a finite numeric factor and returns Money in the same currency. Retains the optional valuation date. The factor is unitless; scaling performs no inflation conversion.
|
| |
deccf.schedule | Creates recurring or dated model schedules, such as monthly, annual, or one-time occurrences.
|
| |
deccf.schedule.annual | Creates a recurring annual schedule between the requested dates.
|
| |
deccf.schedule.daily | schedule.daily provides daily in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.every | schedule.every provides every in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.monthly | Creates a recurring monthly schedule between the requested dates.
|
| |
deccf.schedule.once | Creates a one-time schedule for the requested date or period.
|
| |
deccf.schedule.onceAfterNoOfDays | schedule.onceAfterNoOfDays provides once after no of days in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.phaseEnd | schedule.phaseEnd provides phase end in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.phaseEnter | schedule.phaseEnter provides phase enter in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.phaseStart | schedule.phaseStart provides phase start in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.quarterly | schedule.quarterly provides quarterly in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.weekly | schedule.weekly provides weekly in the Core model API model editor. Use it when a model needs this operation.
|
| |
deccf.schedule.yearEnd | Run once in the final period of each calendar year.
|
| |
deccf.sniMainGroups | Lists the Swedish SNI 2025 two-digit industry groups available to SNI input fields.
|
| |
deccf.state | Creates a named lifecycle state that can be used in transitions and actions.
|
| |
deccf.statement | Creates a flow group that brings declared accounts to target statement balances.
|
| |
deccf.subtractMoney | Subtracts the second Money value from the first and returns a Money value. Amounts must be finite and both currencies must match. Retains a valuation date only when both operands have the same date; otherwise the result is undated. The subtraction performs no inflation conversion.
|
| |
deccf.sym | Provides built-in numeric domains for common positive and percentage inputs.
|
| |
deccf.transfer | Moves an amount between accounts using a scheduled, balanced transfer.
|
| |
deccf.trigger | Creates a named event trigger that can notify subscribed flows in later periods.
|
| |
deccf.validateInput | Checks a supplied value against an input reference and returns a readonly list of path-specific validation errors; valid values return []. Optional path sets the error path prefix. For variant objects/arrays, type selects the active schema before checking fields, rates, money currencies and nested constraints. Unknown or malformed discriminators and duplicate anyOf types are errors; these values are not replaced by the first variant. Ordinary homogeneous arrays and object validation retain their existing behavior.
|
| |
deccf.AccountOptions | AccountOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AccountPostingResult | One signed ledger posting observation. With annual amountStorage, rows sum by account, flow, side, owner, currency and flow_role after output valuation; date and period identify the first covered source period. Optional periodEnd is the inclusive covered end date and periodLabel is the year label. Categories and transaction/period-close roles are preserved. Model value shape: |
deccf.AccountReference | AccountReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.Action | Action describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AgreementReference | AgreementReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AgreementTermReference | AgreementTermReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AllocationKeyedValues | AllocationKeyedValues describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AllocationMethodReference | AllocationMethodReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AllocationOptions | AllocationOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AllocationOutputs | AllocationOutputs describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AllocationValue | AllocationValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AmountStorage | Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits. Model value shape: |
deccf.AnalysisChange | AnalysisChange describes a model value used by the Core model API editor functions. Model value shape: |
deccf.AnalysisNumber | A finite number or an input-only expression, resolved against the baseline inputs. Model value shape: |
deccf.BindingFactory | BindingFactory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BindingReference | BindingReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BindingSource | BindingSource describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BindingValue | BindingValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BindingValues | BindingValues describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BookingAmount | BookingAmount describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BookingRow | BookingRow describes a model value used by the Core model API editor functions. Model value shape: |
deccf.BooleanInputOptions | BooleanInputOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationContext | CalculationContext describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationDefinitionOptions | CalculationDefinitionOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationFieldValue | CalculationFieldValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationOptions | CalculationOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationProjectionReference | CalculationProjectionReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationReference | CalculationReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationResultFields | CalculationResultFields describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculationResultType | CalculationResultType describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CalculatorOptions | Optional calculator pages (both default true) and initial run controls. Model value shape: |
deccf.CalculatorRunDefaults | Initial Calculator run controls; saved or explicitly selected settings take precedence. Model value shape: |
deccf.Calendar | Calendar describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowContributionKind | Presentation-editor contract; CashflowStatement is supplied by the presentation editor. Model value shape: |
deccf.CashflowDefinitionOptions | CashflowDefinitionOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowDirection | CashflowDirection describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowOptions | CashflowOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowReference | CashflowReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowResult | CashflowResult describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CashflowSeries | Compatibility numeric cashflow or option series. Annual amountStorage compacts values and publishes an optional index with actual dates, inclusive periodEnds, periodLabels and sourceCalendar. Default period storage keeps the existing shape. Reference methods such as result.flow(ref) retain the calculation-period observations. Model value shape: |
deccf.CategoryHierarchyNode | CategoryHierarchyNode describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CategoryOptions | CategoryOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CategoryReference | CategoryReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CompilationPlan | CompilationPlan describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CompileCashflowBookings | CompileCashflowBookings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ComponentOptions | ComponentOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ComponentOutputReference | ComponentOutputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ComponentReference | ComponentReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.Currency | Currency describes a model value used by the Core model API editor functions. Model value shape: |
deccf.CurveOptions | CurveOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DataCardsLayoutOptions | DataCardsLayoutOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DataCardsOptions | Choose source records or declared cards; the alternatives cannot be combined. Model value shape: |
deccf.DateString | DateString describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DerivedDependency | DerivedDependency describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DerivedKind | DerivedKind describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DerivedOptions | DerivedOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DerivedReference | DerivedReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DeterministicResults | DeterministicResults describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DeterministicRunConfig | DeterministicRunConfig describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DistributionOptions | DistributionOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DomainInputReference | DomainInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DynamicCalculationOptions | DynamicCalculationOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.DynamicCashflowOptions | DynamicCashflowOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EntityFactory | EntityFactory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EntityOptions | EntityOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EntityReference | EntityReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EnumInputOptions | EnumInputOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EnumOption | EnumOption describes a model value used by the Core model API editor functions. Model value shape: |
deccf.EventReference | EventReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ExpressionFactory | ExpressionFactory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ExpressionOperand | ExpressionOperand describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ExpressionReference | ExpressionReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FieldOptions | FieldOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FieldReference | FieldReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FlowGroupDefaults | FlowGroupDefaults describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FlowGroupItem | FlowGroupItem describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FlowGroupOptions | FlowGroupOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FlowGroupReference | FlowGroupReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FundingOptions | FundingOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.FundingOutputs | FundingOutputs describes a model value used by the Core model API editor functions. Model value shape: |
deccf.GoalAnalysisOptions | GoalAnalysisOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.GroupsInputOptions | GroupsInputOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.HistogramOptions | Exported Monte Carlo distributions; actual observed bins only. Model value shape: |
deccf.IndirectCashflowGroup | IndirectCashflowGroup describes a model value used by the Core model API editor functions. Model value shape: |
deccf.IndirectCashflowStatementOptions | IndirectCashflowStatementOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.IndirectCashflowSummary | IndirectCashflowSummary describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InlineRunInput | InlineRunInput describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InlineRunInputSeries | InlineRunInputSeries describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InlineRunInputValue | InlineRunInputValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InlineSeriesInput | InlineSeriesInput describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputConnectionMetadata | InputConnectionMetadata describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputDescription | InputDescription describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputFactory | InputFactory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputLayout | InputLayout describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputMetadataOptions | InputMetadataOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputObjectFields | InputObjectFields describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputObjectValue | InputObjectValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputOptions | InputOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputProjectionReference | InputProjectionReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputReference | InputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputRowProjection | InputRowProjection describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputScalarFilter | InputScalarFilter describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputStringField | InputStringField describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputUIOptions | Display metadata. For ordinary object, domain, section, aspect and group inputs,
optional note text appears after the fields. Omitted, blank or non-string notes
display nothing. Notes are plain text and add no input value.
Optional initialValueFrom is an absolute saved-input object-field path used only
when opening an input draft whose target field is absent. It copies a supplied
source value before using the declared default; explicit target values, including
zero, win. Omission, unknown/malformed paths, accessors, inherited properties and
array-row paths use the normal default. Optional initialValueScale defaults to 1
and multiplies an inherited finite number or Money amount, preserving currency.
Invalid scales (not finite and positive), unsupported source shapes and overflow
use the declared default. Explicit target values are never scaled.
A saved scenario's individually selected retired hidden leaf follows its unique
editable replacement alias and scale; explicit replacement selections win.
Reads do not mutate saved input data or
change direct calculation input validation. See the callable input.rate example. Model value shape: |
deccf.InputValidationError | InputValidationError describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputValue | InputValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputValueProjection | InputValueProjection describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputValueRecord | InputValueRecord describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputVisibility | InputVisibility describes a model value used by the Core model API editor functions. Model value shape: |
deccf.InputVisibilityRule | InputVisibilityRule describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LifecycleReference | LifecycleReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LockableInputReference | LockableInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LockableValue | LockableValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LookupKey | LookupKey describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LookupOptions | LookupOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.LookupReference | A symbolic scalar or declaration selected by an explicit related-row key. Model value shape: |
deccf.MetricDeclaration | MetricDeclaration describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricFunction | MetricFunction describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricOptions | MetricOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricsTiming | MetricsTiming describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricSummary | MetricSummary describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricTimingGroup | MetricTimingGroup describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricTimingSteps | MetricTimingSteps describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MetricValue | MetricValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ModelAccountDefinition | ModelAccountDefinition describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ModelBindings | ModelBindings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ModelCurrency | A fixed denomination or a declared fixed local currency-code input; no FX. Model value shape: |
deccf.ModelDefinition | Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments. Model value shape: |
deccf.ModelDescription | ModelDescription describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ModelMonteCarloOptions | Explicit fast trial contract. The full ordinary baseline is still published. Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments. Model value shape: |
deccf.ModelOptions | Optional model setting monteCarlo:{execution:'indexed',baselineMetrics:[...]} selects strict indexed Monte Carlo. Omission preserves general execution and its existing summaries. baselineMetrics defaults to []; entries must be unique names of declared metrics. Remaining sampled metrics need declarative metric({value,...}); every scheduled context is evaluated and the final summary retains the last defined emitted value. periodLength:1 and frequency:1 remain defaults; schedule.once(finalDate) selects only a final outcome. Supported sampled value sources are number, text or Money literals and input, calculation, calculation-projection or account references; direct flow, field and expression sources are rejected. All sampled ledger dependencies must support static indexed execution. A nonempty timeline without additional projection periods is required. Events, options, agreements, entity fields/lifecycles, derived inputs, triggered flows, expression bindings/amounts and account initializers using callbacks, expressions or calculations are unsupported. Unsupported callbacks, dynamic dependencies or unsupported graph features cause an error; there is no fallback. Baseline-only calculations can remain dynamic when outside sampled dependencies. Each named baseline metric is evaluated during the complete ordinary unseeded base calculation; its numeric final value is repeated across trials, so standard deviation is zero and all percentiles equal that base value. This is an author-selected fixed baseline statistic, not a sampled uncertainty estimate. Indexed mode summarizes declared numeric metrics only; implicit total, npv, irr and wal sampled summaries are omitted while the complete baseline retains ordinary results. Monthly periods, declared financial operations, global seeded draws, Sobol coordinates and monetary output valuation remain in effect. Active approximate mode (approximate:true with more than 1000 trials) is rejected; at most 1000 trials retain exact execution and inactive approximation metadata. Optional monteCarlo.series selects unique existing account.<name>.balance, flow.<name> or metric.<name> series in general or indexed execution. seriesSummaries[id] contains exact model dates and points of SampledSeriesPointSummary (trials, mean, standardDeviation, min, max and empirical percentiles) or null for missing observations; temporal points omit histograms while existing scalar MetricSummary retains distribution. Series metadata includes optional currency/unit and valuation metadata. Matching baseline arrays preserve the ordinary unseeded curve before annual amount storage. annual:{dates,points,baseline} aggregates each trial before statistics: flows sum, accounts use last balance, metrics follow annualAggregation and fiscalYearStartMonth. Money valuation precedes grouping; amountStorage never discards sampled original dates. Omitted series preserves the existing result shape and avoids temporal summary work. Baseline metric selection is also available in general execution. See Simulate uncertainty and Valuation and uncertainty for a complete callable example, supported values and validation. Optional monteCarlo.samplingLayout accepts only static-first when supplied; omission preserves the original Sobol layout. It preserves model-wide ctx.draw coordinates, promotes every declared bind.sample model-wide period slot before other ctx.sample owner/period slots, and removes promoted slots from the remaining namespace to avoid aliasing. Annual bindings promote the first represented period of each calendar year, including partial years; period bindings promote every period. Inputs sort by declared name and periods chronologically; duplicate consumers share their existing logical sample. Slots are reserved for unused bindings, branches and overridden inputs before execution, so call order and worker partitioning cannot change streams. The opt-in changes Sobol sample streams but leaves pseudorandom streams unchanged; it works in general and indexed execution. The 21,201 actual-coordinate limit still applies and out-of-range dynamic samples fail explicitly. samplingDimensions retains the full potential namespace size, including unused owner/period slots; static-first reorders it rather than limiting supported sampling identities. Structural model changes may change stream assignments. Model value shape: |
deccf.ModelScenarioSuggestion | Optional editable calculator starting points. Arrays and monetary leaves are complete values. Model value shape: |
deccf.Money | Money describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MoneyValue | Selects output purchasing power for run(), runMonteCarlo() and runScenarios(). The supported string values are 'nominal' (default) and 'today'. 'today' expresses declared monetary outputs at the first resolved timeline date using the model's annual inflation; plain numbers, rates and text retain their values. Other strings are rejected. Results record the selection as moneyValue, alongside inflation and moneyValueBaseDate. Model value shape: |
deccf.MonteCarloControls | Optional third runMonteCarlo argument, defaulting to {}. onProgress receives a readonly MonteCarloProgress snapshot synchronously. Observer errors are ignored and return values are not awaited. Omission disables observation. Keep this callback separate from options; it is absent from results, receipts and cache identities. The financial model does not own progress UI. See runMonteCarlo for a complete callable example. Model value shape: |
deccf.MonteCarloOptions | MonteCarloOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MonteCarloProgress | Immutable completed-work snapshot supplied to the optional runMonteCarlo third-argument observer. phase is preparing, baseline, trials, finalizing or complete. completedTrials and totalTrials count trials; completedWork and totalWork also count one baseline and one final summary (N + 2). baselineComplete records whether the ordinary base calculation has finished. Baseline order follows the execution strategy. Counts measure actual completed units, not elapsed time; snapshots may be coalesced. complete is emitted only on success. See runMonteCarlo for a callable observation example and Calculation progress for automatic Calculator feedback. Model value shape: |
deccf.MonteCarloResult | MonteCarloResult describes a model value used by the Core model API editor functions. Model value shape: |
deccf.MonteCarloTimings | MonteCarloTimings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.NumericDomain | NumericDomain describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectArrayInputReference | ObjectArrayInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectArrayOptions | ObjectArrayOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectConstraintOptions | ObjectConstraintOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectInputConstraint | A relation between compatible numeric, same-currency Money, or date leaves of one object. Model value shape: |
deccf.ObjectInputOptions | ObjectInputOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectInputReference | ObjectInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantArrayInputReference | ObjectVariantArrayInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantArrayOptions | ObjectVariantArrayOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantCatalogue | ObjectVariantCatalogue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantInputReference | ObjectVariantInputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantOptions | ObjectVariantOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantSelectionMode | ObjectVariantSelectionMode describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ObjectVariantValue | ObjectVariantValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.OnceBindingReference | OnceBindingReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.OnceContext | Initialization context for bind.once: configuration inputs and declared bindings only, without time or ledger reads. Model value shape: |
deccf.OnceData | Data-only configuration snapshots preserve model references but reject functions at every nesting level. Model value shape: |
deccf.OptionReference | OptionReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ParameterBindingReference | ParameterBindingReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PhaseReference | PhaseReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.Placement | Placement describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PreparedModel | PreparedModel describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PreparedOutputReference | PreparedOutputReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PreparedOutputs | PreparedOutputs describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PreparedOutputValues | PreparedOutputValues describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PreparedRunOptions | Values allowed to change without preparing model structure again. Other options are rejected by prepared.run(). Model value shape: |
deccf.PresentationCalculationReference | One actual published calculation or projection. Model value shape: |
deccf.PresentationCalculationSource | PresentationCalculationSource describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationDataCard | PresentationDataCard describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationDataOptions | PresentationDataOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationDeclaredDataCard | Presentation-owned display metadata; no callbacks or executable properties. Model value shape: |
deccf.PresentationInputNumberExpression | A display coordinate only: finite numbers, numeric inputs, or two-operand addition.
Addition may nest to depth 32 and must produce a finite result. Model value shape: |
deccf.PresentationInputNumberList | PresentationInputNumberList describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationInputRowsSelection | PresentationInputRowsSelection describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationInputSelector | Declared inputs bind to the effective input value in each selected scenario. Model value shape: |
deccf.PresentationMetricExpression | Selected sampled metric percentile, finite numeric constant, or bounded arithmetic expression.
Subtract requires equal units/currencies; multiply accepts at most one Money operand.
Divide supports number/number, Money/number and same-currency Money/Money.
Missing sampled observations propagate null. Zero division defaults to null.
Clamps are finite amounts in the expression's resulting unit; nesting is limited to 32 levels.
nullAbove selects a same-unit sampled limit; after clamps, values above it or with a missing limit become null. Model value shape: |
deccf.PresentationMetricSelector | PresentationMetricSelector describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationSampledCalculationSource | Overlay actual sampled percentile expressions onto existing declared numeric/Money fields.
Paths are safe dot-separated own-property paths relative to values; absent rows are skipped.
Ordinary runs retain the published values. In Monte Carlo, unavailable sampled percentiles
become null. Money retains the published target currency/date; expression units must match.
values must be one ordinary calculation reference/projection; nested wrappers are unsupported. Model value shape: |
deccf.PresentationSnapshotOptions | PresentationSnapshotOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationStandardSeriesColumn | PresentationStandardSeriesColumn describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationStandardSeriesOptions | PresentationStandardSeriesOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationStandardSeriesSource | PresentationStandardSeriesSource describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PresentationZeroDivisionPolicy | On a zero divisor, choose by whether the numerator is also zero. Both outcomes are required. Model value shape: |
deccf.PreviousBindingReference | A prior calculation value; project selects a validated result field and preserves the first-period zero sentinel. Model value shape: |
deccf.PriorityOptions | PriorityOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ProportionalOptions | ProportionalOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PublishedCalculationRecord | PublishedCalculationRecord describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PublishedCalculationSeries | PublishedCalculationSeries describes a model value used by the Core model API editor functions. Model value shape: |
deccf.PublishedCalculationValue | PublishedCalculationValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RecordChartOptions | RecordChartOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RecurringScheduleOptions | RecurringScheduleOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.Reference | Reference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ReferenceKind | ReferenceKind describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatColumnReference | RepeatColumnReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatedComponentReference | RepeatedComponentReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatFilter | RepeatFilter describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatItem | RepeatItem describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatOutputProjection | RepeatOutputProjection describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RepeatViewReference | RepeatViewReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ReportGroupOptions | ReportGroupOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResolveCashflowAccounts | ResolveCashflowAccounts describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResolvedCashflowBookings | ResolvedCashflowBookings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultCategory | ResultCategory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultMoney | ResultMoney describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultScalar | ResultScalar describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultSeries | ResultSeries describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultSeriesIndex | Describes this series' own observation periods. Annual monetary storage adds dates (actual first covered source date), inclusive periodEnds, periodLabels and sourceCalendar; calendar is annual or fiscal-year. Partial years retain actual bounds. Its values must be paired with these dates rather than the unchanged monthly result.dates. Different fiscal owners may have different indexes. Model value shape: |
deccf.ResultSeriesValue | ResultSeriesValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultsGraphAccount | ResultsGraphAccount describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultsGraphAgreement | ResultsGraphAgreement describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultsGraphEntity | ResultsGraphEntity describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultsInputPrecondition | ResultsInputPrecondition describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ResultTimings | ResultTimings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.RunOptions | Optional amountStorage accepts 'period' (default), 'calendar-year' or 'fiscal-year'; other values are rejected. Annual storage compacts published monetary series, compatibility cashflow series, account postings and report groups. Flows and postings sum after output valuation; account balances keep their last observation; Money-valued metrics and numeric metrics with unit:'money' use annualAggregation ('last' by default). Fiscal grouping follows each owner's attributes.fiscalYearStartMonth (integer 1–12); ownerless values use January, and a metric's explicit fiscal start takes precedence. Source periods belong to their start-date year and are never split or prorated. Each compacted series index publishes actual covered dates, inclusive periodEnds, periodLabels and sourceCalendar, including partial years. Account postings retain account, flow, side, owner, category and flow_role, with periodEnd and periodLabel; period remains the original first calculation-period index. Report groups have an equivalent annual index. The calculation timeline, result.dates, live reference accessors, nonmonetary series and authored structured calculation records retain their original detail. Final metrics and Monte Carlo summaries are unchanged; only the ordinary baseline's published money observations are compacted. Shared scenario options apply to every scenario, and prepare() fixes the option at preparation. Result metadata amountStorage appears only in annual modes. Native reports use annual views; differing fiscal calendars require an owner selection, and calendar-year-only views cannot split fiscal totals. See Store monetary results by year for a monthly model example and output limits. Model value shape: |
deccf.RuntimeParameterValue | RuntimeParameterValue describes a model value used by the Core model API editor functions. Model value shape: |
deccf.SampledSeriesPointSummary | Numeric temporal uncertainty: moments and empirical percentiles. Histograms are
retained in scalar MetricSummary results, rather than repeated at every date. Model value shape: |
deccf.SampledSeriesSummary | Pointwise uncertainty in an explicitly selected standard result series. Amounts
use the run's money valuation; missing observations remain null and each point's
trials counts only defined numeric observations. Annual values aggregate within
each trial before statistics (flow=sum, account=last, metrics use their declaration). Model value shape: |
deccf.ScenarioAnalysisOptions | ScenarioAnalysisOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ScenarioResultList | ScenarioResultList describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ScenarioRunResult | ScenarioRunResult describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ScenarioTimings | ScenarioTimings describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ScheduleFactory | ScheduleFactory describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ScheduleReference | ScheduleReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.SniMainGroup | SniMainGroup describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StandardSeriesTableOptions | Temporal mode; existing custom-record source/columns options remain supported separately. Model value shape: |
deccf.StatementBalance | StatementBalance describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StatementOptions | StatementOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StateReference | StateReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StateTransition | StateTransition describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StaticBookingAmount | StaticBookingAmount describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StaticBookingRow | StaticBookingRow describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StaticCalculationContext | Fixed callback context for static calculations and flows. Read declared values from the first callback argument. Model value shape: |
deccf.StaticCalculationOptions | StaticCalculationOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StaticCallback | StaticCallback describes a model value used by the Core model API editor functions. Model value shape: |
deccf.StaticCashflowOptions | StaticCashflowOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TableToSieOptions | TableToSieOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TextMetricFunction | TextMetricFunction describes a model value used by the Core model API editor functions. Model value shape: |
deccf.ThresholdAnalysisOptions | ThresholdAnalysisOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TimeContext | TimeContext describes a model value used by the Core model API editor functions. Model value shape: |
deccf.Timeline | Timeline describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TimelineOptions | TimelineOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TransferOptions | TransferOptions describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TransferOutputs | TransferOutputs describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TransferPostingPolicy | TransferPostingPolicy describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TriggerReference | TriggerReference describes a model value used by the Core model API editor functions. Model value shape: |
deccf.TriggerSource | TriggerSource describes a model value used by the Core model API editor functions. Model value shape: |
deccf.UncertaintyChartOptions | UncertaintyChartOptions describes a model value used by the Core model API editor functions. Model value shape: |
Swedish Income Tax module
Select this module in model settings to use its names in the portal model editor (modules["swedish-income-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-income-tax"].assessSwedishIncomeTax2025 | Assess already classified annual SEK bases with the established 2025 tax rules. dateOfBirth is required; taxBases/rules/derive/propertyAssessments use the existing 2025 contract and defaults, but all values must be resolved numbers/booleans; tax bases and assessmentValue also accept same-currency SEK Money. The result contains liability, grossIncome and the complete component map plus explicit country/currency/year/annual-period metadata. It declares no payment, tax card or timeline and performs no extrapolation or conversion to newer rules. Invalid dates, unknown bases/options/rules and unresolved monetary values fail.
|
| |
modules["swedish-income-tax"].personalTax | personalTax provides personal tax in the Swedish Income Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-income-tax"].SWEDISH_INCOME_TAX_2025_BASE | SWEDISH_INCOME_TAX_2025_BASE is a model value for swedish income tax 2025 base in the Swedish Income Tax editor.
|
| |
modules["swedish-income-tax"].SWEDISH_INCOME_TAX_2025_BASES | SWEDISH_INCOME_TAX_2025_BASES is a model value for swedish income tax 2025 bases in the Swedish Income Tax editor.
|
| |
modules["swedish-income-tax"].SWEDISH_INCOME_TAX_2025_COMPONENTS | SWEDISH_INCOME_TAX_2025_COMPONENTS is a model value for swedish income tax 2025 components in the Swedish Income Tax editor.
|
| |
modules["swedish-income-tax"].SWEDISH_INCOME_TAX_2025_PERSONAL_ACCOUNT_MAPPINGS | SWEDISH_INCOME_TAX_2025_PERSONAL_ACCOUNT_MAPPINGS is a model value for swedish income tax 2025 personal account mappings in the Swedish Income Tax editor.
|
| |
modules["swedish-income-tax"].SWEDISH_INCOME_TAX_SETTLEMENT_DELAY_DAYS | SWEDISH_INCOME_TAX_SETTLEMENT_DELAY_DAYS is a model value for swedish income tax settlement delay days in the Swedish Income Tax editor.
|
| |
modules["swedish-income-tax"].swedishIncomeTax | swedishIncomeTax provides swedish income tax in the Swedish Income Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-income-tax"].swedishIncomeTaxSettlement | swedishIncomeTaxSettlement provides swedish income tax settlement in the Swedish Income Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-income-tax"].swedishPreliminaryIncomeTax | swedishPreliminaryIncomeTax provides swedish preliminary income tax in the Swedish Income Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-income-tax"].swedishPropertyAssessments2025 | Keyed assessment records using explicit January 1 ownership, accepted by all tax wrappers.
|
| |
modules["swedish-income-tax"].swedishPropertyCharges2025 | Gross annual SEK Money charges by preserved property ID; unkeyed bases remain unallocated.
|
| |
modules["swedish-income-tax"].PersonalTaxComponent | PersonalTaxComponent describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].PersonalTaxOptions | PersonalTaxOptions describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].PersonalTaxOutputs | PersonalTaxOutputs describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishIncomeTax2025Assessment | SwedishIncomeTax2025Assessment describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishIncomeTax2025AssessmentOptions | SwedishIncomeTax2025AssessmentOptions describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishIncomeTax2025PersonalAccountMapping | SwedishIncomeTax2025PersonalAccountMapping describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishIncomeTax2025Rules | SwedishIncomeTax2025Rules describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishIncomeTaxOptions | SwedishIncomeTaxOptions describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPreliminaryIncomeTaxOptions | SwedishPreliminaryIncomeTaxOptions describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPreliminaryTaxBasis | SwedishPreliminaryTaxBasis describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPropertyAssessment | SwedishPropertyAssessment describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPropertyAssessments2025Options | SwedishPropertyAssessments2025Options describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPropertyChargeProfile2025 | SwedishPropertyChargeProfile2025 describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPropertyCharges2025Options | SwedishPropertyCharges2025Options describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishPropertyCollectionSource | SwedishPropertyCollectionSource describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishTaxBasisSource | An explicit year basis is added to the mapped account-read bases at calculation time. Model value shape: |
modules["swedish-income-tax"].SwedishTaxBooleanSource | SwedishTaxBooleanSource describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].SwedishTaxSourceOptions | SwedishTaxSourceOptions describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
modules["swedish-income-tax"].TaxPublicationOutput | TaxPublicationOutput describes a model value used by the Swedish Income Tax editor functions. Model value shape: |
Danish Income Tax module
Select this module in model settings to use its names in the portal model editor (modules["danish-income-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["danish-income-tax"].assessDanishIncomeTax | Pure national assessment with the same required profile, defaults, units and result as danishIncomeTax. Uses explicit 2026/full-year data; no timeline, owner, references, callbacks or payments. Amount Money must use the local currency. birthYear/rates/children must be plain finite numbers. Unknown options and every unsupported native profile fail explicitly.
|
| |
modules["danish-income-tax"].DANISH_INCOME_TAX_2026 | Official 2026 rule parameters and primary-source provenance, reviewed 2026-10-16.
|
| |
modules["danish-income-tax"].danishIncomeTax | Declares published Danish income tax for a single, full-year resident in 2026, in DKK. Register the reference in model calculations; .project("incomeTax") selects total tax. Requires ruleYear:2026, residency:"full-year", birthYear, municipalRate, civilStatus:"single", seniorSupplement:false and singleParentSupplement:false. birthYear can be an input. salary is the year's AM-assessable salary after ATP and without pension-premium deductions; pension is ordinary taxable pension income. netCapitalIncome is positive net capital income; shareIncome is separately classified share income. Amounts and churchRate default to 0. municipalRate/churchRate are actual local rates as decimals, not percentages. The AM contribution, progressive national taxes, local taxes, employment/job deductions, tax value of the personal allowance and both tax ceilings are calculated. components are before credits; incomeTax is after credits. totalBurden counts the AM contribution once; socialContributions is 0. All result amounts are DKK. prepaidTax defaults to 0; balanceAfterPrepayments compares tax with the actual annual prepayment. owner/name are optional. Final authority rounding, tax cards, payment dates and interest are not calculated; roundingScope is before-payment-rounding. The timeline and currency must be 2026 and DKK. Negative capital bases, spouses, special supplements, pension-premium deductions and salary profiles for people born before 1966 are rejected. Unknown options and unsupported regimes are rejected without fallback rules.
|
| |
modules["danish-income-tax"].DanishIncomeTaxAssessmentOptions | Resolved native options: numeric sources are numbers (or same-currency Money for amounts); no references/callbacks. Model value shape: |
modules["danish-income-tax"].DanishIncomeTaxOptions | DanishIncomeTaxOptions describes a model value used by the Danish Income Tax editor functions. Model value shape: |
modules["danish-income-tax"].DanishIncomeTaxResult | DanishIncomeTaxResult describes a model value used by the Danish Income Tax editor functions. Model value shape: |
modules["danish-income-tax"].IncomeTaxRuleSet | IncomeTaxRuleSet describes a model value used by the Danish Income Tax editor functions. Model value shape: |
modules["danish-income-tax"].TaxAmountSource | TaxAmountSource describes a model value used by the Danish Income Tax editor functions. Model value shape: |
modules["danish-income-tax"].TaxNumberSource | TaxNumberSource describes a model value used by the Danish Income Tax editor functions. Model value shape: |
Finnish Income Tax module
Select this module in model settings to use its names in the portal model editor (modules["finnish-income-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["finnish-income-tax"].assessFinnishIncomeTax | Pure national assessment with the same required profile, defaults, units and result as finnishIncomeTax. Uses explicit 2026/full-year data; no timeline, owner, references, callbacks or payments. Amount Money must use the local currency. birthYear/rates/children must be plain finite numbers. Unknown options and every unsupported native profile fail explicitly.
|
| |
modules["finnish-income-tax"].FINNISH_INCOME_TAX_2026 | Official 2026 rule parameters and primary-source provenance, reviewed 2026-10-16.
|
| |
modules["finnish-income-tax"].finnishIncomeTax | Declares published Finnish income tax in EUR for a full-year mainland resident in 2026. Register the reference in calculations; .project("incomeTax") returns total tax. Requires ruleYear:2026, residency:"full-year", birthYear, territory:"mainland" and municipalRate. birthYear, amounts, rates and children can be named inputs or references. Choose one annual income class: salary, pension or ordinary taxable benefits; each defaults to 0. churchRate is 0 for non-members. taxableCapitalIncome is an already classified net basis, not interest subject to separate withholding. productionExpenses can provide actual employment expenses above the EUR 750 standard allowance, capped at salary. children defaults to 0 and singleParent to false. National, municipal, church and public-health taxes, daily allowance contribution, broadcasting tax, additional pension-income tax, capital tax and automatic deductions/credits are calculated. The earned-income credit reduces national tax first and then other applicable taxes proportionally. incomeTax follows the official cent-rounded tax components; socialContributions shows employee pension and unemployment insurance separately; totalBurden counts them once. All result amounts are EUR; roundingScope is euro-cents. prepaidTax defaults to 0; balanceAfterPrepayments is tax minus actual prepayments. owner/name are optional. The timeline and currency must be 2026 and EUR. Salary profiles are supported for people born from 1962 through 2007. Mixed income classes, Åland, capital deficits, expense losses, special deductions and unknown options are rejected. Tax cards, interest, due dates and bank payments are not created.
|
| |
modules["finnish-income-tax"].FinnishIncomeTaxAssessmentOptions | Resolved native options: numeric sources are numbers (or same-currency Money for amounts); no references/callbacks. Model value shape: |
modules["finnish-income-tax"].FinnishIncomeTaxOptions | FinnishIncomeTaxOptions describes a model value used by the Finnish Income Tax editor functions. Model value shape: |
modules["finnish-income-tax"].FinnishIncomeTaxResult | FinnishIncomeTaxResult describes a model value used by the Finnish Income Tax editor functions. Model value shape: |
modules["finnish-income-tax"].IncomeTaxRuleSet | IncomeTaxRuleSet describes a model value used by the Finnish Income Tax editor functions. Model value shape: |
modules["finnish-income-tax"].TaxAmountSource | TaxAmountSource describes a model value used by the Finnish Income Tax editor functions. Model value shape: |
modules["finnish-income-tax"].TaxNumberSource | TaxNumberSource describes a model value used by the Finnish Income Tax editor functions. Model value shape: |
Icelandic Income Tax module
Select this module in model settings to use its names in the portal model editor (modules["icelandic-income-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["icelandic-income-tax"].assessIcelandicIncomeTax | Pure national assessment with the same required profile, defaults, units and result as icelandicIncomeTax. Uses explicit 2026/full-year data; no timeline, owner, references, callbacks or payments. Amount Money must use the local currency. birthYear/rates/children must be plain finite numbers. Unknown options and every unsupported native profile fail explicitly.
|
| |
modules["icelandic-income-tax"].ICELANDIC_INCOME_TAX_2026 | Official 2026 rule parameters and primary-source provenance, reviewed 2026-10-16.
|
| |
modules["icelandic-income-tax"].icelandicIncomeTax | Declares published Icelandic income tax in ISK for an adult full-year resident in 2026. Register the reference in calculations; .project("incomeTax") returns total tax. Requires ruleYear:2026, residency:"full-year", birthYear and period:"annual" or "monthly". Annual mode requires the actual municipalRate. Monthly mode uses the official 14.94% average withholding rate and rejects municipalRate. Amounts are annual totals or current- month totals across all payers, respectively. salary/pension default to 0. Actual pensionContribution/additionalPensionContribution default to 0 and may each be at most 4% of salary. The annual credit is ISK 869898; the monthly availablePersonalCredit defaults to ISK 72492. Supply the substantiated monthly credit available; unused earlier credit is not assumed. qualifiedCapitalIncome shares an annual allowance for qualifying interest/listed shares; otherCapitalIncome is another classified capital basis. Both default to 0 and are rejected in monthly mode. Unused personal credit is not offset against capital tax in 2026. incomeTax is national/local/capital tax after credits; socialContributions contains the pension payments entered and totalBurden counts them once. All result amounts are ISK. prepaidTax defaults to 0; balanceAfterPrepayments is calculated tax minus actual prepayments for the same period. owner/name are optional. Amounts, rates and birthYear support inputs. roundingScope is before-payment-rounding: final payment rounding, interest, collection dates, spouse transfers, flat fees and special regimes are unsupported. The timeline and currency must be 2026 and ISK. Unknown options are rejected without fallback rules.
|
| |
modules["icelandic-income-tax"].IcelandicIncomeTaxAssessmentOptions | Resolved native options: numeric sources are numbers (or same-currency Money for amounts); no references/callbacks. Model value shape: |
modules["icelandic-income-tax"].IcelandicIncomeTaxOptions | IcelandicIncomeTaxOptions describes a model value used by the Icelandic Income Tax editor functions. Model value shape: |
modules["icelandic-income-tax"].IcelandicIncomeTaxResult | IcelandicIncomeTaxResult describes a model value used by the Icelandic Income Tax editor functions. Model value shape: |
modules["icelandic-income-tax"].IncomeTaxRuleSet | IncomeTaxRuleSet describes a model value used by the Icelandic Income Tax editor functions. Model value shape: |
modules["icelandic-income-tax"].TaxAmountSource | TaxAmountSource describes a model value used by the Icelandic Income Tax editor functions. Model value shape: |
modules["icelandic-income-tax"].TaxNumberSource | TaxNumberSource describes a model value used by the Icelandic Income Tax editor functions. Model value shape: |
Norwegian Income Tax module
Select this module in model settings to use its names in the portal model editor (modules["norwegian-income-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["norwegian-income-tax"].assessNorwegianIncomeTax | Pure national assessment with the same required profile, defaults, units and result as norwegianIncomeTax. Uses explicit 2026/full-year data; no timeline, owner, references, callbacks or payments. Amount Money must use the local currency. birthYear/rates/children must be plain finite numbers. Unknown options and every unsupported native profile fail explicitly.
|
| |
modules["norwegian-income-tax"].NORWEGIAN_INCOME_TAX_2026 | Official 2026 rule parameters and primary-source provenance, reviewed 2026-10-16.
|
| |
modules["norwegian-income-tax"].norwegianIncomeTax | Declares published Norwegian income tax in NOK for an ordinary adult full-year employee in 2026. Register the reference in calculations; .project("incomeTax") returns total tax. Requires ruleYear:2026, residency:"full-year", birthYear and region:"ordinary" or "intervention-zone". The zone requires substantiated residence in Finnmark/North-Troms. salary is ordinary taxable annual salary, capitalIncome is classified ordinary capital income, and interestExpenses is actual deductible interest; each defaults to 0. These amounts and birthYear support inputs. The minimum standard deduction, personal allowance, zone deduction/rate, progressive bracket tax and social-security contribution threshold and phase-in are calculated. Capital does not affect bracket tax on personal income. incomeTax includes the social-security contribution; totalBurden counts it once and socialContributions is 0. Result bases/deductions/credits/components are NOK. prepaidTax defaults to 0; balanceAfterPrepayments compares it with actual prepayments for that year. owner/name are optional. People born from 1991 through 2006 must provide the actual trial selection notice as youngWorkerTrialSelected:false. Selected trial participants, pensions, salary profiles for people born before 1960, PAYE, capital losses, the special uplift/shielding of share income, wealth tax and special deductions are unsupported. roundingScope is before-payment-rounding. Final authority rounding, tax cards, due dates, interest and bank payments are not calculated. The timeline and currency must be 2026 and NOK. Unknown options and regimes are rejected without Swedish or other fallback rules.
|
| |
modules["norwegian-income-tax"].IncomeTaxRuleSet | IncomeTaxRuleSet describes a model value used by the Norwegian Income Tax editor functions. Model value shape: |
modules["norwegian-income-tax"].NorwegianIncomeTaxAssessmentOptions | Resolved native options: numeric sources are numbers (or same-currency Money for amounts); no references/callbacks. Model value shape: |
modules["norwegian-income-tax"].NorwegianIncomeTaxOptions | NorwegianIncomeTaxOptions describes a model value used by the Norwegian Income Tax editor functions. Model value shape: |
modules["norwegian-income-tax"].NorwegianIncomeTaxResult | NorwegianIncomeTaxResult describes a model value used by the Norwegian Income Tax editor functions. Model value shape: |
modules["norwegian-income-tax"].TaxAmountSource | TaxAmountSource describes a model value used by the Norwegian Income Tax editor functions. Model value shape: |
modules["norwegian-income-tax"].TaxNumberSource | TaxNumberSource describes a model value used by the Norwegian Income Tax editor functions. Model value shape: |
Swedish Amortization module
Select this module in model settings to use its names in the portal model editor (modules["swedish-amortization"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-amortization"].swedishAmortization | Ordinary statutory amortization, including interest, for use as loanPlan.payment.
|
| |
modules["swedish-amortization"].swedishMortgagePolicy | swedishMortgagePolicy provides swedish mortgage policy in the Swedish Amortization model editor. Use it when a model needs this operation.
|
| |
modules["swedish-amortization"].SwedishMortgagePolicy | SwedishMortgagePolicy describes a model value used by the Swedish Amortization editor functions. Model value shape: |
modules["swedish-amortization"].SwedishMortgagePolicyOptions | SwedishMortgagePolicyOptions describes a model value used by the Swedish Amortization editor functions. Model value shape: |
Accountplan module
Select this module in model settings to use its names in the portal model editor (modules.accountplan).
| Model editor name | Purpose and model value shape |
|---|---|
modules.accountplan.businessAccountPlan | businessAccountPlan is a model value for business account plan in the Accountplan editor.
|
| |
modules.accountplan.businessAccountPlan.bookClosing | businessAccountPlan.bookClosing provides book closing in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.businessAccountPlan.categoryFor | Accepts an account code, a category node code, or a full category path.
|
| |
modules.accountplan.businessAccountPlan.categoryForClass | businessAccountPlan.categoryForClass provides category for class in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.businessAccountPlan.categoryForGroup | businessAccountPlan.categoryForGroup provides category for group in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.businessAccountPlan.findForAccount | Return the plan entry associated with an account carrying that entry's category.
|
| |
modules.accountplan.businessAccountPlan.fiscalYearFor | Resolve the fiscal year containing a date for the owner entity.
|
| |
modules.accountplan.businessAccountPlan.fiscalYearStartMonth | Read fiscalYearStartMonth from the owner entity attributes; defaults to January.
|
| |
modules.accountplan.businessAccountPlan.get | businessAccountPlan.get provides get in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.businessAccountPlan.ownerForAccount | Return the account owner's entity reference.
|
| |
modules.accountplan.businessAccountPlan.roleAccounts | Find actual owner-specific accounts that match a role's labels or account-code prefixes.
|
| |
modules.accountplan.defineAccountPlan | defineAccountPlan creates or declares define account plan in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input | Input is a model value for input in the Accountplan editor.
|
| |
modules.accountplan.Input.aspect | Input.aspect provides aspect in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.boolean | Input.boolean provides boolean in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.boolen | Alias of boolean, retained for existing models.
|
| |
modules.accountplan.Input.curve | Input.curve provides curve in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.date | Input.date provides date in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.decimal | Input.decimal provides decimal in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.domain | Input.domain provides domain in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.enum | Input.enum provides enum in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.familyRole | Input.familyRole provides family role in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.fraction | Input.fraction provides fraction in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.group | Input.group provides group in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.groups | Creates one connected group per matching keyed source row. Returns an ordinary object-array input with hidden, protected id and name fields. Source rename/reorder preserves surviving nested editable data by source key; additions use field defaults and removals remove the associated group. id/name are reserved in fields. Source must be an ordinary object array; label must name a source string field and filters must match scalar types. Example: deccf.input.groups(businesses, {projects:deccf.input.objectArray(projectRows)}, {where:{active:true}}).
|
| |
modules.accountplan.Input.id | Input.id provides id in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.integer | Input.integer provides integer in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.lockable | Input.lockable provides lockable in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.logNormal | Input.logNormal provides log normal in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.money | Input.money provides money in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.normal | Input.normal provides normal in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.object | Input.object provides object in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.Object | Input.Object provides object in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.objectArray | Creates mixed rows from object variants. `type` is `manyOfAnyChangeable`, `manyOfAny` or `anyOf`. Example: `deccf.input.objectArray([isk, vp], {type: "manyOfAnyChangeable", title: "Sparande"})`.
|
| |
modules.accountplan.Input.rate | Input.rate provides rate in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.readonly | Input.readonly provides readonly in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.readOnly | Input.readOnly provides read only in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.section | Input.section provides section in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.sni | An empty value asks domain methods to infer the industry from account history.
|
| |
modules.accountplan.Input.stdAccountValues | Input.stdAccountValues provides std account values in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.str | Input.str provides str in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.tableToSie | Input.tableToSie provides table to sie in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.textfile | Input.textfile provides textfile in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.triangular | Input.triangular provides triangular in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.Input.uniform | Input.uniform provides uniform in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.loanAccounting | Book loan movements without duplicating the cashflows generated by loanPlan. Opening balances remain explicit.
|
| |
modules.accountplan.paymentAttribution | paymentAttribution provides payment attribution in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan | personalAccountPlan is a model value for personal account plan in the Accountplan editor.
|
| |
modules.accountplan.personalAccountPlan.bookClosing | personalAccountPlan.bookClosing provides book closing in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.categoryFor | Accepts an account code, a category node code, or a full category path.
|
| |
modules.accountplan.personalAccountPlan.categoryForClass | personalAccountPlan.categoryForClass provides category for class in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.categoryForGroup | personalAccountPlan.categoryForGroup provides category for group in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.findForAccount | Return the plan entry associated with an account carrying that entry's category.
|
| |
modules.accountplan.personalAccountPlan.fiscalYearFor | Resolve the fiscal year containing a date for the owner entity.
|
| |
modules.accountplan.personalAccountPlan.fiscalYearStartMonth | Read fiscalYearStartMonth from the owner entity attributes; defaults to January.
|
| |
modules.accountplan.personalAccountPlan.get | personalAccountPlan.get provides get in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.income | personalAccountPlan.income provides income in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.ownerContribution | personalAccountPlan.ownerContribution provides owner contribution in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.personalAccountPlan.ownerForAccount | Return the account owner's entity reference.
|
| |
modules.accountplan.personalAccountPlan.roleAccounts | Find actual owner-specific accounts that match a role's labels or account-code prefixes.
|
| |
modules.accountplan.reallocateExpense | reallocateExpense({from,to,code,amount,weights?,schedule?}) returns a posting component; register it. from is an entity; to an entity, array, keyed entity map or repeated entity output. Recipients differ from source/each other. code is a personal-plan expense code; amount is nonnegative in model currency. Moves recognition through owners' net worth without payment. weights defaults equal: scalar sources for one recipient, ordered arrays, exact-key source maps, repeated numeric columns or numeric calculation output maps. Maps exactly match recipient IDs; register source repeats. Weights are finite/nonnegative; positive expense needs positive total, zero permits all-zero weights. schedule defaults monthly. Invalid entities/codes/shape/currency/amounts/weights reject. Tax eligibility stays separate; existing maps/arrays retain meaning.
|
| |
modules.accountplan.revalueAsset | Adjust an asset's opening carrying value to the specified nonnegative target.
|
| |
modules.accountplan.stdaccount | Create or reuse an account from the Business or Personal plan. Company, person, and household entities may be owners. All codes, including numeric-looking codes, are strings.
|
| |
modules.accountplan.stdAccountValues | stdAccountValues provides std account values in the Accountplan model editor. Use it when a model needs this operation.
|
| |
modules.accountplan.AccountingAmountSource | AccountingAmountSource describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlan | AccountPlan describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanAccount | AccountPlanAccount describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanAccountDefinition | AccountPlanAccountDefinition describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanCategory | AccountPlanCategory describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanCategoryDefinition | AccountPlanCategoryDefinition describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanRoleDefinition | AccountPlanRoleDefinition describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountPlanType | AccountPlanType describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountRoleAccount | AccountRoleAccount describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.AccountValuesMatrix | Original matrix representation retained in saved input values. Model value shape: |
modules.accountplan.BookClosingOptions | BookClosingOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.BusinessAccountPlan | BusinessAccountPlan describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.LoanAccountingOptions | LoanAccountingOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.NormalBalance | NormalBalance describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.PaymentAttributionOptions | PaymentAttributionOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.PaymentAttributionValue | PaymentAttributionValue describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.PersonalAccountPlan | PersonalAccountPlan describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.ReallocateExpenseOptions | ReallocateExpenseOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.RevalueAssetOptions | RevalueAssetOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.StandardAccountOptions | StandardAccountOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.StdAccountValuesOptions | StdAccountValuesOptions describes a model value used by the Accountplan editor functions. Model value shape: |
modules.accountplan.StdAccountValuesReference | StdAccountValuesReference describes a model value used by the Accountplan editor functions. Model value shape: |
Business Metrics module
Select this module in model settings to use its names in the portal model editor (modules["business-metrics"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["business-metrics"].businessMetricDefinitions | businessMetricDefinitions is a model value for business metric definitions in the Business Metrics editor.
|
| |
modules["business-metrics"].BusinessMetricDefinition | BusinessMetricDefinition describes a model value used by the Business Metrics editor functions. Model value shape: |
Household module
Select this module in model settings to use its names in the portal model editor (modules.household).
| Model editor name | Purpose and model value shape |
|---|---|
modules.household.borrowingCapacity | borrowingCapacity provides borrowing capacity in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.household | Create a household entity that party entities can reference through their owner option.
|
| |
modules.household.HOUSEHOLD_BUDGET_CATEGORIES | HOUSEHOLD_BUDGET_CATEGORIES is a model value for household budget categories in the Household editor.
|
| |
modules.household.householdBudget | Declare the monthly 2026 Consumer Agency budget need and ordinary expense postings.
|
| |
modules.household.householdInputs | householdInputs is a model value for household inputs in the Household editor.
|
| |
modules.household.householdInputs.budgetOverrides | householdInputs.budgetOverrides provides budget overrides in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.householdInputs.members | householdInputs.members provides members in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.householdInputs.person | householdInputs.person provides person in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.householdPeople | householdPeople provides household people in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.inputs | Input factories shared by household model examples.
|
| |
modules.household.inputs.familyRole | inputs.familyRole provides family role in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.KONSUMENTVERKET_BUDGET_YEAR | KONSUMENTVERKET_BUDGET_YEAR is a model value for konsumentverket budget year in the Household editor.
|
| |
modules.household.mortgageAffordability | mortgageAffordability provides mortgage affordability in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.swedishMortgagePolicy | swedishMortgagePolicy provides swedish mortgage policy in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.sym | Provides built-in numeric domains for common positive and percentage inputs.
|
| |
modules.household.sym.budgetMode | sym.budgetMode provides budget mode in the Household model editor. Use it when a model needs this operation.
|
| |
modules.household.HouseholdBudgetBreakdown | HouseholdBudgetBreakdown describes a model value used by the Household editor functions. Model value shape: |
modules.household.HouseholdBudgetCategoryKey | HouseholdBudgetCategoryKey describes a model value used by the Household editor functions. Model value shape: |
modules.household.HouseholdBudgetOptions | HouseholdBudgetOptions describes a model value used by the Household editor functions. Model value shape: |
modules.household.HouseholdBudgetOutputs | HouseholdBudgetOutputs describes a model value used by the Household editor functions. Model value shape: |
modules.household.HouseholdOptions | HouseholdOptions describes a model value used by the Household editor functions. Model value shape: |
Nordic Household module
Select this module in model settings to use its names in the portal model editor (modules["nordic-household"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["nordic-household"].nordicHousehold | Return an ordinary monthly household model with country-selected native assessments. The full supported composition is limited to first-day monthly periods in 2026; selected mortgage effective dates also apply. No Swedish fallback, FX or cross-border tax. Native local profiles, versions and classified bases are mandatory; country gaps fail. Salary/pension cash, entered withholding/premiums, housing, living costs and loan payments are balanced ledger flows. The native annual tax and pension assessments are informational snapshots and are never posted as new monthly tax or income. Published monthly money metrics: grossIncome, taxPayments, pensionPayments, disposableIncome, housingPayments, loanPayments, interestPayments, principalPayments, otherExpenses, leftToLiveOn (sum annually), cashBalance and loanBalance (last annually). Pension valuePeriods/valueKinds retain timing and native operation kind per value; a mixed-period record reports period:'mixed'. nationalContext and each person's assessment publish units, periods, versions, primary sources and partial coverage. Mortgage policy is descriptive; entered contractual payments are not replaced with inferred bank terms or benefit awards. openingCash defaults to zero. Other cash/expense inputs require explicit amounts; Optional loanRateAdjustment is a number, numeric input or numeric calculation. It adds the same nominal annual decimal-point change to each loan's annualRate in each monthly period, with a zero floor. Omission preserves row rates exactly. Declare hidden distributions in preconditions and use a static calculation with bind.sample(shock,{calendar:'annual'}) to supply native Monte Carlo samples. The adjustment changes interest and principal allocation, not contractual payments, policy stress rates, tax rates or the supported 2026 monthly timeline. Negative adjusted rates floor at zero; nonfinite values and unsupported sources fail. expenses.source names user-entered amounts or verified applicable local evidence. All amounts are local units. Negative/nonfinite payments, foreign Money, missing local rates, unsupported profiles and conflicting identities/versions fail.
|
| |
modules["nordic-household"].nordicHouseholdSupport | Inspect immutable support, versions, native required fields and partial coverage for five countries. Does not choose rules, calculate eligibility or create cashflows. Swedish tax rules are explicitly 2025; use a stated planning projection for the common 2026 scenario.
|
| |
modules["nordic-household"].NordicCountry | NordicCountry describes a model value used by the Nordic Household editor functions. Model value shape: |
modules["nordic-household"].NordicHouseholdCountrySupport | NordicHouseholdCountrySupport describes a model value used by the Nordic Household editor functions. Model value shape: |
modules["nordic-household"].NordicHouseholdOptions | NordicHouseholdOptions describes a model value used by the Nordic Household editor functions. Model value shape: |
modules["nordic-household"].NordicHouseholdPensionProfiles | NordicHouseholdPensionProfiles describes a model value used by the Nordic Household editor functions. Model value shape: |
modules["nordic-household"].NordicHouseholdTaxProfiles | NordicHouseholdTaxProfiles describes a model value used by the Nordic Household editor functions. Model value shape: |
modules["nordic-household"].NordicRuleVersions | NordicRuleVersions describes a model value used by the Nordic Household editor functions. Model value shape: |
Nordic Mortgage module
Select this module in model settings to use its names in the portal model editor (modules["nordic-mortgage"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["nordic-mortgage"].danishMortgagePolicy | danishMortgagePolicy provides danish mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].finnishMortgagePolicy | finnishMortgagePolicy provides finnish mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].icelandicMortgagePolicy | icelandicMortgagePolicy provides icelandic mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].nordicMortgagePolicy | nordicMortgagePolicy provides nordic mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].norwegianMortgagePolicy | norwegianMortgagePolicy provides norwegian mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].swedishNordicMortgagePolicy | swedishNordicMortgagePolicy provides swedish nordic mortgage policy in the Nordic Mortgage model editor. Use it when a model needs this operation.
|
| |
modules["nordic-mortgage"].MortgageSupportEntry | MortgageSupportEntry describes a model value used by the Nordic Mortgage editor functions. Model value shape: |
modules["nordic-mortgage"].MortgageSupportType | MortgageSupportType describes a model value used by the Nordic Mortgage editor functions. Model value shape: |
modules["nordic-mortgage"].NordicCountry | NordicCountry describes a model value used by the Nordic Mortgage editor functions. Model value shape: |
modules["nordic-mortgage"].NordicMortgagePolicy | NordicMortgagePolicy describes a model value used by the Nordic Mortgage editor functions. Model value shape: |
modules["nordic-mortgage"].NordicMortgagePolicyData | NordicMortgagePolicyData describes a model value used by the Nordic Mortgage editor functions. Model value shape: |
Sie Import module
Select this module in model settings to use its names in the portal model editor (modules["sie-import"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["sie-import"].parseLatestSieSnapshot | Parse the newest balance snapshot from classic SIE account and period balance records.
|
| |
modules["sie-import"].sieStatement | Create a monthly statement that applies the latest SIE balances at that month's end.
|
| |
modules["sie-import"].thisYear | Return the full-calendar-year dates for the current year plus an integer offset.
|
| |
modules["sie-import"].SieSnapshot | SieSnapshot describes a model value used by the Sie Import editor functions. Model value shape: |
modules["sie-import"].SieStatementOptions | SieStatementOptions describes a model value used by the Sie Import editor functions. Model value shape: |
Business Base Forecast module
Select this module in model settings to use its names in the portal model editor (modules["business-base-forecast"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["business-base-forecast"].annualGrowth | annualGrowth provides annual growth in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].businessBaseForecast | businessBaseForecast provides business base forecast in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].businessForecast | businessForecast provides business forecast in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].businessForecastTemplates | businessForecastTemplates is a model value for business forecast templates in the Business Base Forecast editor.
|
| |
modules["business-base-forecast"].forecastInvestment | forecastInvestment provides forecast investment in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].forecastOperatingCosts | forecastOperatingCosts provides forecast operating costs in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].forecastSales | forecastSales provides forecast sales in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas | formulas is a model value for formulas in the Business Base Forecast editor.
|
| |
modules["business-base-forecast"].formulas.financing.drawToMinimumCash | formulas.financing.drawToMinimumCash provides draw to minimum cash in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.financing.interestOnOpeningBalance | formulas.financing.interestOnOpeningBalance provides interest on opening balance in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.financing.repayAboveMinimumCash | formulas.financing.repayAboveMinimumCash provides repay above minimum cash in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.growth.annual | formulas.growth.annual provides annual in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.growth.historicalMonthlyAverage | formulas.growth.historicalMonthlyAverage provides historical monthly average in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.investment.capexFromRevenue | formulas.investment.capexFromRevenue provides capex from revenue in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.investment.remainingLifeFromHistoricalDepreciation | formulas.investment.remainingLifeFromHistoricalDepreciation provides remaining life from historical depreciation in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.sales.splitGrossInvoice | formulas.sales.splitGrossInvoice provides split gross invoice in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.tax.payAtYearEnd | formulas.tax.payAtYearEnd provides pay at year end in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.tax.positiveProfit | formulas.tax.positiveProfit provides positive profit in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.trend.exponentialSmoothing | formulas.trend.exponentialSmoothing provides exponential smoothing in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.trend.linearOrWeightedAverage | formulas.trend.linearOrWeightedAverage provides linear or weighted average in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.trend.linearRegression | formulas.trend.linearRegression provides linear regression in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.trend.seasonalSameMonthAverage | formulas.trend.seasonalSameMonthAverage provides seasonal same month average in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.trend.weightedMovingAverage | formulas.trend.weightedMovingAverage provides weighted moving average in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.workingCapital.balanceFromDays | formulas.workingCapital.balanceFromDays provides balance from days in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.workingCapital.collectReceivables | formulas.workingCapital.collectReceivables provides collect receivables in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.workingCapital.payPayables | formulas.workingCapital.payPayables provides pay payables in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].formulas.workingCapital.targetsFromDays | formulas.workingCapital.targetsFromDays provides targets from days in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].historicalMonthlyAverage | historicalMonthlyAverage provides historical monthly average in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].remainingLifeFromHistoricalDepreciation | remainingLifeFromHistoricalDepreciation provides remaining life from historical depreciation in the Business Base Forecast model editor. Use it when a model needs this operation.
|
| |
modules["business-base-forecast"].BusinessBaseForecastOptions | BusinessBaseForecastOptions describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].BusinessForecastFormulas | BusinessForecastFormulas describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].BusinessForecastOptions | BusinessForecastOptions describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].BusinessForecastTemplate | BusinessForecastTemplate describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastAccrualOptions | ForecastAccrualOptions describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastAmountMethod | ForecastAmountMethod describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastDomainContext | ForecastDomainContext describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastFormulaValue | ForecastFormulaValue describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastHistory | ForecastHistory describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastInvestmentOptions | ForecastInvestmentOptions describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].ForecastMethodContext | The engine context plus forecast facts; legacy aliases remain available. Model value shape: |
modules["business-base-forecast"].ForecastNumericFormulaValue | ForecastNumericFormulaValue describes a model value used by the Business Base Forecast editor functions. Model value shape: |
modules["business-base-forecast"].RemainingLifeMethod | RemainingLifeMethod describes a model value used by the Business Base Forecast editor functions. Model value shape: |
Financial Formulas module
Select this module in model settings to use its names in the portal model editor (modules["financial-formulas"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["financial-formulas"].accounting | accounting is a model value for accounting in the Financial Formulas editor.
|
| |
modules["financial-formulas"].accounting.openingCredit | accounting.openingCredit provides opening credit in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].accounting.openingDebit | accounting.openingDebit provides opening debit in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].amount | amount is a model value for amount in the Financial Formulas editor.
|
| |
modules["financial-formulas"].amount.atPeriods | amount.atPeriods provides at periods in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].amount.during | amount.during provides during in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].amount.shareOf | amount.shareOf provides share of in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].business | business is a model value for business in the Financial Formulas editor.
|
| |
modules["financial-formulas"].business.breakEvenUnits | business.breakEvenUnits provides break even units in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].business.cashRunway | business.cashRunway provides cash runway in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].business.operatingResult | business.operatingResult provides operating result in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].business.ratio | business.ratio provides ratio in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].financing | financing is a model value for financing in the Financial Formulas editor.
|
| |
modules["financial-formulas"].financing.annuityPayment | financing.annuityPayment provides annuity payment in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].financing.interestOnOpeningBalance | financing.interestOnOpeningBalance provides interest on opening balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].financing.principalFromBalance | financing.principalFromBalance provides principal from balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas | formulas is a model value for formulas in the Financial Formulas editor.
|
| |
modules["financial-formulas"].formulas.accounting.openingCredit | formulas.accounting.openingCredit provides opening credit in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.accounting.openingDebit | formulas.accounting.openingDebit provides opening debit in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.amount.atPeriods | formulas.amount.atPeriods provides at periods in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.amount.during | formulas.amount.during provides during in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.amount.shareOf | formulas.amount.shareOf provides share of in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.business.breakEvenUnits | formulas.business.breakEvenUnits provides break even units in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.business.cashRunway | formulas.business.cashRunway provides cash runway in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.business.operatingResult | formulas.business.operatingResult provides operating result in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.business.ratio | formulas.business.ratio provides ratio in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.dates.monthDistance | Counts signed calendar months from from to to, calculated as the difference between their year/month positions. Both required arguments must be strings containing a valid YYYY-MM or YYYY-MM-DD calendar date in years 0001-9999; leap days are checked. Days do not affect the count: January 31 to February 1 is 1, the reverse is -1, and any two dates in the same month give 0. Returns an integer number of months, with no rounding, elapsed-day conversion or model-period conversion. Invalid formats, calendar dates and argument types reject with DECCF_FORMULA_VALUE. Available as formulas.dates.monthDistance and monthDistance in Financial formulas.
|
| |
modules["financial-formulas"].formulas.dates.shiftMonth | Shifts a calendar month by a required integer offset and returns a YYYY-MM string. The required period accepts a valid YYYY-MM or YYYY-MM-DD date in years 0001-9999; full dates are validated including leap days, then their day is ignored. Positive offsets move forward, negative offsets move backward, and zero keeps the input month. The result always omits the day, including a January 31 shifted to February. Invalid dates/types, noninteger offsets and shifted years outside 0001-9999 reject with DECCF_FORMULA_VALUE. Existing YYYY-MM calls retain their result format and legacy support for year 0000 only when the shifted result is in 0001-9999. Full dates with year 0000 are invalid. Available as formulas.dates.shiftMonth and shiftMonth in Financial formulas.
|
| |
modules["financial-formulas"].formulas.financing.annuityPayment | formulas.financing.annuityPayment provides annuity payment in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.financing.interestOnOpeningBalance | formulas.financing.interestOnOpeningBalance provides interest on opening balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.financing.principalFromBalance | formulas.financing.principalFromBalance provides principal from balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.growth.annualStep | formulas.growth.annualStep provides annual step in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.growth.compound | formulas.growth.compound provides compound in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.growth.decay | formulas.growth.decay provides decay in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.metrics.cumulative | formulas.metrics.cumulative provides cumulative in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.metrics.discountedCashflows | formulas.metrics.discountedCashflows provides discounted cashflows in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.rates.period | formulas.rates.period provides period in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.savings.futureValue | formulas.savings.futureValue provides future value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.savings.requiredContribution | formulas.savings.requiredContribution provides required contribution in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.series.pulse | Amount in one selected zero-based period; zero in every other period.
|
| |
modules["financial-formulas"].formulas.series.rateScenario | Changes use zero-based period indexes; a distribution shock is drawn once per trial.
|
| |
modules["financial-formulas"].formulas.series.running | Declare a numeric running sum, minimum, maximum or product over every model period. The required source and optional initial accept numbers, Money, declared inputs, calculation references/projections, expressions and compatible callbacks. Operation defaults to "sum"; name defaults to "running". Source is read in each period. An explicit initial is read only in period zero and combined before that first source; omission returns the first source unchanged. Later periods combine the previous accumulator with the current source. Each run and repeated item starts afresh. Product sources are per-period factors (1.02 for a 2% increase); initial: 1 creates a dimensionless index, or an amount seeds an indexed amount. Zero and negative finite values are accepted. Money becomes its numeric amount; no rounding, currency conversion or rate annualization is applied. Phase defaults to "periodEnd" for end-of-period/flow dependencies and "period" otherwise; an explicit phase must support reading all dependencies. Sources carry their declared dependencies; opaque callbacks must declare their own dependencies. Returns a CalculationReference with a numeric result in each period. A missing source or unsupported operation rejects with DECCF_FORMULA_CONFIG. A nonfinite or nonnumeric source/initial, or product overflow, rejects with DECCF_FORMULA_VALUE; Money must use the model currency. No account or payment is created.
|
| |
modules["financial-formulas"].formulas.snapshots.atPeriod | formulas.snapshots.atPeriod provides at period in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.snapshots.record | Publish a named record of existing sources; explicit types retain Money and missing cells.
|
| |
modules["financial-formulas"].formulas.snapshots.select | Select a safe path in a calculated record; a missing key rejects unless fallback is explicit.
|
| |
modules["financial-formulas"].formulas.solve.bisect | Solve a continuous, bracketed formula in the current period; this does not rerun a model.
|
| |
modules["financial-formulas"].formulas.solve.variable | formulas.solve.variable provides variable in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.usage.cost | formulas.usage.cost provides cost in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.usage.fromEfficiency | formulas.usage.fromEfficiency provides from efficiency in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.usage.fromIntensity | formulas.usage.fromIntensity provides from intensity in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.valuation.presentValue | formulas.valuation.presentValue provides present value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.valuation.realValue | formulas.valuation.realValue provides real value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.withdrawals.byDivisor | formulas.withdrawals.byDivisor provides by divisor in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.workingCapital.cycleDays | formulas.workingCapital.cycleDays provides cycle days in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.workingCapital.fundingCost | formulas.workingCapital.fundingCost provides funding cost in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.workingCapital.netBalance | formulas.workingCapital.netBalance provides net balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.workingCapital.unpaidShare | formulas.workingCapital.unpaidShare provides unpaid share in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].formulas.workingCapital.vat.net | formulas.workingCapital.vat.net provides net in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].growth | growth is a model value for growth in the Financial Formulas editor.
|
| |
modules["financial-formulas"].growth.annualStep | growth.annualStep provides annual step in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].growth.compound | growth.compound provides compound in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].growth.decay | growth.decay provides decay in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].metrics | metrics is a model value for metrics in the Financial Formulas editor.
|
| |
modules["financial-formulas"].metrics.cumulative | metrics.cumulative provides cumulative in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].metrics.discountedCashflows | metrics.discountedCashflows provides discounted cashflows in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].monthDistance | Counts signed calendar months from from to to, calculated as the difference between their year/month positions. Both required arguments must be strings containing a valid YYYY-MM or YYYY-MM-DD calendar date in years 0001-9999; leap days are checked. Days do not affect the count: January 31 to February 1 is 1, the reverse is -1, and any two dates in the same month give 0. Returns an integer number of months, with no rounding, elapsed-day conversion or model-period conversion. Invalid formats, calendar dates and argument types reject with DECCF_FORMULA_VALUE. Available as formulas.dates.monthDistance and monthDistance in Financial formulas.
|
| |
modules["financial-formulas"].rates | rates is a model value for rates in the Financial Formulas editor.
|
| |
modules["financial-formulas"].rates.period | rates.period provides period in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].savings | savings is a model value for savings in the Financial Formulas editor.
|
| |
modules["financial-formulas"].savings.futureValue | savings.futureValue provides future value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].savings.requiredContribution | savings.requiredContribution provides required contribution in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].series | series is a model value for series in the Financial Formulas editor.
|
| |
modules["financial-formulas"].series.pulse | Amount in one selected zero-based period; zero in every other period.
|
| |
modules["financial-formulas"].series.rateScenario | Changes use zero-based period indexes; a distribution shock is drawn once per trial.
|
| |
modules["financial-formulas"].series.running | Declare a numeric running sum, minimum, maximum or product over every model period. The required source and optional initial accept numbers, Money, declared inputs, calculation references/projections, expressions and compatible callbacks. Operation defaults to "sum"; name defaults to "running". Source is read in each period. An explicit initial is read only in period zero and combined before that first source; omission returns the first source unchanged. Later periods combine the previous accumulator with the current source. Each run and repeated item starts afresh. Product sources are per-period factors (1.02 for a 2% increase); initial: 1 creates a dimensionless index, or an amount seeds an indexed amount. Zero and negative finite values are accepted. Money becomes its numeric amount; no rounding, currency conversion or rate annualization is applied. Phase defaults to "periodEnd" for end-of-period/flow dependencies and "period" otherwise; an explicit phase must support reading all dependencies. Sources carry their declared dependencies; opaque callbacks must declare their own dependencies. Returns a CalculationReference with a numeric result in each period. A missing source or unsupported operation rejects with DECCF_FORMULA_CONFIG. A nonfinite or nonnumeric source/initial, or product overflow, rejects with DECCF_FORMULA_VALUE; Money must use the model currency. No account or payment is created.
|
| |
modules["financial-formulas"].shiftMonth | Shifts a calendar month by a required integer offset and returns a YYYY-MM string. The required period accepts a valid YYYY-MM or YYYY-MM-DD date in years 0001-9999; full dates are validated including leap days, then their day is ignored. Positive offsets move forward, negative offsets move backward, and zero keeps the input month. The result always omits the day, including a January 31 shifted to February. Invalid dates/types, noninteger offsets and shifted years outside 0001-9999 reject with DECCF_FORMULA_VALUE. Existing YYYY-MM calls retain their result format and legacy support for year 0000 only when the shifted result is in 0001-9999. Full dates with year 0000 are invalid. Available as formulas.dates.shiftMonth and shiftMonth in Financial formulas.
|
| |
modules["financial-formulas"].snapshots | snapshots is a model value for snapshots in the Financial Formulas editor.
|
| |
modules["financial-formulas"].snapshots.atPeriod | snapshots.atPeriod provides at period in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].snapshots.record | Publish a named record of existing sources; explicit types retain Money and missing cells.
|
| |
modules["financial-formulas"].snapshots.select | Select a safe path in a calculated record; a missing key rejects unless fallback is explicit.
|
| |
modules["financial-formulas"].solve | solve is a model value for solve in the Financial Formulas editor.
|
| |
modules["financial-formulas"].solve.bisect | Solve a continuous, bracketed formula in the current period; this does not rerun a model.
|
| |
modules["financial-formulas"].solve.variable | solve.variable provides variable in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].usage | usage is a model value for usage in the Financial Formulas editor.
|
| |
modules["financial-formulas"].usage.cost | usage.cost provides cost in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].usage.fromEfficiency | usage.fromEfficiency provides from efficiency in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].usage.fromIntensity | usage.fromIntensity provides from intensity in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].valuation | valuation is a model value for valuation in the Financial Formulas editor.
|
| |
modules["financial-formulas"].valuation.presentValue | valuation.presentValue provides present value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].valuation.realValue | valuation.realValue provides real value in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].withdrawals | withdrawals is a model value for withdrawals in the Financial Formulas editor.
|
| |
modules["financial-formulas"].withdrawals.byDivisor | withdrawals.byDivisor provides by divisor in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].workingCapital | workingCapital is a model value for working capital in the Financial Formulas editor.
|
| |
modules["financial-formulas"].workingCapital.cycleDays | workingCapital.cycleDays provides cycle days in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].workingCapital.fundingCost | workingCapital.fundingCost provides funding cost in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].workingCapital.netBalance | workingCapital.netBalance provides net balance in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].workingCapital.unpaidShare | workingCapital.unpaidShare provides unpaid share in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].workingCapital.vat.net | workingCapital.vat.net provides net in the Financial Formulas model editor. Use it when a model needs this operation.
|
| |
modules["financial-formulas"].AmountSource | AmountSource describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].BisectionResult | BisectionResult describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].Formula | Formula describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].FormulaVariableReference | A scoped unknown understood by solve.bisect() and the formula factories. Model value shape: |
modules["financial-formulas"].NumberSource | NumberSource describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].RecordSelectionOptions | RecordSelectionOptions describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].RecordSnapshotOptions | RecordSnapshotOptions describes a model value used by the Financial Formulas editor functions. Model value shape: |
modules["financial-formulas"].RecordSnapshotSource | RecordSnapshotSource describes a model value used by the Financial Formulas editor functions. Model value shape: |
Loans module
Select this module in model settings to use its names in the portal model editor (modules.loans).
| Model editor name | Purpose and model value shape |
|---|---|
modules.loans.annuityPayment | annuityPayment provides annuity payment in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.assetFinance | assetFinance provides asset finance in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.bond | bond provides bond in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.convertibleLoan | convertibleLoan provides convertible loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.equityContribution | equityContribution provides equity contribution in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.factoring | factoring provides factoring in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financialLease | financialLease provides financial lease in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing | Group of reusable financing formulas available under the module.
|
| |
modules.loans.financing.assetFinance | financing.assetFinance provides asset finance in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.bond | financing.bond provides bond in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.convertibleLoan | financing.convertibleLoan provides convertible loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.equityContribution | financing.equityContribution provides equity contribution in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.factoring | financing.factoring provides factoring in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.financialLease | financing.financialLease provides financial lease in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.grant | financing.grant provides grant in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.installmentPurchase | financing.installmentPurchase provides installment purchase in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.invoicePurchase | financing.invoicePurchase provides invoice purchase in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.operatingLease | financing.operatingLease provides operating lease in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.revenueBased | financing.revenueBased provides revenue based in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.revolvingCredit | financing.revolvingCredit provides revolving credit in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.shareholderLoan | financing.shareholderLoan provides shareholder loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.financing.termLoan | financing.termLoan provides term loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas | formulas is a model value for formulas in the Loans editor.
|
| |
modules.loans.formulas.amount.atPeriods | formulas.amount.atPeriods provides at periods in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas.amount.during | formulas.amount.during provides during in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas.amount.shareOf | formulas.amount.shareOf provides share of in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas.financing.annuityPayment | formulas.financing.annuityPayment provides annuity payment in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas.financing.interestOnOpeningBalance | formulas.financing.interestOnOpeningBalance provides interest on opening balance in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.formulas.financing.principalFromBalance | formulas.financing.principalFromBalance provides principal from balance in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.grant | grant provides grant in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.installmentPurchase | installmentPurchase provides installment purchase in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.invoicePurchase | invoicePurchase provides invoice purchase in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.loanPeriod | loanPeriod provides loan period in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.loanPlan | loanPlan provides loan plan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.operatingLease | operatingLease provides operating lease in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments | repayments is a model value for repayments in the Loans editor.
|
| |
modules.loans.repayments.annuity | repayments.annuity provides annuity in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments.bullet | repayments.bullet provides bullet in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments.fixedPrincipal | repayments.fixedPrincipal provides fixed principal in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments.interestOnly | repayments.interestOnly provides interest only in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments.loanToValue | Select the highest crossed ratio threshold; repay a fixed share of principalBase, capped at current debt.
|
| |
modules.loans.repayments.select | repayments.select provides select in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.repayments.settlement | Pays amountDue at period end, including that period's interest; uses regular otherwise.
|
| |
modules.loans.revenueBased | revenueBased provides revenue based in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.revolvingCredit | revolvingCredit provides revolving credit in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.shareholderLoan | shareholderLoan provides shareholder loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.sym | Provides built-in numeric domains for common positive and percentage inputs.
|
| |
modules.loans.sym.amortMethods | sym.amortMethods provides amort methods in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.sym.keepSettleNewTemp | sym.keepSettleNewTemp provides keep settle new temp in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.termLoan | termLoan provides term loan in the Loans model editor. Use it when a model needs this operation.
|
| |
modules.loans.AssetFinanceOptions | AssetFinanceOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.AssetFinancePlan | AssetFinancePlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.BondOptions | BondOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.BondPlan | BondPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.ConvertibleLoanOptions | ConvertibleLoanOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.ConvertibleLoanPlan | ConvertibleLoanPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.EquityContributionOptions | EquityContributionOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.EquityContributionPlan | EquityContributionPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.EquityContributionPostings | EquityContributionPostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FactoringOptions | FactoringOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FactoringPlan | FactoringPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FactoringPostingAccounts | FactoringPostingAccounts describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FinancialLeaseOptions | FinancialLeaseOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FinancialLeasePlan | FinancialLeasePlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FinancialLeasePostings | FinancialLeasePostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FinancingPlan | FinancingPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.FinancingPostingAccounts | FinancingPostingAccounts describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.GrantOptions | GrantOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.GrantPlan | GrantPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.GrantPostings | GrantPostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InstallmentPurchaseOptions | InstallmentPurchaseOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InstallmentPurchasePlan | InstallmentPurchasePlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InstallmentPurchasePostings | InstallmentPurchasePostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InvoicePurchaseOptions | InvoicePurchaseOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InvoicePurchasePlan | InvoicePurchasePlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.InvoicePurchasePostingAccounts | InvoicePurchasePostingAccounts describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanAmountSource | LoanAmountSource describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanContext | LoanContext describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanFacts | LoanFacts describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanNumberSource | LoanNumberSource describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanOutputs | LoanOutputs describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanPeriodInput | LoanPeriodInput describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanPeriodOutputName | LoanPeriodOutputName describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanPeriodResult | LoanPeriodResult describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanPlan | LoanPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.LoanPlanPostingAccounts | LoanPlanPostingAccounts describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.OperatingLeaseOptions | OperatingLeaseOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.OperatingLeasePlan | OperatingLeasePlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.OperatingLeasePostings | OperatingLeasePostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.RevenueBasedOptions | RevenueBasedOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.RevenueBasedPlan | RevenueBasedPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.RevenueBasedPostings | RevenueBasedPostings describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.RevolvingCreditOptions | RevolvingCreditOptions describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.RevolvingCreditPlan | RevolvingCreditPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.ShareholderLoanPlan | ShareholderLoanPlan describes a model value used by the Loans editor functions. Model value shape: |
modules.loans.TermLoanOptions | TermLoanOptions describes a model value used by the Loans editor functions. Model value shape: |
Savings module
Select this module in model settings to use its names in the portal model editor (modules.savings).
| Model editor name | Purpose and model value shape |
|---|---|
modules.savings.prepareRetirementProjection | Creates a reusable synchronous retirement calculator. The optional configuration accepts only execution:"legacy"|"timeline", defaulting to "legacy" as retirementProjection does. Call the returned calculator with complete retirement assumptions, excluding execution. A defined per-call execution value is rejected; create another calculator to select another mode. Unknown factory options and unsupported execution values fail immediately. Every invocation validates and snapshots fresh amounts, ages, annualRates and nested settings using retirementProjection's defaults, units and constraints. It returns the same RetirementProjectionResult shape. Later changes to an earlier input or result do not change another call's assumptions or report. Timeline preparation is reused lazily within this calculator; calculated results, balances, histories and resolved stochastic values are never cached between calls. There is no shared global result cache. Custom sampling callbacks still require dynamic:true and run independently for each invocation. See the Savings guide for an example calling this factory and its returned calculator twice.
|
| |
modules.savings.retirementPlan | Construct a retirement portfolio on the model's annual timeline with balanced personal account-plan postings. Annual model period zero represents currentAge; cover currentAge through horizonAge inclusively. options is a scalar RetirementProjectionOptions object snapshotted at construction (including nested settings and budget ages), or a callback evaluated once per execution/trial with OnceContext. That context reads declared inputs and bindings and supports draw/sample; it has no time or ledger reads. Use dynamic:true when configuration must be reevaluated per period through CalculationContext. Caller-owned objects and arrays are not frozen. Default static configuration is data-only; supply annualRates for sampled paths. Custom sample callbacks require top-level dynamic:true, even if options.dynamic is true; the top-level setting alone authorizes those callbacks. The callback reads caller-declared inputs; preconditions defaults to {} and dependsOn defaults to []. An omitted owner creates a party; a supplied owner must be declared by the caller. asset is an owned portfolio entity. reportSchedule optionally restricts report evaluation. The authoritative portfolio is accounts.portfolio (assets.investments.brokerage). cash uses assets.cash.bank, netWorth uses equity.retained_earnings, pensionIncome uses income.pension.net, and investmentIncome uses income.capital.other. workingIncome uses income.employment.net_salary and otherIncome uses income.other.net for amounts already entered after tax; expenses uses expense.other (the personal expenses.other category). The owned asset groups contribution, withdrawal, growth and loss flows; personal cash rollups include those descendant flows. Contributions and withdrawals transfer between cash and portfolio; growth/loss are noncash postings. Working-budget shortfalls may leave cash negative but never silently reduce scheduled portfolio saving. Unsaved retirement surpluses remain in cash. This helper does not compute income tax. calculations.year contains current-period assumptions and proposed movements; history is flat state: openingPortfolio, closingPortfolio, legacy, depletionAge, yearsFunded and portfolioLasts. closingPortfolio includes other flows posting to that account. No rows/lifetimeRows maps are stored here; complete rows are assembled once by projection. Use bind.history(plan.calculations.history) for prior snapshots. projection is null before horizonAge and returns RetirementProjectionResult in that final period. Its comparisons and threshold searches use native timeline runs of the entered assumptions. The history and projection calculations run at periodEnd. Regular calculations read opening balances; these periodEnd calculations read settled balances. Uses retirementProjection validation and defaults, and rejects nonannual calendars or execution beyond horizonAge. Callback dependency lists must name same-period calculation reads. Numeric monetary assumptions share model currency. See the Savings guide for a complete callable retirementPlan example.
|
| |
modules.savings.retirementProjection | Projects retirement savings, annual budgets, funding longevity and deterministic what-if choices from scalar assumptions. All 13 age, amount and rate assumptions are required. Amounts are numbers in one currency, not typed money values. Ages must be integers from 0 through horizonAge (default 150) and currentAge <= retirementAge <= lifeExpectancy. Pension start can exceed a shortened horizon, up to max(150,horizonAge). Money must be finite and nonnegative. Rates are annual decimals within rateBounds (default strictly greater than -1 through 10); sampled rates use the same bounds. Invalid assumptions, callback results and nonfinite calculated amounts throw a model error. By default accumulation runs twelve monthly periods per working year, using preRetirementReturn / 12 and annualSavings / 12, with contributions at month end. The optional settings below override those conventions. Retirement rows include retirementAge through lifeExpectancy: portfolio is the opening balance; first-year expenses are annualExpenses, increasing with inflation from year two. Other income stays at monthlyOtherIncome * 12. Pension is monthlyPension * 12 at pensionStartAge and increases by pensionAnnualIncrease for each later age. A pension already started before retirement includes those increases. The positive expense-income gap is withdrawn at year start, capped to available funds, and the remainder earns postRetirementReturn. Income surpluses are not deposited. Any uncovered year remains a plan failure even if later income covers expenses. Legacy is the closing portfolio after the lifeExpectancy year. annualRates supplies absolute bounded annual rates in optional accumulationReturn, retirementReturn, inflation, incomeIncrease and pensionIncrease maps keyed age0 through age150. Missing channels/ages use the declared mean; unknown channels, malformed age keys, null maps and invalid rates fail. The corresponding sample callback cannot coexist with a channel (sampleReturn conflicts with either return channel). Main projections use supplied paths; sampledEarliestRetirement also reuses them. Unsampled comparisons and threshold searches keep the means. Data is snapshotted, without retaining caller-owned mutable records. Custom sample callbacks require dynamic:true for both execution modes; omission/false uses data-only static configuration. Optional synchronous sampleReturn({age, phase, mean}) samples once per accumulation year (phase "accumulation") and once per retirement year (phase "retirement"); the accumulation draw is divided by 12 for all twelve months. Optional sampleInflation({age, mean}) samples from the second retirement year. Omitted callbacks use means. Optional sampleIncomeIncrease({age, mean}) supplies annual otherIncomeAnnualIncrease draws from the year after incomeIncreaseBaseAge (or retirementAge when omitted). One annual draw compounds the shared working and other-income path, independent of includeLifetimeRows. Working income remains constant if its base age is omitted. Optional samplePensionIncrease({age, mean}) supplies annual pensionAnnualIncrease draws from the year after pensionStartAge. Both callbacks sample only ages after currentAge; earlier accrued increases retain their means. Initial income and pension amounts are not shocked. The main projection calls each applicable callback once per future age through horizonAge; it must return a synchronous finite rate within rateBounds. Invalid callback types/rates fail. Omission or undefined preserves the existing fixed growth exactly. Callers can share an annual shock between these callbacks while adding each callback's own mean. By default these callbacks affect the main projection only; earliest retirement and what-if choices use means. sampledEarliestRetirement defaults to false. True also samples every candidate retirement age in the earliest retirement search, checking funding through lifeExpectancy. The search remains independent of includeWhatIf. Reuse stored annual shocks for each age and add each callback's own mean: search candidates may call callbacks repeatedly at the same age and in different return phases. Fresh random draws on each call do not describe one consistent annual path. With no callbacks the result stays unchanged. Non-boolean option values fail. What-if comparisons always retain the mean assumptions, including when this option is true. The funding calculation continues through horizonAge (default 150), including sampling, but rows stop at lifeExpectancy. Returns JSON-safe named records. rows uses age keys such as age65; budget selects the first two retirement ages, pension start, retirement years 12 and 22, and the final age, omitting out-of-plan ages and duplicates. includeLifetimeRows defaults to false, preserving the previous exact result shape. True adds lifetimeRows, one age-keyed annual row from currentAge through lifeExpectancy, inclusive, in age order. Non-booleans fail. Each has age, phase (accumulation before retirementAge, retirement afterwards), opening portfolio, closingPortfolio, annual income, expenses and gap. Accumulation rows come from the same compounding pass and annual return draws, without extra callback calls; each closing balance equals the next opening balance. At retirementAge the values match rows. Existing rows, budget and summary retain their retirement-only meaning. includeSavingsInWorkingExpenses defaults to false. True treats annualWorkingExpenses as living expenses excluding savings: after their optional inflation, add fixed nominal annualSavings in every working year. Its working gap is max(0, expenses - income) when both amounts are known; missing observations remain null. This affects lifetime budget reporting only. The annualSavings deposit is still made once and retirement expenses keep their existing meaning. Non-boolean values are rejected. Optional annualWorkingIncome and annualWorkingExpenses are finite nonnegative scalar amounts in the same currency. Omission or undefined gives null for that working-year field; supplied values remain constant in every accumulation row unless the corresponding optional expenseInflationBaseAge or incomeIncreaseBaseAge is supplied. Working gap is 0 when both amounts are supplied and null otherwise: working years do not withdraw from the portfolio. These chart/context amounts do not derive, replace or constrain the independently entered annualSavings, even if working expenses exceed income. Null or invalid supplied amounts are rejected even with includeWhatIf:false. Retirement income, expenses and gap match existing rows. summary.portfolioLasts means every planned year is funded. yearsFunded counts consecutive funded years through horizonAge; depletionAge is the first uncovered age, fundedUntilAge is its preceding age, and both are null if funded through that horizon. longevityBuffer is yearsFunded minus retirementYears. earliestRetirementAge is the first whole age from currentAge through lifeExpectancy funding the plan, or null. Withdrawal rates are gap/opening funds: null when a positive gap has zero funds, otherwise a decimal. maximumWithdrawalRate is the planned maximum and bridgeWithdrawalRate is the arithmetic average before pension starts (0 with no bridge); either is null when one of its included rates is null. includeWhatIf defaults to true; false returns whatIf: null. Comparisons test one extra working year, retirement now, no further saving, 6000 extra annual saving, 500 extra monthly other income, expenses 10% lower/higher, pension removed/halved, and a 20% portfolio loss at retirement by default. Depletion ages are first uncovered years through horizonAge; null means horizonAge+. delayYearsGain and extraSavingsYearsGain divide the additional retirement starting portfolio by the baseline first-year expense-income gap: these are spending-equivalent years, not additional funded years, and are null when that gap is zero. delayYearsGain is also null when retirement cannot be delayed within the plan. Bisection finds the maximum annual inflation and minimum post-retirement return funding every planned year within the supported rate bounds. inflationBuffer is that maximum inflation minus inflation (a rate difference, possibly negative), or null when no supported inflation funds the plan. minimumReturn is null when no supported return funds the plan. Milestones ten/twentyFive/thirty/thirtyThree multiply annualExpenses by 10/25/30/33; coverage is retirement startingPortfolio / target, or null for a zero target. They do not subtract pension or other income. Every fixed comparison/timing/selection assumption has optional overrides. horizonAge (integer 0..150, default 150) must be at least lifeExpectancy. accumulationPeriodsPerYear (integer 1..366, default 12) divides annualSavings and the nominal preRetirementReturn into equal periods. contributionPlacement defaults to end. withdrawalPlacement defaults to start; end applies the annual return before withdrawal. reinvestIncomeSurplus defaults to false; true deposits positive income minus expenses at the same placement as withdrawals. otherIncomeAnnualIncrease (default 0) grows other income from year two and obeys rateBounds. expenseInflationStartYear (integer 1..1001, default 2) chooses the first year receiving inflation or a sample. Optional expenseInflationBaseAge (integer 0..currentAge) instead treats annualExpenses and annualWorkingExpenses as amounts in money at that age. The first age keeps that amount; each elapsed year multiplies expenses by 1 + inflation (or its sample). For base age 40 and retirement 65, retirement costs include 25 annual increases. This overrides expenseInflationStartYear. Inflation sampling then covers base age + 1 through horizonAge, exactly once per age; working rows and retirement expenses share those factors. Retirement milestone targets use the first retirement year's inflated expenses. Omission preserves all previous expense timing and targets. Optional incomeIncreaseBaseAge (integer 0..currentAge) anchors annualWorkingIncome and monthlyOtherIncome to that age and compounds otherIncomeAnnualIncrease for each elapsed year, before and after retirement. Pension retains its independent pensionAnnualIncrease; annualSavings always stays a fixed nominal amount. Omission retains constant working income and retirement-based other income. Invalid, null, fractional or future base ages fail. With either base supplied, a retirementAge below currentAge starts retirement at currentAge; no historical withdrawals or contributions are reconstructed. lifeExpectancy must still be at least currentAge. Placement values must be start/end. Twelve calendar months still convert monthly income/savings to annual amounts. budgetAges optionally supplies up to 1001 integer ages 0..1000. First-occurrence order is retained; duplicates and ages outside retirementAge..lifeExpectancy are omitted. [] selects none. Omission retains the original six derived ages above. milestoneMultiples partially replaces the four named finite nonnegative multiples; keys and coverage rules remain compatible, including null coverage for zero targets. whatIf partially overrides delayYears (integer 0..1000, default 1), annualSavingsAfterStopping (0), extraMonthlySavings (500), extraMonthlyIncome (500), lowerExpenseReduction (0.1), higherExpenseIncrease (0.1), pensionRemoval (1), pensionReduction (0.5), marketCrashLoss (0.2). Amounts and expense increases must be finite and nonnegative; reduction/removal/loss fractions must lie in 0..1. Extra monthly savings are multiplied by 12. Existing result names remain: noPensionDepletionAge uses pensionRemoval; halfPensionDepletionAge uses pensionReduction even for configured fractions other than 1/0.5. Delay beyond lifeExpectancy returns null; zero delay gives zero gained years when the first-year gap is positive. rateBounds.minimum defaults to -1 + Number.EPSILON, must be finite and strictly above -1; maximum defaults to 10 and must exceed minimum. thresholdSearch.minimumRate/maximumRate default to those bounds, must be increasing and inside them. iterations is an integer 1..100, default 55. Bisection's unresolved interval is at most initial width / 2**iterations. A feasible lower return boundary or upper inflation boundary returns that boundary; infeasible searches return null. Optional groups accept partial and undefined members. Null groups, unknown group members and invalid settings fail even with includeWhatIf:false. The 150-horizon, 366-period, 1001-entry and 100-iteration ceilings are execution safety limits.
|
| |
modules.savings.savingsPeriod | savingsPeriod provides savings period in the Savings model editor. Use it when a model needs this operation.
|
| |
modules.savings.savingsPlan | savingsPlan provides savings plan in the Savings model editor. Use it when a model needs this operation.
|
| |
modules.savings.withdrawals | withdrawals is a model value for withdrawals in the Savings editor.
|
| |
modules.savings.withdrawals.byDivisor | withdrawals.byDivisor provides by divisor in the Savings model editor. Use it when a model needs this operation.
|
| |
modules.savings.PreparedRetirementProjection | Synchronous retirement calculator. Each invocation validates fresh assumptions and returns a fresh complete report. Model value shape: |
modules.savings.PreparedRetirementProjectionOptions | Retirement assumptions for a prepared calculator; its execution mode is fixed by the factory. Model value shape: |
modules.savings.RetirementAnnualRates | Absolute annual decimal rates keyed by canonical ages such as age65, from age0 through age150. Missing entries use the corresponding mean. Model value shape: |
modules.savings.RetirementPlan | RetirementPlan describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.RetirementPlanHistory | Flat settled-period state and cumulative funding facts. Full historical rows are assembled by calculations.projection at the horizon. Model value shape: |
modules.savings.RetirementPlanOptions | Shared declaration settings for a native retirement component. Model value shape: |
modules.savings.RetirementProjectionLifetimeRow | Annual lifetime context from currentAge through lifeExpectancy, including working and retired years. Model value shape: |
modules.savings.RetirementProjectionOptions | Scalar retirement assumptions in one consistent currency, with decimal annual rates. Model value shape: |
modules.savings.RetirementProjectionRateBounds | Annual rate validation bounds, including sampling and other income growth. Model value shape: |
modules.savings.RetirementProjectionResult | RetirementProjectionResult describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.RetirementProjectionRow | A retirement year: opening portfolio, beginning-of-year withdrawals, then annual investment growth. Model value shape: |
modules.savings.RetirementProjectionThresholdSearch | Deterministic threshold bounds and bisection precision. Model value shape: |
modules.savings.RetirementProjectionWhatIf | Deterministic comparisons; null depletion ages mean no shortfall through horizonAge (default 150). Model value shape: |
modules.savings.RetirementProjectionWhatIfOptions | Optional comparison amounts, durations and decimal fractions; partial members retain their defaults. Model value shape: |
modules.savings.SavingsContext | SavingsContext describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.SavingsFacts | SavingsFacts describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.SavingsPeriodResult | SavingsPeriodResult describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.SavingsPlan | SavingsPlan describes a model value used by the Savings editor functions. Model value shape: |
modules.savings.SavingsSource | SavingsSource describes a model value used by the Savings editor functions. Model value shape: |
Pension module
Select this module in model settings to use its names in the portal model editor (modules.pension).
| Model editor name | Purpose and model value shape |
|---|---|
modules.pension.annuityFactor | annuityFactor provides annuity factor in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.applyCapitalEvents | applyCapitalEvents provides apply capital events in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.assessmentDelta | assessmentDelta provides assessment delta in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.assessmentWindow | assessmentWindow provides assessment window in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.careerAverageBenefit | careerAverageBenefit provides career average benefit in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.contributionPeriod | contributionPeriod provides contribution period in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.createPensionAssumptions | createPensionAssumptions creates or declares create pension assumptions in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.definedBenefitAmount | definedBenefitAmount creates or declares defined benefit amount in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.definedBenefitPension | definedBenefitPension creates or declares defined benefit pension in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.definedContributionPension | definedContributionPension creates or declares defined contribution pension in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.definePensionAgreementProfile | definePensionAgreementProfile creates or declares define pension agreement profile in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.evaluatePensionAgreementProfile | evaluatePensionAgreementProfile provides evaluate pension agreement profile in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.fixedTermPayment | fixedTermPayment provides fixed term payment in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.flatPerServiceYear | flatPerServiceYear provides flat per service year in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.fundedPension | Creates a monthly pension-capital component with balanced debit/credit flows. Supply owner, currency, annualReturn and payout.from, payout.months and payout.annualReturn. Amounts use the declared currency; annual return rates are decimals, for example 0.04 for 4%. Values may be declared input or calculation sources. label defaults to "Pensionskapital"; openingCapital and the monthly contribution default to 0. valuedAt is optional: future statement capital enters in its valuation month; older capital must already be valued at model start. payout.from is YYYY-MM or YYYY-MM-01 and months is a positive integer. The model must use monthly periods and the declared currency; opening capital must be nonnegative and annual returns must exceed -1. Growth uses the effective monthly rate on opening capital; contributions enter at month end. From payout start, the explicit payout return applies and the fixed-term payment uses the remaining months, capped to available capital. Register the returned component in model components. accounts exposes capital, equity, revaluation and benefits; flows exposes funding, investmentReturn and withdrawal. outputs exposes payment, capital, contribution, growth and the period record. These flows create no bank payment: connect outputs.payment separately to the person's pension-income flow. No tax or lifetime-insurance assumptions are inferred. Each repeated pension receives separate accounts.
|
| |
modules.pension.indexBenefit | indexBenefit provides index benefit in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.monthlySurvival | monthlySurvival provides monthly survival in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.PENSION_AGREEMENT_PROFILE_STATUSES | PENSION_AGREEMENT_PROFILE_STATUSES is a model value for pension agreement profile statuses in the Pension editor.
|
| |
modules.pension.qualifiedServiceMonths | qualifiedServiceMonths provides qualified service months in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.resolvePensionAgreementProfile | resolvePensionAgreementProfile resolves resolve pension agreement profile in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.serviceFraction | serviceFraction provides service fraction in the Pension model editor. Use it when a model needs this operation.
|
| |
modules.pension.AssessmentUnit | AssessmentUnit describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.BenefitBand | BenefitBand describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.BenefitOutput | BenefitOutput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.BenefitPolicy | BenefitPolicy describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CapitalOutput | CapitalOutput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CapitalPensionOptions | CapitalPensionOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CareerAverageBenefitOptions | CareerAverageBenefitOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CareerAverageBenefitPolicy | CareerAverageBenefitPolicy describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CareerAverageCredit | CareerAverageCredit describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.CommonPensionOptions | CommonPensionOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionBand | ContributionBand describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionOnlyOptions | ContributionOnlyOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionOutput | ContributionOutput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionPeriodInput | ContributionPeriodInput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionPeriodResult | ContributionPeriodResult describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ContributionPolicy | ContributionPolicy describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DbFinalSalaryOperation | DbFinalSalaryOperation describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DcBandedContributionOperation | DcBandedContributionOperation describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DefinedBenefitInput | DefinedBenefitInput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DefinedBenefitOptions | DefinedBenefitOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DefinedContributionOptions | DefinedContributionOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.DefinePensionAgreementProfileOptions | DefinePensionAgreementProfileOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.FundedPensionOptions | FundedPensionOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementBand | PensionAgreementBand describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementBoundary | PensionAgreementBoundary describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementEligibility | PensionAgreementEligibility describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementEvaluationInputs | PensionAgreementEvaluationInputs describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementOperation | PensionAgreementOperation describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementProfile | PensionAgreementProfile describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementProfileStatus | PensionAgreementProfileStatus describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementRate | PensionAgreementRate describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAgreementSource | PensionAgreementSource describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAmountSource | PensionAmountSource describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAssumption | PensionAssumption describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionAssumptionRegistry | PensionAssumptionRegistry describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionContext | Deliberately excludes current fields/flows and arbitrary model reads. Model value shape: |
modules.pension.PensionDateSource | PensionDateSource describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionFormula | PensionFormula describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionMetadata | PensionMetadata describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionPlan | PensionPlan describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PensionSource | Numeric amounts use the plan currency. Money inputs are not supported in this first slice. Model value shape: |
modules.pension.PensionWindow | PensionWindow describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.PolicyIdentity | PolicyIdentity describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ProjectedBenefitOutput | ProjectedBenefitOutput describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ProjectedRetirementBenefitOptions | ProjectedRetirementBenefitOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.ReturnOptions | ReturnOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.SuppliedAccruedBenefitOptions | SuppliedAccruedBenefitOptions describes a model value used by the Pension editor functions. Model value shape: |
modules.pension.SuppliedAccruedBenefitOutput | SuppliedAccruedBenefitOutput describes a model value used by the Pension editor functions. Model value shape: |
Swedish Pension module
Select this module in model settings to use its names in the portal model editor (modules["swedish-pension"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-pension"].comparePayoutScenarios | comparePayoutScenarios compares compare payout scenarios in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].createPensionCase | createPensionCase creates or declares create pension case in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].evaluateSwedishPensionAgreement | evaluateSwedishPensionAgreement provides evaluate swedish pension agreement in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].isSwedishPensionCase | isSwedishPensionCase provides is swedish pension case in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].listSwedishPensionAgreements | listSwedishPensionAgreements lists list swedish pension agreements in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].pensionAgreementInput | pensionAgreementInput provides pension agreement input in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].resolveSwedishPensionAgreement | resolveSwedishPensionAgreement resolves resolve swedish pension agreement in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].swedishPensionAgreementCatalog | swedishPensionAgreementCatalog provides swedish pension agreement catalog in the Swedish Pension model editor. Use it when a model needs this operation.
|
| |
modules["swedish-pension"].swedishPensionForecast | Composes a one-person Swedish pension forecast from explicit statements and dated agreement rules. Supply all option groups; there are no implicit salary, statement, agreement or return defaults. startYear and person.birthYear are integer inputs; person.members must contain exactly one person with an explicit dateOfBirth matching birthYear. Money amounts use SEK, annual return and growth assumptions are decimal rates, and payout ages/durations use years. work supplies monthlySalary, employment startDate, lastYear, agreement, agreementChangeYear, agreementAfterChange, fallbackAnnualContribution and incomeBaseAmount. A positive change year switches agreements from that year. pensions supplies public/premium annual-benefit statements, occupational DC capital or DB annual-benefit rows, and the future-premium payout window. Each statement needs its value date and source. assumptions supplies inflation, generalSalaryGrowth, individualSalaryGrowth, stockGrowth and payoutRate. Optional rates supplies numeric calculation references under any of those five names. Missing entries use the corresponding assumption input. The required assumptions remain editable means, also used to value periods before forecast start. Reading a distribution assumption with get does not draw a sample. Bind a declared hidden distribution with bind.sample(...,{calendar:"annual"}) in each source calculation to opt into annual Monte Carlo uncertainty. Rates are annual decimals and must be finite and greater than -1. Register source calculations in the model. Callback, projection and unknown rate entries are unsupported. Salary and benefit inflation accumulate each January after their base year, preserving earlier years' factors and the initial observation. DC growth uses each current annual rate converted to an effective monthly rate; payoutRate applies from payout start and recalculates the remaining payment. DB inflation adjustments stop at their payout-start year. The returned monthly timeline starts in January of startYear and continues through the 85th-birthday year, with a minimum of twelve months. Register component and use timeline in the model. DC rights and future premiums use fundedPension accounts/flows; DB rights retain their stated annual benefits. Missing agreement rules or required rule inputs use the explicit annual fallback contribution, divided into monthly premiums, with a visible status. incomes exposes salary, publicPension and occupationalPension for householdPeople to book bank income and calculate tax. Pension-capital flows do not duplicate those bank payments. reports and outputs expose gross pension parts, premium status and annualPensionSnapshot; household net income is separate. Payouts start in the person's birth month at the specified age. No historic rights, lifetime insurance factors or future tax legislation are invented; household tax continues to use its explicitly supported tax-rule version.
|
| |
modules["swedish-pension"].swedishPensionProfiles | swedishPensionProfiles is a model value for swedish pension profiles in the Swedish Pension editor.
|
| |
modules["swedish-pension"].PensionPayoutScenario | PensionPayoutScenario describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].PensionRightPayout | PensionRightPayout describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].PensionScenarioResult | PensionScenarioResult describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].PensionScenarioRightResult | PensionScenarioRightResult describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionAgreementCatalogEntry | SwedishPensionAgreementCatalogEntry describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionCase | SwedishPensionCase describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionCurrentEmployment | SwedishPensionCurrentEmployment describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionDbRight | SwedishPensionDbRight describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionDcRight | SwedishPensionDcRight describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionForecastOptions | SwedishPensionForecastOptions describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionRight | SwedishPensionRight describes a model value used by the Swedish Pension editor functions. Model value shape: |
modules["swedish-pension"].SwedishPensionStatement | SwedishPensionStatement describes a model value used by the Swedish Pension editor functions. Model value shape: |
Housing module
Select this module in model settings to use its names in the portal model editor (modules.housing).
| Model editor name | Purpose and model value shape |
|---|---|
modules.housing.propertyPlan | propertyPlan({owner,cashAccount,...options}) returns {component,outputs,accounts,reportGroups,operatingCosts}; register component once. One property's monthly asset/cost/transactions, in model currency. openingValue/monthlyCost/annualGrowth default 0; growth compounds monthly. amortizationValue is separate regulatory value. operatingCosts replaces monthlyCost with named amount/code lines. purchase/sale require zero-based atPeriod and price; costs default 0, enabled true. Purchase is period start, sale period end; capitalizeCosts defaults false. Opening assets cannot also be purchased; sale cannot precede purchase. ownership/paymentShares use owners (keyed entities/repeated output) and weights by stable ID: keyed numeric sources, repeated columns or repeated numeric calculation outputs. Register source repeats. Legal weights sum to one; payment weights are nonnegative/proportional with positive total. Omitted owner weights are zero; unknown/negative/nonnumeric weights reject. Omitted allocations use owner. label names reports; accounts supplies compatible owner/type mappings, distinct per home. Outputs include numeric marketValue/carryingValue/regulatoryValue/active/costs/book gain, payment flows and Money breakdown. Invalid timing/currency/amounts/allocations reject. Loans/tax/eligibility stay separate; see Property plans for accounts/reports.
|
| |
modules.housing.sym | Provides built-in numeric domains for common positive and percentage inputs.
|
| |
modules.housing.sym.keepSellBuy | sym.keepSellBuy provides keep sell buy in the Housing model editor. Use it when a model needs this operation.
|
| |
modules.housing.PropertyAccounts | PropertyAccounts describes a model value used by the Housing editor functions. Model value shape: |
modules.housing.PropertyOutputs | PropertyOutputs describes a model value used by the Housing editor functions. Model value shape: |
modules.housing.PropertyPlan | PropertyPlan describes a model value used by the Housing editor functions. Model value shape: |
modules.housing.PropertyPlanOptions | PropertyPlanOptions describes a model value used by the Housing editor functions. Model value shape: |
modules.housing.PropertyPurchase | PropertyPurchase describes a model value used by the Housing editor functions. Model value shape: |
modules.housing.PropertyShares | propertyPlan ownership/paymentShares allocation: owners is a keyed entity map or repeated entity output; weights is a keyed numeric-source map, repeated column or numeric calculation output map. Stable IDs join owners and weights; omitted owners have zero. Legal weights sum to one; payment weights are nonnegative with positive total. Invalid/unknown weights reject. Register source repeats. See propertyPlan for defaults and its complete callable example. Model value shape: |
modules.housing.PropertyTransaction | PropertyTransaction describes a model value used by the Housing editor functions. Model value shape: |
Swedish Family Benefits module
Select this module in model settings to use its names in the portal model editor (modules["swedish-family-benefits"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-family-benefits"].calculateChildBenefit2026 | calculateChildBenefit2026 calculates calculate child benefit2026 in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].calculateMultiChildSupplement2026 | calculateMultiChildSupplement2026 calculates calculate multi child supplement2026 in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].calculateStudyBenefit2026 | calculateStudyBenefit2026 calculates calculate study benefit2026 in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].calculateSwedishFamilyBenefits2026 | calculateSwedishFamilyBenefits2026 calculates calculate swedish family benefits2026 in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].SWEDISH_FAMILY_BENEFITS_RULE_YEAR | SWEDISH_FAMILY_BENEFITS_RULE_YEAR is a model value for swedish family benefits rule year in the Swedish Family Benefits editor.
|
| |
modules["swedish-family-benefits"].swedishFamilyBenefit2026 | Source formulas return krona numbers; calculations must declare the formula's dependsOn metadata.
|
| |
modules["swedish-family-benefits"].swedishFamilyBenefit2026.child | swedishFamilyBenefit2026.child provides child in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].swedishFamilyBenefit2026.study | swedishFamilyBenefit2026.study provides study in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].swedishFamilyBenefit2026.supplement | swedishFamilyBenefit2026.supplement provides supplement in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].swedishFamilyBenefits | swedishFamilyBenefits({owner,children,recipients,profile?,fields?}) returns {component,outputs}; register component. Household call: `modules["swedish-family-benefits"].swedishFamilyBenefits({owner, recipients, children, profile: 'household'})`. Monthly SEK only. owner is an entity; recipients a keyed entity map/repeated person output, each entity once. children accepts fixed records or typed object-array/projection. Monthly Money outputs: child, study, supplement, total. breakdown includes ruleYear, period/month, recipients/groups, household/external/entitlement. Recipients receive bank income.tax_free postings; external portions create none. Omitting profile preserves explicit shares: id, benefitKind (child/study/none), eligibleForSupplement, familyGroupId, recipientShares:[{id,share}]; externalShare defaults 0. Shares sum to one. Optional inclusive fromPeriod/throughPeriod default to continuing; benefitSchedule sets timing. fields maps canonical to source names (defaults canonical). profile:'household' requires id,parent,benefitKind,householdShare. parent is a recipient ID or 'shared'; householdShare is required full/half. Full pays the whole entitlement here; half pays 50% outside. The household portion goes to parent or equally to shared recipients. Exactly one or two recipients, even without children; 'shared' is reserved. One implicit supplement group: child/study eligible, none inactive; no age inference. Household fields maps only those four fields; explicit shares support separate groups/eligibility/schedules. Both profiles: 2026 rules, July/August study pause, October supplement catch-up, cent rounding. Empty children yield zero. Invalid/duplicate IDs, unknown parents/recipients (even for none), kinds/shares, profile/fields, calendar/currency reject, including changed sources. Existing explicit-share APIs, pure calculations and outputs retain their contracts.
|
| |
modules["swedish-family-benefits"].sym | Provides built-in numeric domains for common positive and percentage inputs.
|
| |
modules["swedish-family-benefits"].sym.benefitKinds | sym.benefitKinds provides benefit kinds in the Swedish Family Benefits model editor. Use it when a model needs this operation.
|
| |
modules["swedish-family-benefits"].FixedNumberSource | FixedNumberSource describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].StringSource | StringSource describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitAmounts | SwedishBenefitAmounts describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitChild | SwedishBenefitChild describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitChildrenSource | SwedishBenefitChildrenSource describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitChildSource | SwedishBenefitChildSource describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitFields | SwedishBenefitFields describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitKind | SwedishBenefitKind describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitRecipientShare | SwedishBenefitRecipientShare describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishBenefitScheduleEntry | SwedishBenefitScheduleEntry describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishFamilyBenefitsMappedOptions | SwedishFamilyBenefitsMappedOptions describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishFamilyBenefitsOptions | SwedishFamilyBenefitsOptions describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishFamilyBenefitsOutputs | SwedishFamilyBenefitsOutputs describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishFamilyBenefitsPlan | SwedishFamilyBenefitsPlan describes a model value used by the Swedish Family Benefits editor functions. Model value shape: |
modules["swedish-family-benefits"].SwedishFamilyBenefitsResult | Pure results use krona numbers; published calculation records use Money amounts. Model value shape: |
modules["swedish-family-benefits"].SwedishHouseholdBenefitChildSource | Household child: required string sources id, parent (recipient ID or shared), benefitKind (child/study/none), householdShare (full/half). See swedishFamilyBenefits for rules, validation and example. Model value shape: |
modules["swedish-family-benefits"].SwedishHouseholdBenefitFields | Optional canonical-to-source name map: id, parent, benefitKind, householdShare only; omitted mappings use canonical names. See swedishFamilyBenefits. Model value shape: |
modules["swedish-family-benefits"].SwedishHouseholdFamilyBenefitsMappedOptions | Household profile options with explicit fields mapping. See swedishFamilyBenefits for supported names, defaults, validation, outputs and example. Model value shape: |
modules["swedish-family-benefits"].SwedishHouseholdFamilyBenefitsOptions | swedishFamilyBenefits options with required profile:'household', owner, children, recipients; optional fields. See the function's complete contract and callable example. Model value shape: |
Swedish Credit module
Select this module in model settings to use its names in the portal model editor (modules["swedish-credit"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-credit"].calculateSwedishInterestAllocation2025 | calculateSwedishInterestAllocation2025 calculates calculate swedish interest allocation2025 in the Swedish Credit model editor. Use it when a model needs this operation.
|
| |
modules["swedish-credit"].calculateSwedishInterestPortfolio2025 | calculateSwedishInterestPortfolio2025 calculates calculate swedish interest portfolio2025 in the Swedish Credit model editor. Use it when a model needs this operation.
|
| |
modules["swedish-credit"].swedishDebtRatio | swedishDebtRatio provides swedish debt ratio in the Swedish Credit model editor. Use it when a model needs this operation.
|
| |
modules["swedish-credit"].swedishInterestAllocation2025 | swedishInterestAllocation2025 provides swedish interest allocation2025 in the Swedish Credit model editor. Use it when a model needs this operation.
|
| |
modules["swedish-credit"].swedishInterestPortfolio2025 | swedishInterestPortfolio2025 provides swedish interest portfolio2025 in the Swedish Credit model editor. Use it when a model needs this operation.
|
| |
modules["swedish-credit"].CreditMapSource | CreditMapSource describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishDebtRatioOptions | SwedishDebtRatioOptions describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestAllocation2025Options | SwedishInterestAllocation2025Options describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestAllocation2025Result | SwedishInterestAllocation2025Result describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestPool2025 | SwedishInterestPool2025 describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestPool2025Sources | SwedishInterestPool2025Sources describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestPortfolio2025Options | SwedishInterestPortfolio2025Options describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestPortfolio2025Result | SwedishInterestPortfolio2025Result describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishInterestProfiles2025 | SwedishInterestProfiles2025 describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishProjectedTaxProfile2025 | SwedishProjectedTaxProfile2025 describes a model value used by the Swedish Credit editor functions. Model value shape: |
modules["swedish-credit"].SwedishResolvedTaxProfile2025 | SwedishResolvedTaxProfile2025 describes a model value used by the Swedish Credit editor functions. Model value shape: |
Swedish Property Sale Tax module
Select this module in model settings to use its names in the portal model editor (modules["swedish-property-sale-tax"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-property-sale-tax"].calculateSwedishPropertySale | calculateSwedishPropertySale calculates calculate swedish property sale in the Swedish Property Sale Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-property-sale-tax"].swedishPropertySale | swedishPropertySale provides swedish property sale in the Swedish Property Sale Tax model editor. Use it when a model needs this operation.
|
| |
modules["swedish-property-sale-tax"].SwedishPropertyImprovement | SwedishPropertyImprovement describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertyImprovementSource | SwedishPropertyImprovementSource describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySale | SwedishPropertySale describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleBooleanSource | SwedishPropertySaleBooleanSource describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleBreakdown | SwedishPropertySaleBreakdown describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleCalculationBase | SwedishPropertySaleCalculationBase describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleCalculationInput | SwedishPropertySaleCalculationInput describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleCalculationResult | SwedishPropertySaleCalculationResult describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleOptionBase | SwedishPropertySaleOptionBase describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleOptions | SwedishPropertySaleOptions describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertySaleOutputs | SwedishPropertySaleOutputs describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishPropertyType | SwedishPropertyType describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishReplacementHome | SwedishReplacementHome describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
modules["swedish-property-sale-tax"].SwedishReplacementHomeSource | SwedishReplacementHomeSource describes a model value used by the Swedish Property Sale Tax editor functions. Model value shape: |
Swedish Investment Accounts module
Select this module in model settings to use its names in the portal model editor (modules["swedish-investment-accounts"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["swedish-investment-accounts"].swedishInvestmentAccounts | Declare Swedish ISK and VP ledgers and publish period facts without applying tax rules.
|
| |
modules["swedish-investment-accounts"].InvestmentAmountSource | InvestmentAmountSource describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentAccountDeclaration | SwedishInvestmentAccountDeclaration describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentAccountReferences | SwedishInvestmentAccountReferences describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentAccounts | SwedishInvestmentAccounts describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentAccountsOptions | SwedishInvestmentAccountsOptions describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentAccountType | SwedishInvestmentAccountType describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentEvent | SwedishInvestmentEvent describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentMonth | SwedishInvestmentMonth describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
modules["swedish-investment-accounts"].SwedishInvestmentPeriodFacts | SwedishInvestmentPeriodFacts describes a model value used by the Swedish Investment Accounts editor functions. Model value shape: |
Danish Pension module
Select this module in model settings to use its names in the portal model editor (modules["danish-pension"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["danish-pension"].assessDanishPension | Pure assessment of the same partial 2026 scheme as danishPension. Numeric sources must already be resolved; amounts use the native period and currency. The explicit scheme and nonempty basisSource are mandatory. No owner, id, engine reference, callback, bank payment or personal pension-capital balance is created. Invalid/negative bases, foreign Money, missing data and unsupported schemes fail.
|
| |
modules["danish-pension"].DANISH_PENSION_2026 | Immutable DK 2026 partial pension rules, parameter provenance and assessment validity.
|
| |
modules["danish-pension"].danishPension | Calculates the 2026 monthly ATP A-rate contribution for an already covered monthly paid Danish employee. coveredHours is the nonnegative payroll-hour basis after the employer has established coverage, including the age-16 requirement; it accepts a number or declared numeric source, not money. basisSource must name that payroll/enrolment record. Hours include qualifying paid leave according to ATP's rules; the factory does not infer hours from salary. Below 39 hours the contribution is zero; from 39, 78 and 117 hours the employee pays DKK 33/66/99 and employer DKK 66/132/198. Rates have applied since 2024 and were confirmed for this 2026 slice. Weekly, fortnightly, casual-worker, public-sector alternative-rate and self-employed cases are unsupported. Required options are id, owner, ruleYear:2026, the explicit scheme, basisSource and all numeric bases. There are no implicit amount or scheme defaults; pass zero explicitly when true. The owner is an entity or a keyed entity lookup, such as lookup(people.outputs.person, people.item.data.id) for repeated rows. Register the returned component in model components. outputs.assessment publishes the full record, and named numeric outputs are calculation projections usable in metrics and other declarations. rules exposes immutable national parameters, source links, validity and review dates. The model must use DKK and the monthly calendar with periods starting on the first day. Only the 2026 assessment year is supported. All amounts use DKK; rate calculations retain raw values before payment rounding. Unknown options/schemes, missing source classifications, negative or nonfinite bases, wrong currencies and uncovered dates/calendars fail explicitly. Callbacks capturing row projections cannot rebind. For repeated rows, use direct input references, expressions or bindable calculation references instead. Ordinary callbacks may use declared inputs that do not capture symbolic rows. No tax, bank transaction, capital balance or current pension payout is created.
|
| |
modules["danish-pension"].DanishPensionAssessment | DanishPensionAssessment describes a model value used by the Danish Pension editor functions. Model value shape: |
modules["danish-pension"].DanishPensionAssessmentOptions | Resolved classified bases for the native pension assessment; all bases are required. Model value shape: |
modules["danish-pension"].DanishPensionComponent | DanishPensionComponent describes a model value used by the Danish Pension editor functions. Model value shape: |
modules["danish-pension"].DanishPensionOptions | DanishPensionOptions describes a model value used by the Danish Pension editor functions. Model value shape: |
modules["danish-pension"].NationalPensionRules | NationalPensionRules describes a model value used by the Danish Pension editor functions. Model value shape: |
modules["danish-pension"].PensionAmountSource | PensionAmountSource describes a model value used by the Danish Pension editor functions. Model value shape: |
modules["danish-pension"].PensionNumberSource | PensionNumberSource describes a model value used by the Danish Pension editor functions. Model value shape: |
Finnish Pension module
Select this module in model settings to use its names in the portal model editor (modules["finnish-pension"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["finnish-pension"].assessFinnishPension | Pure assessment of the same partial 2026 scheme as finnishPension. Numeric sources must already be resolved; amounts use the native period and currency. The explicit scheme and nonempty basisSource are mandatory. No owner, id, engine reference, callback, bank payment or personal pension-capital balance is created. Invalid/negative bases, foreign Money, missing data and unsupported schemes fail.
|
| |
modules["finnish-pension"].FINNISH_PENSION_2026 | Immutable FI 2026 partial pension rules, parameter provenance and assessment validity.
|
| |
modules["finnish-pension"].finnishPension | Calculates the unadjusted Finnish TyEL pension entitlement earned on insured employee earnings in calendar year 2026. pensionableEarnings is the annual insured earnings basis in EUR, supplied as a number, same-currency money or a declared amount source. basisSource names the payroll or pension record establishing insurance coverage and pensionable classification. Earnings accrue a 1.5% annual pension increment for every supported age group from 2026; the former 1.7% older-worker transition ended in 2025. Employee pension contributions are not deducted from this basis. annualPensionAccrual is the new yearly pension right and monthlyPensionAccrual is that right divided by twelve. Neither is cash paid or the person's accumulated whole-career pension. Life expectancy coefficients, indexation, deferred/early retirement, Kela, disability, unsalaried credits and self-employment are unsupported. Required options are id, owner, ruleYear:2026, the explicit scheme, basisSource and all numeric bases. There are no implicit amount or scheme defaults; pass zero explicitly when true. The owner is an entity or a keyed entity lookup, such as lookup(people.outputs.person, people.item.data.id) for repeated rows. Register the returned component in model components. outputs.assessment publishes the full record, and named numeric outputs are calculation projections usable in metrics and other declarations. rules exposes immutable national parameters, source links, validity and review dates. The model must use EUR and the annual calendar with periods starting on the first day, in January. Only the 2026 assessment year is supported. All amounts use EUR; rate calculations retain raw values before payment rounding. Unknown options/schemes, missing source classifications, negative or nonfinite bases, wrong currencies and uncovered dates/calendars fail explicitly. Callbacks capturing row projections cannot rebind. For repeated rows, use direct input references, expressions or bindable calculation references instead. Ordinary callbacks may use declared inputs that do not capture symbolic rows. No tax, bank transaction, capital balance or current pension payout is created.
|
| |
modules["finnish-pension"].FinnishPensionAssessment | FinnishPensionAssessment describes a model value used by the Finnish Pension editor functions. Model value shape: |
modules["finnish-pension"].FinnishPensionAssessmentOptions | Resolved classified bases for the native pension assessment; all bases are required. Model value shape: |
modules["finnish-pension"].FinnishPensionComponent | FinnishPensionComponent describes a model value used by the Finnish Pension editor functions. Model value shape: |
modules["finnish-pension"].FinnishPensionOptions | FinnishPensionOptions describes a model value used by the Finnish Pension editor functions. Model value shape: |
modules["finnish-pension"].NationalPensionRules | NationalPensionRules describes a model value used by the Finnish Pension editor functions. Model value shape: |
modules["finnish-pension"].PensionAmountSource | PensionAmountSource describes a model value used by the Finnish Pension editor functions. Model value shape: |
modules["finnish-pension"].PensionNumberSource | PensionNumberSource describes a model value used by the Finnish Pension editor functions. Model value shape: |
Icelandic Pension module
Select this module in model settings to use its names in the portal model editor (modules["icelandic-pension"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["icelandic-pension"].assessIcelandicPension | Pure assessment of the same partial 2026 scheme as icelandicPension. Numeric sources must already be resolved; amounts use the native period and currency. The explicit scheme and nonempty basisSource are mandatory. No owner, id, engine reference, callback, bank payment or personal pension-capital balance is created. Invalid/negative bases, foreign Money, missing data and unsupported schemes fail.
|
| |
modules["icelandic-pension"].ICELANDIC_PENSION_2026 | Immutable IS 2026 partial pension rules, parameter provenance and assessment validity.
|
| |
modules["icelandic-pension"].icelandicPension | Calculates Iceland's 2026 mandatory mutual-insurance minimum for an already covered employee's monthly pensionable wages. pensionableEarnings is the monthly ISK wage basis, supplied as a number, same-currency money or a declared amount source. basisSource names the verified payroll/enrolment record, which establishes coverage including the age-16-to-70 condition. The employee minimum is 4% and employer minimum 11.5%, totaling 15.5%. employeeContribution, employerContribution and totalContribution are minimum premiums, not an insurer quote, savings balance or current pension payment. Actual collective-agreement premiums may be higher and must be obtained separately; this slice does not silently treat the legal minimum as the employee's full agreement. Voluntary additional savings, self-employment, state pension, lifetime benefit pricing, disability/survivor benefits and tax are unsupported. Required options are id, owner, ruleYear:2026, the explicit scheme, basisSource and all numeric bases. There are no implicit amount or scheme defaults; pass zero explicitly when true. The owner is an entity or a keyed entity lookup, such as lookup(people.outputs.person, people.item.data.id) for repeated rows. Register the returned component in model components. outputs.assessment publishes the full record, and named numeric outputs are calculation projections usable in metrics and other declarations. rules exposes immutable national parameters, source links, validity and review dates. The model must use ISK and the monthly calendar with periods starting on the first day. Only the 2026 assessment year is supported. All amounts use ISK; rate calculations retain raw values before payment rounding. Unknown options/schemes, missing source classifications, negative or nonfinite bases, wrong currencies and uncovered dates/calendars fail explicitly. Callbacks capturing row projections cannot rebind. For repeated rows, use direct input references, expressions or bindable calculation references instead. Ordinary callbacks may use declared inputs that do not capture symbolic rows. No tax, bank transaction, capital balance or current pension payout is created.
|
| |
modules["icelandic-pension"].IcelandicPensionAssessment | IcelandicPensionAssessment describes a model value used by the Icelandic Pension editor functions. Model value shape: |
modules["icelandic-pension"].IcelandicPensionAssessmentOptions | Resolved classified bases for the native pension assessment; all bases are required. Model value shape: |
modules["icelandic-pension"].IcelandicPensionComponent | IcelandicPensionComponent describes a model value used by the Icelandic Pension editor functions. Model value shape: |
modules["icelandic-pension"].IcelandicPensionOptions | IcelandicPensionOptions describes a model value used by the Icelandic Pension editor functions. Model value shape: |
modules["icelandic-pension"].NationalPensionRules | NationalPensionRules describes a model value used by the Icelandic Pension editor functions. Model value shape: |
modules["icelandic-pension"].PensionAmountSource | PensionAmountSource describes a model value used by the Icelandic Pension editor functions. Model value shape: |
modules["icelandic-pension"].PensionNumberSource | PensionNumberSource describes a model value used by the Icelandic Pension editor functions. Model value shape: |
Norwegian Pension module
Select this module in model settings to use its names in the portal model editor (modules["norwegian-pension"]).
| Model editor name | Purpose and model value shape |
|---|---|
modules["norwegian-pension"].assessNorwegianPension | Pure assessment of the same partial 2026 scheme as norwegianPension. Numeric sources must already be resolved; amounts use the native period and currency. The explicit scheme and nonempty basisSource are mandatory. No owner, id, engine reference, callback, bank payment or personal pension-capital balance is created. Invalid/negative bases, foreign Money, missing data and unsupported schemes fail.
|
| |
modules["norwegian-pension"].NORWEGIAN_PENSION_2026 | Immutable NO 2026 partial pension rules, parameter provenance and assessment validity.
|
| |
modules["norwegian-pension"].norwegianPension | Calculates income-based notional pension accrual under Norway's new National Insurance rules for calendar year 2026. pensionableEarnings is already classified annual NOK pensionable income: a number, same-currency money or declared amount source. basisSource names the record establishing that classification. birthYear is an integer numeric source from 1963 through 2013, excluding transitional cohorts and years below the age-13 boundary. Accrual is 18.1% of income capped at 7.1 times the annual average G. For 2026 average G is NOK 134419; the May G of NOK 136549 is not used for this annual cap. notionalAccrual is an increase in the notional pension right; coveredIncome, earningsCap and averageBaseAmount explain its basis. It is neither an employer premium nor liquid capital nor annual pension income. Care/service credits, old/transitional rules, guarantee pension, AFP, occupational schemes, indexation and conversion using individual life-expectancy divisors are unsupported. Required options are id, owner, ruleYear:2026, the explicit scheme, basisSource and all numeric bases. There are no implicit amount or scheme defaults; pass zero explicitly when true. The owner is an entity or a keyed entity lookup, such as lookup(people.outputs.person, people.item.data.id) for repeated rows. Register the returned component in model components. outputs.assessment publishes the full record, and named numeric outputs are calculation projections usable in metrics and other declarations. rules exposes immutable national parameters, source links, validity and review dates. The model must use NOK and the annual calendar with periods starting on the first day, in January. Only the 2026 assessment year is supported. All amounts use NOK; rate calculations retain raw values before payment rounding. Unknown options/schemes, missing source classifications, negative or nonfinite bases, wrong currencies and uncovered dates/calendars fail explicitly. Callbacks capturing row projections cannot rebind. For repeated rows, use direct input references, expressions or bindable calculation references instead. Ordinary callbacks may use declared inputs that do not capture symbolic rows. No tax, bank transaction, capital balance or current pension payout is created.
|
| |
modules["norwegian-pension"].NationalPensionRules | NationalPensionRules describes a model value used by the Norwegian Pension editor functions. Model value shape: |
modules["norwegian-pension"].NorwegianPensionAssessment | NorwegianPensionAssessment describes a model value used by the Norwegian Pension editor functions. Model value shape: |
modules["norwegian-pension"].NorwegianPensionAssessmentOptions | Resolved classified bases for the native pension assessment; all bases are required. Model value shape: |
modules["norwegian-pension"].NorwegianPensionComponent | NorwegianPensionComponent describes a model value used by the Norwegian Pension editor functions. Model value shape: |
modules["norwegian-pension"].NorwegianPensionOptions | NorwegianPensionOptions describes a model value used by the Norwegian Pension editor functions. Model value shape: |
modules["norwegian-pension"].PensionAmountSource | PensionAmountSource describes a model value used by the Norwegian Pension editor functions. Model value shape: |
modules["norwegian-pension"].PensionNumberSource | PensionNumberSource describes a model value used by the Norwegian Pension editor functions. Model value shape: |
Host website integrations
Use the complete embedded Calculator App reference for the host component API, requests, navigation, events and authenticated case access. These methods belong to your website, not model editor code.
App themes
See App themes for the eight palettes and densities, editor settings, versioned app metadata and integration examples.
Cash flow statements
In the presentation editor, use CashflowStatement({method: "indirect", period: "years"}) for reconciled profit, noncash adjustments, working capital, investing and financing. Exact-coverage groups and interleaved rows support explicit and cumulative sums. See the complete cash flow reference and callable examples for selections, defaults, validation and reconciliation.
return presentation({ cash: CashflowStatement({ method: "indirect", period: "years" }) });Dashboard presentation widgets
Use DataCards({source}) for published card records or DataCards({cards}) for presentation-owned labels and metric/calculation selectors, RecordChart({source, xKey, series}) for published projections and UncertaintyChart({metrics, percentiles:[5,50,95]}) for actual Monte Carlo outcomes. See the complete dashboard widget reference and callable examples for arguments, units, timing, defaults and validation.
Initial Calculator run settings
Use deccf.defineModel({calculator:{defaultRun:{mode:"monte-carlo",trials:128,sampling:"sobol"}},currency:deccf.currencies.USD,timeline:deccf.periods.annual({from:"2026-01",count:1})}) to initialize new run controls. Saved selections take precedence. See the complete initial run settings reference for all supported fields, defaults and validation.
Static bindings and dynamic callbacks
Use declared bindings for calculation and flow reads, dynamic:true for the broad context, and deccf.prepare(model,{outputs}).run({parameters}) for repeated calculations with selected final values. Scope reusable validated data with prepared.withParameters(parameters) and project previous fields with deccf.bind.previous().project(path). See the complete execution reference for callable examples, history, once values, defaults and validation.