Beregnet skatt API

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:beregnetskatt

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: Beregnet skatt API.

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet. Det finnes to versjoner av tjenesten.

URL for versjon 1 har følgede oppbygging:

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

URL for versjon 2 har følgende oppbygging, og støttes for rettighetspakkene ssb og kommuneLangtidsoppholdInstitusjon:

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

• env: Miljø-spesifikk adresse
• rettighetspakke: En rettighetspakke er en kode for virksomhetens 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.

Se informasjonsmodell for beregnet skatt for hvilke felter tjenesten returnerer.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Beregnet skatt API v1, Beregnet skatt API v2

Støttetjenester

Hendelsesliste

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

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

Se felles API-dokumentasjon for hendelseslister for bruk.

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

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.

Eksempel Beregnet skatt v1

JSON

Fastland og Svalbard

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2019",
  "skjermet": false,
  "sumSaerfradrag": 123,
  "tolvdeler": 12,
  "skatteklasse": "6",
  "nettoformue": 1234500,
  "nettoinntekt": 504321,
  "utlignetSkatt": 654321,
  "formueskattStat": 5489,
  "formueskattKommune": 1111,
  "kreditfradragFormue": 852,
  "kreditfradragInntekt": 5698,
  "alminneligInntektFoerSaerfradrag": 4587,
  "skatteoppgjoersdato": "2020-04-07",
  "skatteregnskapskommune": "7015",
  "svalbardLoennLoennstrekkordningen": 54331,
  "svalbardPensjonLoennstrekkordningen": 7894,
  "svalbardLoennUtenTrygdeavgiftLoennstrekkordningen": 457,
  "svalbardNettoformue": 7896,
  "svalbardNettoinntekt": 45870,
  "svalbardUtlignetSkatt": 4258,
  "svalbardUfoeretrygdLoennstrekkordningen": 7412,
  "svalbardSkattOrdinaerAlminneligInntekt": 89547,
  "svalbardFormueskatt": 7863,
  "svalbardFastsattSkattEtterLoennstrekkordningen": 478,
  "svalbardSkatteregnskapskommune": "2222"
}

Kildeskatt på lønn (kpl)

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2019",
  "skjermet": false,
  "kildeskattPaaLoennNettoinntekt": 12345,
  "kildeskattPaaLoennNettoformue": 0,
  "kildeskattPaaLoennBetaltSkattOgAvgift": 11973,
  "kildeskattPaaLoennPersoninntektLoenn": 24587,
  "kildeskattPaaLoennPersoninntektBarePensjonsdel": 123,
  "kildeskattPaaLoennSkatteregnskapskommune": "2312",
  "kildeskattPaaLoennSkatteklasse": "1"
}

XML

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

<beregnetSkatt xmlns="no:skatteetaten:datasamarbeid:beregnetskatt:v1">
   <personidentifikator>12899699481</personidentifikator>
   <inntektsaar>2020</inntektsaar>
   <tolvdeler>12</tolvdeler>
   <skatteklasse>1</skatteklasse>
   <nettoformue>2455120</nettoformue>
   <nettoinntekt>1367403</nettoinntekt>
   <utlignetSkatt>518063</utlignetSkatt>
   <skjermet>false</skjermet>
   <formueskattStat>1433</formueskattStat>
   <formueskattKommune>6686</formueskattKommune>
   <alminneligInntektFoerSaerfradrag>1367403</alminneligInntektFoerSaerfradrag>
   <skatteoppgjoersdato>2021-09-14</skatteoppgjoersdato>
   <skatteregnskapskommune>5421</skatteregnskapskommune>
</beregnetSkatt>

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. I enkelte tilfeller kan forespørsler stoppes i infrastrukturen før den når applikasjonen. I disse tilfellene kan det forekomme feilmeldinger som ikke følger formatet oppgitt ovenfor.

JSON

{
      "kode": "BSA-002",
      "melding": "Uventet feil i bakenforliggende applikasjon, prøv igjen senere.",
      "korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}

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.