{
  "openapi": "3.0.1",
  "info": {
    "title": "Inntektsrammer",
    "description": "<div class=\"info__tos\"><p>Reguleringsmyndigheten for Energi (RME) regulerer nettselskapenes inntekter, som blant annet omfatter å beregne og vedta en årlig inntektsramme. Dataene under stammer fra RMEs årlige inntektsrammeberegninger. Disse inkluderer grunnlagsdata fra økonomisk og teknisk rapportering (eRapp) og fra rapportering av tekniske regionalnettsanlegg (TEK). I tillegg inkluderer dataene resultater fra beregningene, som blant annet omfatter effektivitetsanalyser og endelige inntektsrammer per nettselskap. Her kan du lese mer om inntektsreguleringen av nettselskaper: <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://www.nve.no/reguleringsmyndigheten/regulering/nettvirksomhet/oekonomisk-regulering-av-nettselskap/\" class=\"link\">Økonomisk regulering av nettselskap - NVE </a>.<p>APIet benytter løsning for deprecation og sunset for å informere om når det blir fjernet eller erstattet. <p><b>Utstedelse av api-key for nye/eksisterende api-kontoer</b><p>Dine personopplysninger vil bli behandlet i samsvar med personopplysningsloven. NVE overholder kravene til databeskyttelse ved design og standard. NVE vil samle inn dine personopplysninger (e-post og ip-adresse) for å identifisere deg som bruker av dette API. Vi vil bruke dine personopplysninger til statistikk. Dine personopplysninger kan også bli brukt av oss til å identifisere deg, for å forhindre, og oppdage misbruk av apiet. NVE vil slette dine personopplysninger når vi mottar en forespørsel fra deg som ber oss om å gjøre dette. Du finner NVEs personvernerklæring her: <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://www.nve.no/om-nve/nves-personvernerklaering/\" class=\"link\">NVEs personvernerklæring - NVE</a><p>Etter å ha sendt epost til <a href=\"mailto:bi-api@nve.no?subject=Bestilling av API-nøkkel\">bi-api@nve.no</a>, og oppgitt epost-adresse og navn (valgfritt) vil du etter kort tid motta en api-nøkkel på angitt epost-adresse, som du kan benytte i dine api-kall. Det kan ta inntil 15 minutter fra du mottar epost med api-nøkkel til den er aktivert, og kan benyttes i api-kall.</div>",
    "version": "v1.0"
  },
  "servers": [
    {
      "url": "/inntektsrammer"
    }
  ],
  "paths": {
    "/api/InntektsrammerSistOppdatertDato": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer datoen for da API'et sist ble oppdatert med nye data fra inntektsrammeberegningen. \r\nBruk gjerne dette endepunktet for å sjekke om datasettet er oppdatert før du gjør en ny nedlastning av datasettene.",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerType": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer beskrivelse og type-id for de ulike typene av inntektsrammeberegninger.",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerVariabler": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer alle inntektsramme-variabler med navn, nettnivå, kategori og en forklaringstekst.",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerSelskap": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer alle selskap som var gjeldende for et gitt år.",
        "parameters": [
          {
            "name": "KostnadsgrunnlagAar",
            "in": "query",
            "description": "Kostnadsgrunnlagår (fra og med 2013).",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerForutsetninger": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer alle forutsetninger som var gjeldende for et gitt år.",
        "parameters": [
          {
            "name": "KostnadsgrunnlagAar",
            "in": "query",
            "description": "Kostnadsgrunnlagår (fra og med 2013)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Type",
            "in": "query",
            "description": "Type inntektsrammeberegning (1 for foreløpig beregning, 2 for varsel, 3 for vedtak, 4 for foreløpig reberegning og 5 for endelig reberegning). Dersom type ikke angis, vil vedtak returneres der dette er tilgjengelig. Ellers returneres nyeste type inntektsrammeberegning.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerGrunnlagsdata": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer alle grunnlagsdata som er gjeldende for et gitt år og selskap.",
        "parameters": [
          {
            "name": "KostnadsgrunnlagAar",
            "in": "query",
            "description": "Kostnadsgrunnlagår (fra og med 2013)",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": "2021"
            }
          },
          {
            "name": "SelskapsId",
            "in": "query",
            "description": "Inntektsramme selskapsid",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Type",
            "in": "query",
            "description": "Type inntektsrammeberegning (1 for foreløpig beregning, 2 for varsel, 3 for vedtak, 4 for foreløpig reberegning og 5 for endelig reberegning). Dersom type ikke angis, vil vedtak returneres der dette er tilgjengelig. Ellers returneres nyeste type inntektsrammeberegning.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    },
    "/api/InntektsrammerResultater": {
      "get": {
        "tags": [
          "Inntektsrammer"
        ],
        "summary": "Returnerer alle resultater fra inntektsrammeberegningene som er gjeldende for et gitt år og selskap.",
        "parameters": [
          {
            "name": "KostnadsgrunnlagAar",
            "in": "query",
            "description": "Kostnadsgrunnlagår (fra og med 2013)",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "SelskapsId",
            "in": "query",
            "description": "Inntektsramme selskapsid",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "Type",
            "in": "query",
            "description": "Type inntektsrammeberegning (1 for foreløpig beregning, 2 for varsel, 3 for vedtak, 4 for foreløpig reberegning og 5 for endelig reberegning). Dersom type ikke angis, vil vedtak returneres der dette er tilgjengelig. Ellers returneres nyeste type inntektsrammeberegning.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": { },
              "application/xml": { }
            }
          },
          "400": {
            "description": "An error occured"
          },
          "401": {
            "description": "Unauthorized"
          },
          "429": {
            "description": "TooManyRequests"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "InntektsrammerForutsetningerModel": {
        "type": "object",
        "properties": {
          "kostnadsgrunnlagAar": {
            "type": "integer",
            "description": "Angir år for kostnads- eller datagrunnlaget. Inntektsrammen beregnes alltid basert på to år gamle data. Eks. vil data fra år 2021 brukes til å beregne inntektsrammer for 2023.",
            "format": "int32"
          },
          "type": {
            "type": "integer",
            "description": "Inntektsberegningens type, eks. varsel, vedtak, etc.",
            "format": "int32"
          },
          "variabelnavn": {
            "type": "string",
            "description": "Kortnavn for variabelen.",
            "nullable": true
          },
          "verdi": {
            "type": "number",
            "description": "Variabelens verdi",
            "format": "float",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Forutsetninger brukt i beregningen av inntektsrammer for et gitt år og en gitt type beregning. Verdiene i denne tabellen gjelder på tvers av nettselskaper."
      },
      "InntektsrammerGrunnlagsdataModel": {
        "type": "object",
        "properties": {
          "kostnadsgrunnlagAar": {
            "type": "integer",
            "description": "Angir år for kostnads- eller datagrunnlaget. Inntektsrammen beregnes alltid basert på to år gamle data. Eks. vil data fra år 2021 brukes til å beregne inntektsrammer for 2023.",
            "format": "int32"
          },
          "selskapsId": {
            "type": "integer",
            "description": "RMEs interne id for de ulike nettselskapene. Denne vil være konstant over tid, til tross for endringer i selskapsnavn eller organisasjonsnummer.",
            "format": "int32"
          },
          "historikkAar": {
            "type": "integer",
            "description": "Angir historisk år. Dette er fordi deler av analysen baserer seg på gjennomsnittsobservasjoner over fem år.",
            "format": "int32"
          },
          "type": {
            "type": "integer",
            "description": "Inntektsberegningens type, eks. varsel (2), vedtak (3), etc.",
            "format": "int32"
          },
          "variabelnavn": {
            "type": "string",
            "description": "Kortnavn for variabelen.",
            "nullable": true
          },
          "verdi": {
            "type": "number",
            "description": "Variabelens verdi",
            "format": "float",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Grunnlagsdata brukt som input i inntektsrammeberegningen. Tabellen inkluderer verdier for fem år, ettersom deler av de årlige analysene baserer seg på gjennomsnittsobservasjoner."
      },
      "InntektsrammerResultaterModel": {
        "type": "object",
        "properties": {
          "kostnadsgrunnlagAar": {
            "type": "integer",
            "description": "Angir år for kostnads- eller datagrunnlaget. Inntektsrammen beregnes alltid basert på to år gamle data. Eks. vil data fra år 2021 brukes til å beregne inntektsrammer for 2023.",
            "format": "int32"
          },
          "selskapsId": {
            "type": "integer",
            "description": "RMEs interne id for de ulike nettselskapene. Denne vil være konstant over tid, til tross for endringer i selskapsnavn eller organisasjonsnummer.",
            "format": "int32"
          },
          "type": {
            "type": "integer",
            "description": "Inntektsberegningens type, eks. varsel, vedtak, etc.",
            "format": "int32"
          },
          "variabelnavn": {
            "type": "string",
            "description": "Kortnavn for variabelen.",
            "nullable": true
          },
          "verdi": {
            "type": "number",
            "description": "Variabelens verdi",
            "format": "float",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Resultater fra inntektsrammeberegningen, inkludert selve inntektsrammen, effektivitetsresultater og informasjon om referenter."
      },
      "InntektsrammerSelskapModel": {
        "type": "object",
        "properties": {
          "kostnadsgrunnlagAar": {
            "type": "integer",
            "description": "Aangir år for kostnads- eller datagrunnlaget. Inntektsrammen beregnes alltid basert på to år gamle data. Eks. vil data fra år 2021 brukes til å beregne inntektsrammer for 2023.",
            "format": "int32"
          },
          "selskapsId": {
            "type": "integer",
            "description": "RMEs interne id for de ulike nettselskapene. Denne vil være konstant over tid, til tross for endringer i selskapsnavn eller organisasjonsnummer.",
            "format": "int32"
          },
          "selskapsnavn": {
            "type": "string",
            "description": "Skapets navn",
            "nullable": true
          },
          "organisasjonsnummer": {
            "type": "string",
            "description": "Skapets organisasjonsnummer",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Informasjon om selskaper med inntektsramme per år."
      },
      "InntektsrammerSistOppdatertDatoModel": {
        "type": "object",
        "properties": {
          "sistOppdatertDato": {
            "type": "string",
            "description": "Datoen da API'et sist ble oppdatert med nye data fra inntektsrammeberegningen.",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "Returnerer datoen for da API'et sist ble oppdatert med nye data fra inntektsrammeberegningen."
      },
      "InntektsrammerTypeModel": {
        "type": "object",
        "properties": {
          "type": {
            "type": "integer",
            "description": "Inntektsberegningens type, eks. varsel, vedtak, etc.",
            "format": "int32"
          },
          "beskrivelse": {
            "type": "string",
            "description": "Tekstlig beskrivelse av type inntektsrammeberegning.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Informasjon om type inntektsrammeberegning, eks. varsel, vedtak, etc."
      },
      "InntektsrammerVariablerModel": {
        "type": "object",
        "properties": {
          "variabelnavn": {
            "type": "string",
            "description": "Kortnavn for variabelen.",
            "nullable": true
          },
          "nettnivaa": {
            "type": "string",
            "description": "Angir hvilket nettnivå variabelen gjelder for ('ld'- for lokalt distribusjonsnett, 'rd'- for regionalt distribusjonsnett og 't'- for transmisjonsnett).",
            "nullable": true
          },
          "kategori": {
            "type": "string",
            "description": "En samlebetegnelse for ulike typer variabler, eks. «Resultat» for alle typer resultater fra effektivitetsanalysene, etc.",
            "nullable": true
          },
          "forklaringNorsk": {
            "type": "string",
            "description": "Beskrivelse av variabelen.",
            "nullable": true
          },
          "forklaringEngelsk": {
            "type": "string",
            "description": "Description of the variable.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Informasjon om de ulike variablene."
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "API Key Authentication",
        "name": "X-API-KEY",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": [ ]
    }
  ]
}