Spesifisert summert skattegrunnlag API

Spesifisert summert skattegrunnlag inneholder summert informasjon om en skatteyters inntekt, formue og fradrag og formuesfradrag, med spesifikasjoner.

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: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 spesifisertsummertskattegrunnlag. URL-ene har følgede oppbygging:

GET https://<env>/api/formueinntekt/spesifisertsummertskattegrunnlag/<rettighetspakke>/<inntektsaar>/<personidentifikator>

GET https://<env>/api/formueinntekt/spesifisertsummertskattegrunnlag/<stadie>/<rettighetspakke>/<inntektsaar>/<personidentifikator>

<env>: Miljø-spesifikk adresse
<stadie>: Hvilket stadie man ønsker oppslag på utkast og oppgjoer.
<rettighetspakke>: En av rettighetspakke sbl, sivilrett, husbanken og saernamsmann.
<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 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 --cert datakonsument.cer --key datakonsument.key -H "AltinnSamtykke: <samtykke>" "https://api-at.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 forkortet respons for inntektsår 2018 uten oppgitt stadie i JSON. Et eksempel på en fullstending respons finnes på lenke under.

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

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

SpesifisertSummertSkattegrunnlag.xsd

Eksempler på respons:

SpesifisertSummertSkattegrunnlag2020.xml

SpesifisertSummertSkattegrunnlag2020_nyLøype.xml

SpesifisertSummertSkattegrunnlag2020_gammelLøype.xml

SpesifisertSummertSkattegrunnlag2018_ordinær.xml

SpesifisertSummertSkattegrunnlag2018_pilot.xml

SpesifisertSummertSkattegrunnlag2017.xml

SpesifisertSummertSkattegrunnlag2016.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:

feil.xsd

SpesifisertSummertSkattegrunnlag_feil.xml (eksempel)

Samtykkeoppsett

(Gjelder bare brukere som må ha samtykke)

Tjenestekode	Parametere v/ redirect til Altinn	Eksempel parameter verdi
4628_1	4628_1_inntektsaar	&4628_1_inntektsaar=2016

Feilkoder

Se også felles feilkoder for alle applikasjonene.

Feilkode	HTTP Statuskode	Feilmelding
SSG-007	404	Fant ikke gitt personidentifikator
SSG-008	404	Det finnes ikke skattegrunnlag for gitt personidentifikator og år
SSG-010	400	Obligatorisk felt ‘personidentifikator’ mangler.
SSG-011	400	Feltet ‘personidentifikator’ har ugyldig format. Må være nøyaktig 11 siffer
SSG-013	400	Obligatorisk felt ‘inntektsaar’ mangler.
SSG-014	400	Angitt inntektsaar er ikke støttet.
SSG-015	400	Feil med samtykke signatur. Kunne ikke finne rett sertifikat for validering
SSG-016	400	Samtykke er utgått på tid.
SSG-017	500	Kunne ikke aksessere Altinn truststore. Ta kontakt med brukerstøtte hvis problemet vedvarer
SSG-018	500	Inkonsistens i data. Fant flere skattegrunnlag for gitt personidentifikator og år
SSG-019	400	Feil med validering av samtykke fra Altinn. Kan ikke verifisere samtykke
SSG-021	400	Feil med signatur av samtykke fra Altinn. Kan ikke verifisere samtykke
SSG-027	500	Skattyter har skjermingskode som ikke kan tolkes. Kontakt brukerstøtte
SSG-028	500	En uventet feil oppsto under validering av samtykke. Vennligst kontakt brukerstøtte
SSG-101	400	validering av samtykke feilet med feilmelding:
SSG-102	400	Det skjedde en feil i forbindelse med maskinporten autentisering: token ugyldig.
SSG-103	400	Ingen JWT token i forespoersel
SSG-104	400	Token inneholder ikke claims.
SSG-034	410	Skattegrunnlaget finnes ikke lenger.

Tags: