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:pensjonsgivendeinntekt
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: Pensjonsgivendeinntekt API.
Grensesnittbeskrivelse
Tjeneste for Pensjonsgivende inntekt for skattepliktige.
Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.
URL-en har følgede oppbygging:
GET https://{env}/api/formueinntekt/pensjonsgivendeinntekt/{inntektsaar}/{personidentifikator}
env
: Miljø-spesifikk adresseinntektsaar
: Inntektsåret man spør om informasjon for, i formatet YYYY. Tjenesten støtter inntektsår 2016 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: Pensjonsgivendeinntekt API
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/
Se felles API-dokumentasjon for hendelseslister for bruk.
Versjonering
Se 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": "12345678901",
"inntektsaar": "2020",
"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
:
<pensjonsgivendeInntekter xmlns="urn:no:skatteetaten:datasamarbeid:pensjonsgivendeinntekt:v1">
<personidentifikator>12345678901</personidentifikator>
<inntektsaar>2020</inntektsaar>
<pensjonsgivendeInntekt>100000</pensjonsgivendeInntekt>
<pensjonsgivendeInntektFastland>50000</pensjonsgivendeInntektFastland>
<pensjonsgivendeInntektSvalbard>50000</pensjonsgivendeInntektSvalbard>
</pensjonsgivendeInntekter>
Feilmeldinger (HTTP status ikke 200)
Hvis statuskode ikke er 200 eller 2001, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. I enkelte tilfeller kan forespørsler stoppes i infrastrukturen før den når applikasjonen. I disse tilfellene kan det forekomme feilmeldinger som ikke følger formatet oppgitt ovenfor.
JSON
{
"kode": "PIA-005",
"melding": "Du er ikke autorisert for tilgang til den forespurte ressursen.",
"korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}
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.
Feilkode | HTTP Statuskode | Feilområde |
---|---|---|
PIA-001 | 500 | Uventet feil på tjenesten. |
PIA-002 | 500 | Uventet feil i et bakenforliggende system. |
PIA-003 | 404 | Ukjent url benyttet. |
PIA-004 | 401 | Feil i forbindelse med autentisering. |
PIA-005 | 403 | Feil i forbindelse med autorisering. |
PIA-006 | 400 | Feil i forbindelse med validering av inputdata. |
PIA-007 | 404 | Ikke treff på oppgitt personidentifikator. |
PIA-008 | 404 | Ingen pensjonsgivende inntekt funnet på oppgitt personidentifikator og inntektsår. |
PIA-009 | 406 | Feil tilknyttet dataformat. Kun json eller xml er støttet. |