Skatteplikt API gir skattepliktsdata om skattepliktige personer

Grensesnittbeskrivelse

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

URL har følgede oppbygging:

GET https://<env>/api/formueinntekt/skatteplikt/<rettighetspakke>/<inntektsaar>/<personidentifikator>
  • <env>: Miljø-spesifikk adresse
  • <rettighetspakke>: Rettighetspakken distribusjon er eneste rettighetspakken for denne tjenesten
  • <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY.
  • <personidentifikator>: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.

Støttetjenester

Hendelsesliste

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

GET https://<env>/api/formueinntekt/skatteoppgjoer/hendelser/

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

Her er et eksempel på et kall 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/formueinntekt/skatteplikt/distribusjon/2017/05086900124"

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

{
    "alderIInntektsaar": 56,
    "inntektsaar": "2019",
    "personidentifikator": "23117323456",
    "saerskiltSkatteplikt": [
        "skattepliktEtterPetroleumsskatteloven"
    ],
    "skattepliktTilNorge": "global",
    "skattepliktTilSvalbard": "begrenset",
    "skattested": "1234",
    "skjermet": false
}

XML

For svar på XML format, sett header Accept til application/xml:

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/formueinntekt/skatteplikt/distribusjon/2017/05086900124"

skatteplikt.xsd

skatteplikt.xml (eksempel)

skatteplikt_skjermet.xml (skjermet eksempel)

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": "SP-002",
 "melding": "identifikator har ugyldig format. Forventet en personidentifikator på 11 siffer",
 "korrelasjonsid": "b0e88d88ab83b3cd417d2ee88a696afb"
 
}

XML

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

feil.xsd

feil.xml (eksempel)

Feilkoder

Se også felles feilkoder for alle applikasjonene.

HTTP status Feilkode Feilmelding
400 SP-001 inntektsår har ugyldig format. Forventet et år på formatet YYYY
400 SP-002 identifikator har ugyldig format. Forventet en personidentifikator på 11 siffer
400 SP-003 Det gitte inntektsåret er ikke støttet. For øyeblikket er årene 2016 og 2017 støttet.
404 SP-004 Fant ikke noen person for gitt personidentifikator
404 SP-005 Fant ikke noe skattepliktsdokument for gitt år og personidentifikator
500 SP-006 Feil på tjenesten. Vennligst kontakt brukerstøtte hvis problemet vedvarer

Miljøer

Miljø URL
Akseptansetest (AT) https://api-at.sits.no
Produksjon (Prod) https://api.skatteetaten.no

Ønsker du å komme i kontakt med oss for spørsmål eller andre henvendelser, se veiledning på Skatteetaten.no.

Tags: