Tilleggsskatt 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:tilleggsskatt

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.

URL har følgede oppbygging:

GET https://{env}/api/formueinntekt/tilleggsskatt/v1/{rettighetspakke}/{inntektsaar}/{identifikator}

• env: Miljø-spesifikk adresse
• rettighetspakke: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakke
• inntektsaar: Inntektsåret man spør om informasjon for, i formatet YYYY. Tjenesten støtter inntektsår fra og med 2020.
• identifikator: Hvilket fødselsnummer/D-nummer eller organisasjonsnummer man spør om informasjon for.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Tilleggsskatt API

Versjonering

Se generelle regler for versjonering.

Støttetjenester

Hendelsesliste

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

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

Se felles API-dokumentasjon for hendelseslister for bruk.

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.

JSON

{
  "personidentifikator":"07891448702",
  "inntektsaar":"2021",
  "skjermet":false,
  "vedtakOmTilleggsskatt": [
      {
        "skattekommune":"4621",
        "tilleggsskattFraUriktigeOpplysninger":50004.0,
        "vedtaksdatoForTilleggsskatt":"2022-06-01"
      }
  ]
}

XML

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

<?xml version='1.0' encoding='UTF-8'?>
<tilleggsskatt xmlns="urn:no:skatteetaten:datasamarbeid:tilleggsskatt:v1">
  <personidentifikator>07891448702</personidentifikator>
  <inntektsaar>2021</inntektsaar>
  <skjermet>false</skjermet>
  <vedtakOmTilleggsskatt>
    <skattekommune>4621</skattekommune>
    <tilleggsskattFraUriktigeOpplysninger>50004.0</tilleggsskattFraUriktigeOpplysninger>
    <vedtaksdatoForTilleggsskatt>2022-06-01</vedtaksdatoForTilleggsskatt>
  </vedtakOmTilleggsskatt></tilleggsskatt>

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": "TSA-008",
      "melding": "Fant ikke tilleggskatt for oppgitt identifikator.",
      "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.