Tjenesten leverer en oppsummering av formue, gjeld, inntekt og fradrag for en person.

Sikkerhet

Denne tjenesten støtter både bruk av maskinporten og virksomhetssertifikat. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:summertskattegrunnlag

Delegering

Tilgang til denne tjenesten kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen. Søk opp følgende tjeneste i Altinn for å delegere tilgangen: Summert skattegrunnlag API.

Grensesnittbeskrivelse

Det tilbys 2 endepunkter for uthenting av summert skattegrunnlag, hvor URL’en har litt ulik oppbygging.

For rettighetspakkene kommuneforeldrebetaling, kommuneboligsosialeformaal og kommunepersonligassistanse benyttes:

GET https://{env}/api/formueinntekt/summertskattegrunnlag/{stadie}/{rettighetspakke}/{inntektsaar}/{personidentifikator}

For øvrige rettighetspakker benyttes:

GET https://{env}/api/formueinntekt/summertskattegrunnlag/{rettighetspakke}/{inntektsaar}/{personidentifikator}
  • env: Miljø-spesifikk adresse
  • stadie: Hvilket stadie man ønsker oppslag på, utkast eller oppgjoer.
  • rettighetspakke: En av rettighetspakkene nav, distribusjon, ldir, laanekassen, frirettshjelp, husbanken, udi, kommuneforeldrebetaling, kommuneboligsosialeformaal og kommunepersonligassistanse.
  • inntektsaar: Inntektsåret man spør om informasjon for, i formatet YYYY. Tjenesten støtter inntektsår 2016 og utover.
  • personidentifikator: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Merk at rettighetspakkene har ulik tilgang til bruk av inntektsår og stadie.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Summert skattegrunnlag API

Støttetjenester

Hendelsesliste

For å følge med på endringer i SummertSkattegrunnlag tilbyr vi en hendelsesliste. URL er:

GET https://{env}/api/formueinntekt/skatteoppgjoer/hendelser/

Se felles API-dokumentasjon for hendelseslister for bruk.

Tilgjengelige data

For å gjøre spørring med samtykke, må man be skattepliktig om samtykke for en spesifikk periode. Tilgjengeligdata API gir informasjon om hva som er seneste periode med data for en skattepliktig.

Versjonering

Se Om versjonering for generelle regler for versjonering.

Summert skattegrunnlag vil endres når skattereglene endres, altså årlig. Hvilke felt som er tilgjengelig vil kunne variere etter skattereglene som gjelder for det gitte skatteåret det spørres om data om. Dette vil ikke føre til ny versjon av API’et med mindre annen semantikk endres.

Semantikk for versjonering vil bli slik:

Bruk Eksempel Tolkning
Default versjon api/formueinntekt/summertskattegrunnlag/{rettighetspakke}/{inntektsaar} Nyeste versjon tas i bruk automatisk.

Eksempel på respons fra tjenesten

  • For 2015 og 2016 er Svalbard- og fastlandsinformasjon summert sammen. Fra og med 2017 er Svalbard-data skilt ut i svalbardSkjoennsfastsatt og svalbardGrunnlag.

Suksess (HTTP status 200)

Dersom kallet lykkes får man HTTP status 200 og data i JSON eller XML format. Dersom man ikke spesifiserer ønsket format får man JSON.

JSON

Her er et eksempel på respons for inntektsår 2021 i JSON uten oppgitt stadie.

{
  "personidentifikator": "21839199217",
  "inntektsaar": "2021",
  "skjermet": false,
  "grunnlag": [
    {
      "tekniskNavn": "samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt",
      "beloep": 762732,
      "kategori": [
        "inntekt"
      ]
    },
    {
      "tekniskNavn": "minstefradragIInntekt",
      "beloep": 106750,
      "kategori": [
        "inntektsfradrag"
      ]
    }
  ],
  "skatteoppgjoersdato": "2022-02-10"
}

Eksempel på respons for inntektsår 2020 med oppgitt stadie ‘oppgjoer’ i JSON.

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2020",
  "skjermet": false,
  "grunnlag": [
    {
      "tekniskNavn": "samledePaaloepteRenter",
      "beloep": 779981,
      "kategori": [
        "inntektsfradrag"
      ]
    },
    {
      "tekniskNavn": "andreFradragsberettigedeKostnader",
      "beloep": 59981,
      "kategori": [
        "inntektsfradrag"
      ]
    },
    {
      "tekniskNavn": "samletSkattepliktigOverskuddAvUtleieAvFritidseiendom",
      "beloep": 1609981,
      "kategori": [
        "inntekt"
      ]
    },
    {
      "tekniskNavn": "skattepliktigAvkastningEllerKundeutbytte",
      "beloep": 1749981,
      "kategori": [
        "inntekt"
      ]
    }
  ],
  "svalbardGrunnlag": [
    {
      "tekniskNavn": "samledePaaloepteRenter",
      "beloep": 779981,
      "kategori": [
        "inntektsfradrag"
      ]
    },
    {
      "tekniskNavn": "samletAndelAvInntektIBoligselskapEllerBoligsameie",
      "beloep": 849981,
      "kategori": [
        "inntekt"
      ]
    },
    {
      "tekniskNavn": "skattepliktigUtbytteFraAksjerRegistrertIVerdipapirsentralen",
      "beloep": 1779981,
      "kategori": [
        "inntekt"
      ]
    },
    {
      "tekniskNavn": "skattepliktigAvkastningEllerKundeutbytte",
      "beloep": 1749981,
      "kategori": [
        "inntekt"
      ]
    }
  ],
  "skatteoppgjoersdato": "2020-02-11",
  "stadie": "oppgjoer",
  "registreringstidpunkt": "2020-02-11T16:11:12.985"
}

Flere eksempler på responser:

SummertSkattegrunnlag2020.json

SummertSkattegrunnlag2017.json

SummertSkattegrunnlag2016.json

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml

<summertSkattegrunnlag xmlns="urn:no:skatteetaten:datasamarbeid:summertskattegrunnlag:v1">
  <personidentifikator>21839199217</personidentifikator>
  <inntektsaar>2021</inntektsaar>
  <skjermet>false</skjermet>
  <grunnlag>
    <tekniskNavn>samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt</tekniskNavn>
    <beloep>762732</beloep>
    <kategori>inntekt</kategori>
  </grunnlag>
  <grunnlag>
    <tekniskNavn>minstefradragIInntekt</tekniskNavn>
    <beloep>106750</beloep>
    <kategori>inntektsfradrag</kategori>
  </grunnlag>
  <skatteoppgjoersdato>2022-02-10</skatteoppgjoersdato>
</summertSkattegrunnlag>

Dataverdier

For mulige verdier av <tekniskNavn>, se informasjonsmodell for summert skattegrunnlag

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.

JSON

{
  "kode": "SSG-005",
  "melding": "Du er ikke autorisert for bruk av dette endepunktet.",
  "korrelasjonsid": "23a235f5-28f9-47db-9abd-ab78977c32fa"
}

Feilkoder

Tabellen under viser en oversikt over hvilke typer feil applikasjonen kan gi. Feilmeldingen vil kunne variere selv om samme feilkode returneres. Dette er for å kunne gi en så presis beskrivelse av feilen som mulig. Ved vedvarene feil vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra feilmelding.

Feilkode HTTP Statuskode Feilområde
SSG-001 500 Uventet feil på tjenesten.
SSG-002 500 Uventet feil i et bakenforliggende system.
SSG-003 404 Ukjent url benyttet.
SSG-004 401 Feil i forbindelse med autentisering.
SSG-005 403 Feil i forbindelse med autorisering.
SSG-006 400 Feil i forbindelse med validering av inputdata.
SSG-007 404 Ikke treff på oppgitt personidentifikator.
SSG-008 404 Ingen summert skattegrunnlag funnet på oppgitt personidentifikator og inntektsår.
SSG-009 406 Feil tilknyttet dataformat. Kun json eller xml er støttet.
SSG-010 410 Skattegrunnlag finnes ikke lenger.
Tags: