v1

OpenAPI 3.1.02026-07-13252193.7 KB
Simulation

Simulate the cost of a product version (full or partial year)

Returns the estimated cost of the given product version for the supplied consumption profile — a cost breakdown of energy cost, injection fee, and discounts. Defaults to a full year; pass yearFraction (in (0, 1]) to price a partial year — e.g. a mid-year supplier switch. yearFraction pro-rates only the time-based fixed/recurring fees (the energy-cost fixed fee / standing charge, the regulated fixed network fees, and the energy-fund excise); per-kWh charges (energy usage, WKK / green certificates, per-kWh excise and distribution, injection) follow the consumption figures you provide, so supply consumption for the period being simulated. The supplied (postalCode, city) must resolve to a Distribution Network Operator Vwala can price; call GET /v1/serviceable-locations to discover valid postal codes/cities and which energy types each supports. See the 422 response for the location and validation errors this can return.

post/v1/products/{productId}/versions/{versionId}/simulate

Path parameters

productIdstring required
versionIdstring required

Request body

yearFractionnumber

Fraction of a calendar year to simulate, in the range (0, 1]. Defaults to 1 (a full year). Use a value below 1 to price a partial year — e.g. 0.5 for six months, 0.25 for a quarter — typically a mid-year supplier switch. It pro-rates only the time-based fixed/recurring fees to the period: the energy-cost fixed fee (standing charge / abonnement), the regulated fixed network fees (e.g. databeheer, capaciteitstarief, prosumententarief, gas vaste term) and the energy-fund excise (bijdrage energiefonds). Consumption-based charges — energy usage, WKK / green certificates, per-kWh excise and distribution, and injection — are NOT scaled by yearFraction; they follow the consumption figures you provide, so supply the consumption for the period you are simulating.

Response

Default Response