---
title: "Get a PV planning's savings scenario"
method: GET
path: "/solar-plannings/{solarPlanningId}/simulation"
tags: ["PV plannings"]
---

# Get a PV planning's savings scenario

`GET /solar-plannings/{solarPlanningId}/simulation`

## Request

- Base URL: `https://api3.autarc.energy/v1`
- URL: `https://api3.autarc.energy/v1/solar-plannings/{solarPlanningId}/simulation`
- Auth: API key in header `X-Api-Key`

The savings scenario stored next to the PV planning — the most recently
updated one, or the one named by `simulationId`.

It returns the scenario's own stored economic inputs (price escalation,
feed-in tariff, CER incentive, discount, per-trade pricing), which energy
flows it models, its component list, the linked customer proposal, and the
planning's stored yield.

The result figures Autarc Pro derives for display — self-consumption,
autarky, bill savings and amortization — are recomputed on every view and
are not persisted, so they are not part of this response.

This is a partial export of the calculation inputs and does not suffice to
reproduce those figures: recurring costs, the simulation resolution, the
project's consumption and tariffs, and the components' kind-specific
configuration are not included.

## Path parameters

- `solarPlanningId` string, uuid, required

## Query parameters

- `simulationId` string, uuid

## Response `200`

The stored savings scenario of a PV planning.

- SolarSimulation: The savings scenario Autarc Pro stores next to a PV planning: its own economic inputs, which energy flows it models, how each trade is priced, and the planner's stored yield. The result figures the app derives for display — self-consumption, autarky, bill savings, amortization — are recomputed on every view and are not persisted, so they are not part of this response. This is a partial export of the calculation inputs and is not sufficient to reproduce the app's results. Not included: the recurring costs and the simulation resolution (both owned by the project's baseline scenario, with company defaults), the project's electricity consumption and tariffs, and the kind-specific configuration of the scenario's components (household and heating overrides, battery control, custom components).
  - `id` string, uuid, required
  - `name` string, required
  - `projectId` string, uuid, required
  - `solarPlanningId` string, uuid, required
  - `proposalId` string, uuid: The customer proposal built on this scenario, when one exists.
  - `isBaseline` boolean, required: Whether this scenario is the project's reference scenario.
  - `annualYieldKwh` number: The planning's stored yearly yield in kWh. Omitted when no yield has been calculated.
  - `monthlyYieldKwh` number[]
  - `yieldSource` string
  - `yieldCapturedAt` string, date-time
  - `acConsumptionPerYearKwh` number: Modelled yearly air-conditioning consumption in kWh.
  - `acFixedPrice` number: Fixed price of the air-conditioning trade.
  - `useSeasonalPerformanceFactor` boolean, required: Whether the heat pump's consumption is derived from the building's heat load, full-load hours and simulatedSeasonalPerformanceFactor (true) rather than taken from the stated annual heat-pump consumption (false).
  - `simulatedSeasonalPerformanceFactor` number
  - `wallboxUsagePattern` string: Driving pattern used for the wallbox load profile (e.g. workCommuter, weekendDriver).
  - `yearlyEnergyCostIncrease` number: Assumed yearly electricity price escalation in percent (e.g. 3 for 3 %).
  - `yearlyFossilCostIncrease` number: Assumed yearly fossil fuel price escalation in percent.
  - `pricePerReimbursedKwh` number: Feed-in tariff per kWh exported to the grid.
  - `discountRate` number
  - `discountType` string: percentage or absolute.
  - `cer` object, required: Italian renewable energy community (CER) incentive on the share of exported energy consumed inside the community. With enabled false no incentive is applied.
    - `enabled` boolean, required
    - `sharedQuota` number: Share of the exported energy consumed in the community, in percent (0–100).
    - `incentivePerKwh` number: Incentive paid per shared kWh, in the company currency.
    - `clientShare` number: Share of the incentive the client keeps, in percent (0–100).
  - `includes` object, required: Which energy flows the scenario models.
    - `solarOutput` boolean, required
    - `battery` boolean, required
    - `wallbox` boolean, required
    - `heatpumpUsage` boolean, required
    - `airConditioning` boolean, required
    - `energyUsage` boolean, required
    - `energyFeedback` boolean, required
    - `gridConsumption` boolean, required
    - `oldHeatingSystem` boolean, required
  - `pricing` SolarSimulationPricing[], required: How each trade is priced in the scenario — one entry per trade, always in the order solar, battery, wallbox, heatpump.
    - `component` string, required: solar, battery, wallbox or heatpump.
    - `pricingModel` string: Where the price comes from — system, flatrate, offer or templateRules.
    - `fixedPrice` number: Flat price for the trade, when the pricing model is a flat rate.
    - `margin` number
    - `marginType` string: percentage or absolute.
    - `offerId` string, uuid: The offer the price is taken from, when the pricing model is `offer`.
  - `components` SolarSimulationComponent[], required: The scenario's component list (producers, consumers, storage).
    - `id` string, uuid, required
    - `kind` string, required: solar, battery, household, heatpump, oldHeating, wallbox, energyFeedback, ac or custom.
    - `enabled` boolean, required
    - `position` integer, required
    - `solarPlanningId` string, uuid: Set for the solar kind.
    - `wallboxPlanningId` string, uuid: Set for the wallbox kind.
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid request — a malformed id, filter, pagination parameter or body. The body is a plain-text message naming the problem.
- `404`: The specified resource was not found

---

[API](https://skmtc.dev/autarc/apis/autarc-2-0-api.md) - [All operations](https://skmtc.dev/autarc/apis/autarc-2-0-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autarc/apis/autarc-2-0-api/revisions/adfb20a40efc?raw)