Fiks register tilbyr skatte- og inntektsopplysninger for kommunalt ansatte via et web-basert grensesnitt for innbyggere som søker om kommunale tjenester. Dette grensesnittet er også tilgjengelig som API for kommunene sine fagsystem. API-grensesnittet er ikke ferdig utviklet og endringer kan fortsatt forekomme.
Grensesnitt | Støtte |
---|---|
Web portal | Ja |
Maskin til maskin | Api spec v2 |
Innbyggertjeneste | Gyldige tjenesteområde for rollen | Beregningstype |
---|---|---|
Redusert foreldrebetaling SFO/barnehage | Foreldrebetaling SFO/barnehage | BARNEHAGE_SFO |
Kommunal bolig- og bostøtte | N/A | BOLIGSOSIALE_FORMAAL |
Praktisk bistand og opplæring | Helse og omsorg: Praktisk bistand | PRAKTISK_BISTAND |
Langtidsopphold institusjon | N/A | LANGTIDSOPPHOLD_INSTITUSJON |
For å bruke API-ene, både proxy og vårt overbygg, må rollen som opprettes være i rett tjenesteområde.
Miljø | URL |
---|---|
Test (Integrasjon) | https://api.fiks.test.ks.no |
Produksjon | https://api.fiks.ks.no |
APIene er tilgjengelig via Fiks-plattformen som proxy-tjeneste eller via vårt overbygg. Hendelseslister er ikke tilgjengelig via vår løsning pr nå og må hentes fra skatteetatens eget API.
Vi har laget vårt eget overbygg som gir mulighet for å søke på flere personer. Vi søker først om personene har stadie OPPGJØR, dersom de ikke har det søkes det etter UTKAST. Datamodellen er en sammenstilling av det som kommer fra skatteetaten sine APIer og har summert alle poster som hører sammen. For hver tjeneste finnes det en beregningstype som må sendes inn som en del av payloaden, dette erstatter behovet for å bruke rettighetspakke.
URL for fiks-api (POST): <MILJØ_URL>/register/api/v2/ks/{ROLLE_ID}/summertskattegrunnlag
Payload, se swagger dokumentasjon
Swagger dokumentasjon for overbygg finner du her. Bruk også dokumentasjon fra Skatteetaten.
Payload
{
"inntektsaar": "2021",
"beregningstype": "PRAKTISK_BISTAND",
"soekere": [{
"personidentifikator": "25851449852",
"personType": "SOEKER",
"navPoster": [{
"tekniskNavn": "nav.omsorgsloennEtterHelseOgOmsorgstjenesteloven",
"beloep": "1"
}, {
"tekniskNavn": "nav.hjelpestoenadFraFolketrygden",
"beloep": "2"
}],
"kommunePoster": [{
"visningsnavn": "Fradrag 1",
"beloep": "3"
}]
}, {
"personidentifikator": "06882949409",
"personType": "EKTEFELLE"
}]
}
Svar
{
"inntektsaar": 2021,
"stadie": "OPPGJOER",
"summertSkattegrunnlagPersoner": [{
"personidentifikator": "25851449852",
"skjermet": false,
"stadie": "OPPGJOER",
"beloep": 95427,
"grunnlag": [{
"navn": "1",
"beskrivelse": "Alminnelig inntekt før særfradrag",
"beloep": 6700,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "alminneligInntektFoerSaerfradrag",
"visningsnavn": "Alminnelig inntekt før særfradrag",
"beloep": 6700
}]
}, {
"navn": "3",
"beskrivelse": "Summerte poster oppjustert av gevinst",
"beloep": 39199,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilGevinstVedRealisasjonAvAksje",
"visningsnavn": "Oppjustering av gevinst ved salg av aksjer",
"beloep": 39199
}]
}, {
"navn": "5",
"beskrivelse": "Summerte poster oppjustering av tap",
"beloep": 39090,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilTapVedRealisasjonAvAksje",
"visningsnavn": "Oppjustering av tap ved salg av aksjer",
"beloep": 39090
}]
}, {
"navn": "4",
"beskrivelse": "Summerte poster tap",
"beloep": 88840,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "tapVedRealisasjonAvAksje",
"visningsnavn": "Tap ved salg av aksjer",
"beloep": 88840
}]
}, {
"navn": "NAV.OMSORGSLOENNETTERHELSEOGOMSORGSTJENESTELOVEN",
"beskrivelse": "Omsorgslønn etter helse- og omsorgstjenesteloven § 3-6",
"beloep": 1,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "nav.omsorgsloennEtterHelseOgOmsorgstjenesteloven",
"visningsnavn": "",
"beloep": 1
}]
}, {
"navn": "NAV.HJELPESTOENADFRAFOLKETRYGDEN",
"beskrivelse": "Hjelpestønad fra Folketrygden",
"beloep": 2,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "nav.hjelpestoenadFraFolketrygden",
"visningsnavn": "",
"beloep": 2
}]
}, {
"navn": "KOMMUNE.SKJOENNSMESSIGEFRADRAG",
"beskrivelse": "Skjønnsmessig fradrag",
"beloep": 3,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "kommune.skjoennsmessigeFradrag",
"visningsnavn": "Fradrag 1",
"beloep": 3
}]
}],
"personnavn": {
"etternavn": "APPELSIN",
"fornavn": "GLAD",
"mellomnavn": null
},
"skatteoppgjoersdato": "2022-02-10",
"registreringstidpunkt": "2022-02-10T15:32:55Z",
"skattFeilmelding": null
}, {
"personidentifikator": "06882949409",
"skjermet": false,
"stadie": "OPPGJOER",
"beloep": 6381000,
"grunnlag": [{
"navn": "1",
"beskrivelse": "Alminnelig inntekt før særfradrag",
"beloep": 6801000,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "alminneligInntektFoerSaerfradrag",
"visningsnavn": "Alminnelig inntekt før særfradrag",
"beloep": 6801000
}]
}, {
"navn": "7",
"beskrivelse": "Summerte poster oppjustering av utbytte",
"beloep": 132000,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilAndelIFellesTilleggIAlminneligInntektFraSDFInnenAnnenNaering",
"visningsnavn": "Oppjustering av tillegg i alminnelig inntekt fra selskap med deltakerfastsetting",
"beloep": 132000
}]
}, {
"navn": "2",
"beskrivelse": "Summerte gevinstposter",
"beloep": 200000,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "gevinstVedSalgAvAndelISDF",
"visningsnavn": "Gevinst ved salg mv. av andel i selskap med deltakerfastsetting",
"beloep": 200000
}]
}, {
"navn": "3",
"beskrivelse": "Summerte poster oppjustert av gevinst",
"beloep": 88000,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilGevinstVedSalgAvAndelISDF",
"visningsnavn": "Oppjustering av gevinst ved salg mv. av andel i selskap med deltakerfastsetting",
"beloep": 88000
}]
}],
"personnavn": {
"etternavn": "VEVSTOL",
"fornavn": "KONSERVATIV",
"mellomnavn": null
},
"skatteoppgjoersdato": "2022-09-26",
"registreringstidpunkt": "2022-09-26T12:21:31Z",
"skattFeilmelding": null
}],
"samletBeloep": 6476427,
"samletGrunnlag": [{
"navn": "2",
"beskrivelse": "Summerte gevinstposter",
"beloep": 200000,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "gevinstVedSalgAvAndelISDF",
"visningsnavn": "Gevinst ved salg mv. av andel i selskap med deltakerfastsetting",
"beloep": 200000
}]
}, {
"navn": "KOMMUNE.SKJOENNSMESSIGEFRADRAG",
"beskrivelse": "Skjønnsmessig fradrag",
"beloep": 3,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "kommune.skjoennsmessigeFradrag",
"visningsnavn": "Fradrag 1",
"beloep": 3
}]
}, {
"navn": "3",
"beskrivelse": "Summerte poster oppjustert av gevinst",
"beloep": 127199,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilGevinstVedSalgAvAndelISDF",
"visningsnavn": "Oppjustering av gevinst ved salg mv. av andel i selskap med deltakerfastsetting",
"beloep": 88000
}, {
"tekniskNavn": "oppjustertTilleggTilGevinstVedRealisasjonAvAksje",
"visningsnavn": "Oppjustering av gevinst ved salg av aksjer",
"beloep": 39199
}]
}, {
"navn": "NAV.HJELPESTOENADFRAFOLKETRYGDEN",
"beskrivelse": "Hjelpestønad fra Folketrygden",
"beloep": 2,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "nav.hjelpestoenadFraFolketrygden",
"visningsnavn": "",
"beloep": 2
}]
}, {
"navn": "5",
"beskrivelse": "Summerte poster oppjustering av tap",
"beloep": 39090,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilTapVedRealisasjonAvAksje",
"visningsnavn": "Oppjustering av tap ved salg av aksjer",
"beloep": 39090
}]
}, {
"navn": "1",
"beskrivelse": "Alminnelig inntekt før særfradrag",
"beloep": 6807700,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "alminneligInntektFoerSaerfradrag",
"visningsnavn": "Alminnelig inntekt før særfradrag",
"beloep": 6807700
}]
}, {
"navn": "4",
"beskrivelse": "Summerte poster tap",
"beloep": 88840,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "tapVedRealisasjonAvAksje",
"visningsnavn": "Tap ved salg av aksjer",
"beloep": 88840
}]
}, {
"navn": "NAV.OMSORGSLOENNETTERHELSEOGOMSORGSTJENESTELOVEN",
"beskrivelse": "Omsorgslønn etter helse- og omsorgstjenesteloven § 3-6",
"beloep": 1,
"operasjon": "ADDERE",
"poster": [{
"tekniskNavn": "nav.omsorgsloennEtterHelseOgOmsorgstjenesteloven",
"visningsnavn": "",
"beloep": 1
}]
}, {
"navn": "7",
"beskrivelse": "Summerte poster oppjustering av utbytte",
"beloep": 132000,
"operasjon": "SUBTRAHERE",
"poster": [{
"tekniskNavn": "oppjustertTilleggTilAndelIFellesTilleggIAlminneligInntektFraSDFInnenAnnenNaering",
"visningsnavn": "Oppjustering av tillegg i alminnelig inntekt fra selskap med deltakerfastsetting",
"beloep": 132000
}]
}],
"soeketidspunkt": "2023-04-18T10:40:26.683377065Z"
}
Det er mulig å bruke Skatteetatens delingstjeneste for skatte og inntektsopplysninger som en proxy-tjeneste i Fiks register og samtidig benytte seg av roller, rettighetsstyring og dataminimering som Fiks register tilbyr. Oppbygging av URL gjøres så likt som mulig Skatteetatens egen URL. Datamodellen forblir uendret.
URL for proxy-api (GET):
<MILJØ_URL>/skatteetaten/formueinntekt/summertskatt/api/v1/{ROLLE_ID}/{STADIE}/{RETTIGHETSPAKKE}/{INNTEKTSAAR}/{PERSONIDENTIFIKATOR}
Skatteetaten har lagt ut dokumentasjon her Summert skattegrunnlag og Swagger
{
"personidentifikator": "03870349520",
"inntektsaar": "2021",
"skjermet": false,
"grunnlag": [
{
"tekniskNavn": "samledeOpptjenteRenterIInnenlandskeBanker",
"beloep": 19015,
"kategori": ["inntekt"]
},
{
"tekniskNavn": "samletPensjonFraFolketrygden",
"beloep": 894828,
"kategori": ["inntekt"]
},
{
"tekniskNavn": "samletAvkastningAvKapitalforsikringsavtale",
"beloep": 286299,
"kategori": ["inntekt"]
}
],
"skatteoppgjoersdato": "2022-02-10",
"stadie": "oppgjoer",
"registreringstidpunkt": "2022-02-10T15:17:37Z"
}