Skatteplikt 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:skatteplikt

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: Skatteplikt API.

Grensesnittbeskrivelse

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

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

I Open API spesifikasjonen ligger URL til tjenesten og beskrivelsen av parameterene.

Støttetjenester

Hendelsesliste

For å følge med på endringer i Skatteplikt tilbyr vi en hendelsesliste: Skatteoppgjør hendelser

Se felles API-dokumentasjon for hendelseslister for bruk og lenke til Open API spesifikasjonen.

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

For mer detaljerte eksempler se Open API spesifikasjonen.

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. Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml:

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200 eller 201, men man får svar fra applikasjonen, så kommer en feilmelding som vil passe beskvrivelsen i listen nedenfor. I enkelte tilfeller kan forespørsler stoppes i infrastrukturen før den når applikasjonen, og da vil feilmeldingene se andereldes ut.

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.