Pensjonsgivende inntekt for folketrygden API

Sikkerhet

Denne tjenesten støtter både bruk av maskinporten og virksomhetssertifikat. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:pensjonsgivendeinntektforfolketrygden

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: Pensjonsgivende inntekt for folketrygden API.

Grensesnittbeskrivelse

Se Maskinporten for informasjon om hva som kreves for å få tilgang til grensesnittet.

URL har følgede oppbygging:

GET https://<env>/api/formueinntekt/pensjonsgivendeinntektforfolketrygden/<inntektsaar>/<personidentifikator>

• <env>: Miljø-spesifikk adresse
• <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.

Støttetjenester

Hendelsesliste

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

GET https://<env>/api/formueinntekt/pensjonsgivendeinntektforfolketrygden/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å generere et gyldig Maskinporten-token og legge til i header.

$ curl -v -H "Authorization: Bearer <maskinporten_token>" "https://api-at.sits.no/api/formueinntekt/pensjonsgivendeinntektforfolketrygden/2019/02116049964"

Suksess (HTTP status 200)

Dersom kallet lykkes får man HTTP status 200 og data i JSON-format.

JSON

{
    "norskPersonidentifikator": "02116049964",
    "inntektsaar": 2019,
    "pensjonsgivendeInntekt": [
        {
            "skatteordning": "FASTLAND",
            "datoForFastsetting": "2020-09-27",
            "pensjonsgivendeInntektAvLoennsinntekt": 698219,
            "pensjonsgivendeInntektAvLoennsinntektBarePensjonsdel": null,
            "pensjonsgivendeInntektAvNaeringsinntekt": 150000,
            "pensjonsgivendeInntektAvNaeringsinntektFraFiskeFangstEllerFamiliebarnehage": 85000
        },
        {
            "skatteordning": "SVALBARD",
            "datoForFastsetting": "2020-09-27",
            "pensjonsgivendeInntektAvLoennsinntekt": 492160,
            "pensjonsgivendeInntektAvLoennsinntektBarePensjonsdel": null,
            "pensjonsgivendeInntektAvNaeringsinntekt": 2530000,
            "pensjonsgivendeInntektAvNaeringsinntektFraFiskeFangstEllerFamiliebarnehage": null
        }
    ]
}

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": "PGIF-007",
    "melding": "Inntektsår har ikke gyldig format",
    "korrelasjonsid": "d6bcc78b-e5fb-4112-a01f-70f22a656b07"
}

Informasjonsmodell og beskrivelse av felter

Informasjonsmodell og beskrivelse av felter.

Feilkoder

Se også den generelle informasjonen om statuskoder og feilmeldinger.