Beregnetskatt API

Grensesnittbeskrivelse

For å bruke grensesnittet kreves autentisering med X.509-sertifikat.

URL har følgede oppbygging:

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

• <env>: Miljø-spesifikk adresse
• <rettighetspakke>: En av rettighetspakkene distribusjon, pensjonskasse, laanekassen og nav. Se informasjonsmodell for beregnet skatt for hvilke felter tjenesten returnerer.
• <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY. For øyeblikket er årene 2015, 2016, 2017, 2018 og 2019 støttet.
• <personidentifikator>: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Støttetjenester

Hendelsesliste

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

GET https://<env>/api/formueinntekt/skatteoppgjoer/hendelser/

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

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 "https://api-at.sits.no/api/formueinntekt/beregnetskatt/distribusjon/2015/05086900124"

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. Hvilke felter som kan forekomme kommer an på hvilken rettighetspakke som er brukt. Se informasjonsmodell for beregnet skatt.

JSON

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2019",
  "sumSaerfradrag": 123,
  "tolvdeler": 12,
  "skatteklasse": "6",
  "nettoformue": 12345,
  "nettoinntekt": 54321,
  "utlignetSkatt": 654321,
  "svalbardLoennLoennstrekkordningen": 54331,
  "svalbardPensjonLoennstrekkordningen": 431,
  "svalbardLoennUtenTrygdeavgiftLoennstrekkordningen": 321,
  "svalbardNettoformue": 321,
  "svalbardNettoinntekt": 321,
  "svalbardUtlignetSkatt": 321,
  "svalbardUfoeretrygdLoennstrekkordningen": 321,
  "skjermet": false,
  "formueskattStat": 321,
  "formueskattKommune": 321,
  "kreditfradragFormue": 321,
  "kreditfradragInntekt": 321,
  "alminneligInntektFoerSaerfradrag": 321,
  "skatteoppgjoersdato": "2020-04-07",
  "skatteregnskapskommune": "7015",
  "svalbardSkattOrdinaerAlminneligInntekt": 321,
  "svalbardFormueskatt": 321,
  "svalbardFastsattSkattEtterLoennstrekkordningen": 321
}

XML

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

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/formueinntekt/beregnetskatt/distribusjon/2015/05086900124"

beregnetskatt.xsd

beregnetskatt_eksempel.xml

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": "BSA-006",
 "melding": "Fant ikke Beregnet Skatt for gitt inntektsår og identifikator",
 "korrelasjonsid": "13a865f5-28f9-47db-9abd-ab78977c79fe"
 
}

XML

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

feil.xsd

feil eksempel.xml

Feilkoder

Se også felles feilkoder for alle applikasjonene.

Miljøer

Ønsker du å komme i kontakt med oss for spørsmål eller andre henvendelser, se veiledning på Skatteetaten.no.