Spesifisert summert skattegrunnlag API

Tjenesten leverer en oppsummering av formue, gjeld, inntekt og fradrag for en person, inkludert spesifisering av hvilke opplysninger fra skattemeldingen som ligger til grunn.

Sikkerhet

Denne tjenesten støtter kun bruk av maskinporten. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

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

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: Spesifisert summert skattegrunnlag API.

Grensesnittbeskrivelse

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

For rettighetspakkene sbl, husbanken og saernamsmann:

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

For rettighetspakkene norgesbank, sivilrett, spkboliglaan og navSupplerendeStoenad:

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

env: Miljø-spesifikk adresse
stadie: Hvilket stadie man ønsker oppslag på utkast, oppgjoer og fastsatt.
rettighetspakke: En rettighetspakke er en kode for virksomheten sitt juridiske grunnlag for datauthenting. For mer informasjon se Rettighetspakke.
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.

Open Api Specification

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

Støttetjenester

Hendelsesliste

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

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

Se felles API-dokumentasjon for hendelseslister for bruk.

Tilgjengelige data

Tilgjengeligdata API gir informasjon om hva som er seneste periode med data for en skattepliktig.

Versjonering

Se generelle regler for versjonering.

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

Begrenset til rettighetspakke sbl

Rettighetspakke med samtykke er sbl.

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.

Spesifikasjonstyper for spesifisert summert skattegrunnlag 2018

I 2018 kommer spesifikasjonene til spesifisert summert skattegrunnlag fra to forskjellige løyper: ordinær og pilot. For en detaljert beskrivelse av hva dette innebærer, se Spesifikasjonstyper for spesifisert summert skattegrunnlag 2018

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.
Fra og med 2018 er feltene skjoennsfastsatt og svalbardSkjoennsfastsatt fjernet.

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 -H "Authorization: Bearer <maskinporten_token>" -H "AltinnSamtykke: <samtykke>" "https://api-test.sits.no/api/formueinntekt/spesifisertsummertskattegrunnlag/sbl/2015/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 respons for inntektsår 2021 uten oppgitt stadie i JSON. Det er lenket til flere eksempler på responser nedenfor.

{
  "personidentifikator": "30921548296",
  "inntektsaar": "2021",
  "grunnlag": [
    {
      "tekniskNavn": "samledeOpptjenteRenterIInnenlandskeBanker",
      "beloep": 9251,
      "kategori": "inntekt"
    },
    {
      "tekniskNavn": "samletPensjonFraFolketrygden",
      "beloep": 1056108,
      "kategori": "inntekt"
    },
    {
      "tekniskNavn": "gjeldIInnenlandskeBanker",
      "beloep": 479949,
      "kategori": "formuesfradrag"
    },
    {
      "tekniskNavn": "samletInnskuddIInnenlandskeBanker",
      "beloep": 462570,
      "kategori": "formue"
    },
    {
      "tekniskNavn": "sumGjeldsreduksjon",
      "beloep": 72434,
      "kategori": "formuesfradrag"
    },
    {
      "tekniskNavn": "utbytteFraVerdipapirfond",
      "beloep": 5,
      "spesifisering": [
        {
          "type": "Verdipapirfond",
          "fondetsNavn": "Aksjefondet RST",
          "isinnummer": "NO5107125899",
          "antallAndeler": 110.759,
          "skattepliktigUtbytte": 5,
          "skattepliktigGevinstVedRealisasjonAvAndelIAksjedel": 20708,
          "oppgavegiversOrganisasjonsnummer": "212717622",
          "oppgavegiversNavn": "DEDIKERT SAMARBEIDSVILLIG TIGER AS",
          "verdiFoerVerdsettingsrabattForAndelIAksjedel": 233418
        }
      ],
      "kategori": "inntekt"
    },
    {
      "tekniskNavn": "bruttoformue",
      "beloep": 590950,
      "kategori": "-"
    },
    {
      "tekniskNavn": "samledePaaloepteRenterPaaGjeldIInnenlandskeBanker",
      "beloep": 14398,
      "kategori": "inntektsfradrag"
    },
    {
      "tekniskNavn": "samletGjeld",
      "beloep": 479949,
      "kategori": "-"
    },
    {
      "tekniskNavn": "verdiFoerVerdsettingsrabattForAndelIAksjedelIVerdipapirfond",
      "beloep": 233418,
      "spesifisering": [
        {
          "type": "Verdipapirfond",
          "fondetsNavn": "Aksjefondet RST",
          "isinnummer": "NO5107125899",
          "antallAndeler": 110.759,
          "skattepliktigUtbytte": 5,
          "skattepliktigGevinstVedRealisasjonAvAndelIAksjedel": 20708,
          "oppgavegiversOrganisasjonsnummer": "212717622",
          "oppgavegiversNavn": "DEDIKERT SAMARBEIDSVILLIG TIGER AS",
          "verdiFoerVerdsettingsrabattForAndelIAksjedel": 233418
        }
      ],
      "kategori": "formue"
    },
    {
      "tekniskNavn": "gevinstVedRealisasjonAvAndelIAksjedelIVerdipapirfond",
      "beloep": 20708,
      "spesifisering": [
        {
          "type": "Verdipapirfond",
          "fondetsNavn": "Aksjefondet RST",
          "isinnummer": "NO5107125899",
          "antallAndeler": 110.759,
          "skattepliktigUtbytte": 5,
          "skattepliktigGevinstVedRealisasjonAvAndelIAksjedel": 20708,
          "oppgavegiversOrganisasjonsnummer": "212717622",
          "oppgavegiversNavn": "DEDIKERT SAMARBEIDSVILLIG TIGER AS",
          "verdiFoerVerdsettingsrabattForAndelIAksjedel": 233418
        }
      ],
      "kategori": "inntekt"
    }
  ],
  "skjermet": false,
  "skatteoppgjoersdato": "2022-02-10"
}

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

{
  "personidentifikator": "12345678901",
  "inntektsaar": "2018",
  "grunnlag": [
    {
      "tekniskNavn": "samletFormuesverdiForFastEiendomIUtlandet",
      "beloep": 260000,
      "kategori": "formue"
    },
    {
      "tekniskNavn": "samledePaaloepteRenter",
      "beloep": 25000,
      "spesifisering": [
        {
          "type": "Konto",
          "kontonummer": "12345678903",
          "bankensNavn": "MinEnesteBank",
          "organisasjonsnummer": "123456789",
          "gjeld": 165000,
          "paaloepteRenter": 2500
        },
        {
          "type": "SkyldigRestskatt",
          "betalteForsinkelsesrenterForSamletSkyldigRestskatt": 5000,
          "samletSkyldigRestskatt": 200000
        }
      ],
      "kategori": "inntektsfradrag"
    },
    {
      "tekniskNavn": "kapitalinntektFraSkogbruk",
      "beloep": 15000,
      "kategori": "inntekt"
    },
    {
      "tekniskNavn": "samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt",
      "beloep": 350000,
      "spesifisering": [
        {
          "type": "LoennOgTilsvarendeYtelser",
          "arbeidsgiversNavn": "Matre Og Inne",
          "organisasjonsnummer": "123456789",
          "beloep": 350000
        }
      ],
      "kategori": "inntekt"
    },
    {
      "tekniskNavn": "utgifterTilPassOgStellAvHjemmevaerendeBarn",
      "beloep": 50000,
      "kategori": "inntektsfradrag"
    },
    {
      "tekniskNavn": "formuesverdiForPrimaerbolig",
      "beloep": 780000,
      "spesifisering": [
        {
          "type": "Eiendom",
          "bruksnummer": "55",
          "gaardsnummer": "39",
          "kommunenummer": "0020",
          "formuesverdi": 780000,
          "beregnetMarkedsverdiForBolig": 5200000,
          "eierandel": 50
        }
      ],
      "kategori": "formue"
    }
  ],
  "skjermet": false,
  "skatteoppgjoersdato": "2019-03-01",
  "stadie": "oppgjoer",
  "registreringstidpunkt": "2019-03-01T16:11:12.985"
}

SpesifisertSummertSkattegrunnlag2020.json

SpesifisertSummertSkattegrunnlag2018_ordinær.json

SpesifisertSummertSkattegrunnlag2018_pilot.json

SpesifisertSummertSkattegrunnlag2017.json

SpesifisertSummertSkattegrunnlag2016.json

XML

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

Dataverdier

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

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så 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. Må 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.

Samtykkeoppsett

(Gjelder bare brukere som må ha samtykke)

Tjenestekode	Parametere v/ redirect til Altinn	Eksempel parameter verdi
4628_210607	4628_210607_inntektsaar	&4628_210607_inntektsaar=2021

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 vedvarende 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.
BSA-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 spesifisert summert skattegrunnlag funnet for oppgitt identifikator og inntektsår.
SSG-009	406	Feil tilknyttet dataformat. Kun json eller xml er støttet.
SSG-010	403	Feil i forbindelse med samtykketoken.
SSG-011	410	Skattegrunnlag finnes ikke lenger.

Tags: