Avregning API

Grensesnittbeskrivelse

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

URL-en har følgede oppbygging:

GET https://<env>/api/fastsetting/avregning/[<versjon>]/<rettighet>/<inntektsaar>/<personidentifikator>

• <env>: Miljø-spesifikk adresse
• <versjon>: Tjenesten tilbys i 2 versjoner, v1(deprekert, default) og v2.
• <rettighet>: Rettighetspakken distribusjon er eneste rettighetspakken for denne tjenesten.
• <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY. For øyeblikket er årene 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 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

Tjenesten tilbys i en overgangsperiode i 2 versjoner, v1 og v2. Versjon v1 er deprekert og vil bli avviklet. Hvis man ikke angir versjon vil man få v1.

Se også 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/fastsetting/avregning/v2/distribusjon/2019/12345678910"

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

V2

/api/fastsetting/avregning/v2/

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

V1

/api/fastsetting/avregning/v1/

{
    "personidentifikator": "12345678910",
    "inntektsaar": "2017",
    "skjermet": false,
    "skatteoppgjoersdato": "2017-07-05",
    "beloepTilgode": 10018,
    "avregnetForskuddstrekk": 4321,
    "restskatt": 1234
}

XML

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

V2

avregning.xsd V2

avregning.xml V2 (vanlig)

avregning_skjerming.xml (person med adresse-skjerming)

V1

avregning.xsd V1

avregning.xml V1 (vanlig)

avregning_skjerming.xml (person med adresse-skjerming)

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"
}

XML

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

feil.xsd

feil_detaljert.xml (eksempel)

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.