Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Designs

Retrieve System Loss Settings

Retrieve the editable per-design system-loss settings: the input derate percentages and their lock state.

These are the editable inputs to the performance simulation. They are distinct from the computed loss waterfall returned under energy_production.loss_summary by the Design Summary endpoint, which reports the irradiance/energy remaining after each stage. Each editable setting maps to exactly one loss_summary stage — see the mapping table on Update System Loss Settings.

Values are percentages (e.g. 2.0 represents a 2% loss). Only annual values are supported.

get/tenants/{tenant_id}/designs/{id}/system_loss_settings

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design is part of.

idstring uuid required

The ID of the design to retrieve system loss settings for.

Response

System loss settings successfully retrieved.

Example response

{
  "system_loss_settings": {
    "editable": true,
    "values": {
      "soiling": {
        "value": 2
      },
      "snow": {
        "value": 2
      },
      "shading": {
        "value": 2
      },
      "mismatch": {
        "value": 2
      },
      "wiring": {
        "value": 2
      },
      "connections": {
        "value": 2
      },
      "light_induced_degradation": {
        "value": 2
      },
      "availability": {
        "value": 2
      },
      "rating": {
        "value": 2
      },
      "age": {
        "value": 2
      },
      "other": {
        "value": 2
      }
    }
  }
}