Pensjonsgivende inntekt for skattepliktige

Grensesnittbeskrivelse

Tjeneste for Pensjonsgivende inntekt for skattepliktige.

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

URL-en har følgede oppbygging:

GET https://<env>/api/formueinntekt/pensjonsgivendeinntekt/<inntektsaar>/<personidentifikator>
  • <env>: Miljø-spesifikk adresse
  • <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY. For øyeblikket er årene 2015, 2016, 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 pensjonsgivende intekt 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å 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/formueinntekt/pensjonsgivendeinntekt/2016/12345678901"

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": "12345678901",
  "inntektsaar": "2019",
  "pensjonsgivendeInntekt": 100000,
  "pensjonsgivendeInntektFastland": 50000,
  "pensjonsgivendeInntektSvalbard": 50000
}

XML

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

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/formueinntekt/pensjonsgivendeinntekt/2016/12345678901"

pgi.xsd

pgi.xml (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": "PIA-003",
 "melding": "Du er ikke autorisert for bruk av dette endepunktet."
}

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å den generelle informasjonen om statuskoder og feilmeldinger.

HTTP status Feilkode Feilmelding
400 PIA-001 Fant ikke autentiseringstoken
401 PIA-002 Autentisering feilet
403 PIA-003 Du er ikke autorisert for bruk av dette endepunktet.
500 PIA-004 Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte!
400 PIA-005 Det forespurte inntektsåret er ikke støttet
404 PIA-006 Fant ikke PGI for gitt inntektsår og identifikator
400 PIA-007 Ugyldig format på inntektsår. Forventet et år på formatet YYYY
400 PIA-008 Ugyldig format på identifikator. Forventet et 11-sifret nummer.

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: