Avregning 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:avregning

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

Grensesnittbeskrivelse

URL-en har følgede oppbygging:

GET https://{env}/api/fastsetting/avregning/v2/{rettighet}/{inntektsaar}/{personidentifikator}

• env: Miljø-spesifikk adresse
• rettighet: Rettighetspakken distribusjon er eneste rettighetspakken for denne tjenesten.
• inntektsaar: Inntektsåret man spør om informasjon for, i formatet YYYY. Tjenesten støtter inntektsår 2017 og utover.
• personidentifikator: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Open Api Specification

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

Støttetjenester

Hendelsesliste

For å følge med på endringer i avregning 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

I en overgangsperiode har tjenesten vært tilgjengelig i 2 versjoner, v1 og v2. V1 ble avviklet januar 2022.

Se også 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.

JSON

{
  "personidentifikator": "12345678910",
  "inntektsaar": "2020",
  "skjermet": false,
  "skatteoppgjoersdato": "2021-02-04",
  "fastland": {
    "restskatt": 2300,
    "avregnetForskuddstrekk": 90000,
    "beloepTilgode": 9271429
  },
  "svalbard": {
    "restskatt": 500,
    "avregnetForskuddstrekk": 7000,
    "beloepTilgode": 1529
  }
}

XML

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

<avregning xmlns="urn:no:skatteetaten:datasamarbeid:avregning:v2">
  <personidentifikator>12345678910</personidentifikator>
  <inntektsaar>2020</inntektsaar>
  <skjermet>false</skjermet>
  <skatteoppgjoersdato>2021-02-04</skatteoppgjoersdato>
  <fastland>
    <restskatt>2300</restskatt>
    <avregnetForskuddstrekk>90000</avregnetForskuddstrekk>
    <beloepTilgode>9271429</beloepTilgode>
  </fastland>
  <svalbard>
    <restskatt>500</restskatt>
    <avregnetForskuddstrekk>7000</avregnetForskuddstrekk>
    <beloepTilgode>1529</beloepTilgode>
  </svalbard>
</avregning>

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": "AR-011",
  "melding": "Feltet 'personidentifikator' har ugyldig format. Må være nøyaktig 11 siffer",
  "korrelasjonsid": "23a235f5-28f9-47db-9abd-ab78977c32fa"
}

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.