Summert skattegrunnlag API

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 spesifisert summert skattegrunnlag, hvor URL’en har litt ulik oppbygging.

For rettighetspakke kommuneforeldrebetaling 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, fastsatt og oppgjoer.
• <rettighetspakke>: En av rettighetspakkene nav, distribusjon, ldir, laanekassen, frirettshjelp, husbanken, udi og kommuneforeldrebetaling.
• <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 inntektsaar og stadie.

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 med samtykke

For Datakonsumenter som benytter Samtykke gjelder en del tilleggskrav:

AltinnSamtykke header

Må legge ved en ekstra header AltinnSamtykke. Verdien i denne headeren skal være et base64-encodet Json Web Token (JWT) signert av Altinn. Tokenet er en representasjon av samtykket man har innhentet fra skattyteren man henter data for. For informasjon rundt hvordan man skaffer et slikt token, sjekk Altinn: hente token

Restriksjoner på spørreperiode

Datakonsumenter med samtykke har kun lov til å spørre om summert skattegrunnlag for seneste tilgjengelige inntektsaar. Tilgjengeligdata-tjenesten kan brukes uten samtykke til å sjekke hva som er seneste tilgjengelige inntektsaar.

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.

Her er et eksempel på en spørring med curl mot tjenesten. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.

$ curl -v --cert datakonsument.cer --key datakonsument.key -H "AltinnSamtykke: <samtykke>" "https://api-at.sits.no/api/formueinntekt/summertskattegrunnlag/distribusjon/2017/12345678901"

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å en forkortet respons for inntektsår 2017 i JSON uten oppgitt stadie. Et eksempel på en fullstending respons finnes på lenke under.

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2017",
  "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"
      ]
    }
  ],
  "skatteoppgjoersdato": "2018-10-04",
  "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"
      ]
    }
  ]
}

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"
}

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.xsd

Eksempler på respons:

SummertSkattegrunnlag2020.xml

SummertSkattegrunnlag2017.xml

SummertSkattegrunnlag2016.xml

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-011",
 "melding": "Feltet 'personidentifikator' har ugyldig format. Må være nøyaktig 11 siffer",
 "korrelasjonsid": "23a235f5-28f9-47db-9abd-ab78977c32fa"
}

XML

Dersom Accept-header er satt til application/xml vil også eventuell feilmelding være i XML:

feil.xsd

SummertSkattegrunnlag_feil.xml (eksempel)

Samtykkeoppsett

(Gjelder bare brukere som må ha samtykke)

Feilkoder

Se også felles feilkoder for alle applikasjonene.