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.
| Grensesnitt | Støtte |
|---|---|
| Web portal | Ja |
| Maskin til maskin | Api spec |
| Innbyggertjeneste | Gyldige tjenesteområde for rollen | Beregningstype |
|---|---|---|
| Redusert foreldrebetaling SFO/barnehage | Foreldrebetaling SFO/barnehage | BARNEHAGE_SFO |
| Praktisk bistand og opplæring | Helse og omsorg: Praktisk bistand | PRAKTISK_BISTAND |
| Langtidsopphold institusjon | Helse og omsorg: Langtidsopphold institusjon | LANGTIDSOPPHOLD_INSTITUSJON |
For å bruke API-ene, både proxy og vårt overbygg, må rollen som opprettes være i rett tjenesteområde.
OBS: BARNEHAGE_SFO er foreløpig ikke tilgjengelig i dette API-et, men er fortsatt tilgjengelig i det eldre API-et.
| 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.
Vi har laget vårt eget overbygg som gir mulighet for å søke på flere personer. Vi søker om personene har stadie OPPGJØR. Ved redusert foreldrebetaling SFO/barnehage, søkes det også etter UTKAST dersom de ikke har OPPGJØR. 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.
Swagger dokumentasjon for overbygg finner du her. Bruk også dokumentasjon fra Skatteetaten.
Det finnes også en del ulike poster som har andre kilder enn Skatteetaten. Disse kan sendes med som en del av requesten, og vil da bli kalkulert sammen med data fra Skatteetaten.
For payload for POST-spørringene, se swagger dokumentasjon.
Beregning for langtidsopphold (POST)
<MILJØ_URL>/register/api/v1/ks/{rolleId}/skatteoginntektsopplysninger/beregning
Beregning for langtidsopphold som PDF (POST)
<MILJØ_URL>/register/api/v1/ks/{rolleId}/skatteoginntektsopplysninger/beregning/pdf
Beregning for praktisk bistand (POST)
<MILJØ_URL>/register/api/v1/ks/{rolleId}/skatteoginntektsopplysninger/beregning/praktisk-bistand
YAML-filer (GET)
I løsningen er postene som blir brukt i beregningen definert i YAML-filer som forteller hvordan disse behandles, f.eks. ved at verdien deres skal legges til eller trekkes fra. Disse filene er mulig å hente ut i en ZIP-fil ved å gjøre en GET-spørring mot:
<MILJØ_URL>/register/api/v1/ks/{rolleId}/skatteoginntektsopplysninger/yaml/{beregningstype}/{inntektsaar}
ZIP-filen vil inneholde to filer for den spesifiserte beregningstypen for det gitte inntektsåret. Filen med prefiks beregning innholder alle poster brukt i beregningen og grupperinger av disse. Filen med prefiks visning inneholder alle poster fra Skatteetaten og vår gruppering av disse.
Gyldige persontyper og ekstraposter (POST)
<MILJØ_URL>/register/api/v1/ks/{rolleId}/skatteoginntektsopplysninger/verdier.
| Kode | Feilmelding |
|---|---|
| SI-01 | Klarte ikke å hente navn |
| SI-02 | Du mangler rettighet i Altinn for å få informasjon om skatt til gode, restskatt og innbetalt skatt. |
Payload
{
"beregningstype":"LANGTIDSOPPHOLD_INSTITUSJON",
"inntektsaar":2023,
"personer":[
{
"identifikator":"04817299771",
"type":"SOEKER",
"ekstraposter":[
]
},
{
"identifikator":"27847099416",
"type":"PARTNER",
"ekstraposter":[
{
"tekniskNavn":"kommune.tenktEtterlattePensjon",
"beloep":0
}
]
}
]
}
Svar
{
"inntektsaar":2023,
"stadie":"OPPGJOER",
"personer":[
{
"identifikator":"04817299771",
"type":"SOEKER",
"skjermet":false,
"stadie":"OPPGJOER",
"navn":{
"etternavn":"PÅFUNN",
"fornavn":"UPERSONLIG",
"mellomnavn":null
},
"skatteoppgjoersdato":"2024-02-15",
"registreringstidpunkt":"2024-02-15T09:47:37.874Z"
},
{
"identifikator":"27847099416",
"type":"PARTNER",
"skjermet":false,
"stadie":"OPPGJOER",
"navn":{
"etternavn":"DAMESYKKEL",
"fornavn":"OPPRIKTIG",
"mellomnavn":null
},
"skatteoppgjoersdato":"2024-02-19",
"registreringstidpunkt":"2024-02-19T07:21:24.518Z"
}
],
"visningsposter":[
{
"kategori":"INNTEKT",
"poster":[
{
"personer":[
{
"identifikator":"04817299771",
"beloep":4392
},
{
"identifikator":"27847099416",
"beloep":3600
}
],
"beloep":7992,
"tekniskNavn":"avkortetFordelVedElektroniskKommunikasjon",
"visningstekst":"Fordel elektronisk kommunikasjon",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":767670
},
{
"identifikator":"27847099416",
"beloep":142622
}
],
"beloep":910292,
"tekniskNavn":"samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt",
"visningstekst":"Lønn og naturalytelser med mer",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/beregnetSkattFastland/skattOgAvgift/trygdeavgiftAvNaeringsinntekt",
"visningstekst":"Personinntekt fra næringsinntekt",
"infotekst":"Samlepost for pårørendes næringsinntekt. Se veileder for mer informasjon."
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":2163
}
],
"beloep":2163,
"tekniskNavn":"samledeOpptjenteRenterIInnenlandskeBanker",
"visningstekst":"Renter av bankinnskudd",
"infotekst":null
},
{
"personer":[
{
"identifikator":"27847099416",
"beloep":2234
}
],
"beloep":2234,
"tekniskNavn":"renteinntektAvSkadeforsikring",
"visningstekst":"Renter av skadeforsikring",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":27493
}
],
"beloep":27493,
"tekniskNavn":"utbytteFraAksje",
"visningstekst":"Aksjeutbytte",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":19795
}
],
"beloep":19795,
"tekniskNavn":"oppjustertTilleggTilUtbytteFraAksje",
"visningstekst":"Oppjustering av aksjeutbytte",
"infotekst":null
}
]
},
{
"kategori":"FRADRAG",
"poster":[
{
"personer":[
{
"identifikator":"04817299771",
"beloep":234591
}
],
"beloep":234591,
"tekniskNavn":"/beregnetSkattFastland/informasjonTilSkattelister/beregnetSkatt",
"visningstekst":"Beregnet skatt",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":8211577
},
{
"identifikator":"27847099416",
"beloep":0
}
],
"beloep":8211577,
"tekniskNavn":"/fastland/beloepTilgode",
"visningstekst":"For mye innbetalt skatt - til utbetaling",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/beregnetSkattFastland/skattOgAvgift/formuesskattTilKommune/beloep",
"visningstekst":"Formuesskatt til kommune",
"infotekst":"Kommuner som gir fradrag for formueskatt må justere denne bort. Se veileder for mer informasjon."
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/beregnetSkattFastland/skattOgAvgift/formuesskattTilStat/beloep",
"visningstekst":"Formueskatt til stat",
"infotekst":"Kommuner som gir fradrag for formueskatt må justere denne bort. Se veileder for mer informasjon."
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/beregnetSkattFastland/skattefradrag/skattefradragForFormuesskattBetaltIUtlandet",
"visningstekst":"Skattefradrag for formuesskatt betalt i utlandet",
"infotekst":"Kommuner som gir fradrag for skatt betalt i utlandet må justere denne bort. Se veileder for mer informasjon."
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/beregnetSkattFastland/skattefradrag/skattefradragForInntektsskattBetaltIUtlandet",
"visningstekst":"Skattefradrag for inntektsskatt betalt i utlandet",
"infotekst":"Kommuner som gir fradrag for skatt betalt i utlandet må justere denne bort. Se veileder for mer informasjon."
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
},
{
"identifikator":"27847099416",
"beloep":9290575
}
],
"beloep":9290575,
"tekniskNavn":"/fastland/restskatt",
"visningstekst":"Skyldig restskatt",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":0
},
{
"identifikator":"27847099416",
"beloep":0
}
],
"beloep":0,
"tekniskNavn":"/fastland/avregnetForskuddstrekk",
"visningstekst":"Sum innbetalt skatt",
"infotekst":null
},
{
"personer":[
{
"identifikator":"27847099416",
"beloep":876
}
],
"beloep":876,
"tekniskNavn":"betalteForsinkelsesrenter",
"visningstekst":"Betalte forsinkelsesrenter",
"infotekst":null
}
]
},
{
"kategori":"FORMUE",
"poster":[
{
"personer":[
{
"identifikator":"04817299771",
"beloep":108147
}
],
"beloep":108147,
"tekniskNavn":"innskudd",
"visningstekst":"Bankinnskudd",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":1135929
}
],
"beloep":1135929,
"tekniskNavn":"bruttoformue",
"visningstekst":"Bruttoformue",
"infotekst":null
}
]
},
{
"kategori":"GJELD",
"poster":[
{
"personer":[
{
"identifikator":"27847099416",
"beloep":29188
}
],
"beloep":29188,
"tekniskNavn":"samletGjeld",
"visningstekst":"Sum gjeld",
"infotekst":null
}
]
},
{
"kategori":"ANNET",
"poster":[
{
"personer":[
{
"identifikator":"04817299771",
"beloep":717063
},
{
"identifikator":"27847099416",
"beloep":80318
}
],
"beloep":797381,
"tekniskNavn":"alminneligInntektFoerSaerfradrag",
"visningstekst":"Alminnelig inntekt før særfradrag",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":104450
},
{
"identifikator":"27847099416",
"beloep":67262
}
],
"beloep":171712,
"tekniskNavn":"minstefradragIInntekt",
"visningstekst":"Minstefradrag i egen inntekt",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":821513
},
{
"identifikator":"27847099416",
"beloep":148456
}
],
"beloep":969969,
"tekniskNavn":"sumInntekterIAlminneligInntektFoerFordelingsfradrag",
"visningstekst":"Sum inntekter",
"infotekst":null
},
{
"personer":[
{
"identifikator":"04817299771",
"beloep":1284727
}
],
"beloep":1284727,
"tekniskNavn":"verdiFoerVerdsettingsrabattForAksje",
"visningstekst":"Aksjer",
"infotekst":null
}
]
}
],
"beregningsbeloep":567127,
"inntekt":{
"beloep":801718,
"beregning":[
{
"tekniskNavn":"arbeidsinntekt",
"visningstekst":"Arbeidsinntekt",
"beloep":772062,
"operasjon":"ADDERE",
"type":"POST",
"beregningsgrunnlag":[
],
"beregningsposter":[
{
"tekniskNavn":"samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt",
"visningstekst":"Lønn og naturalytelser med mer",
"operasjon":"ADDERE",
"beloep":767670,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"04817299771",
"infotekst":null,
"eksempeltekst":null
},
{
"tekniskNavn":"avkortetFordelVedElektroniskKommunikasjon",
"visningstekst":"Fordel elektronisk kommunikasjon",
"operasjon":"ADDERE",
"beloep":4392,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"04817299771",
"infotekst":null,
"eksempeltekst":null
}
]
},
{
"tekniskNavn":"renteinntekt",
"visningstekst":"Renteinntekt",
"beloep":2163,
"operasjon":"ADDERE",
"type":"POST",
"beregningsgrunnlag":[
],
"beregningsposter":[
{
"tekniskNavn":"samledeOpptjenteRenterIInnenlandskeBanker",
"visningstekst":"Renter av bankinnskudd",
"operasjon":"ADDERE",
"beloep":2163,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"04817299771",
"infotekst":null,
"eksempeltekst":null
}
]
},
{
"tekniskNavn":"avkastningFormue",
"visningstekst":"Avkastning av formue",
"beloep":27493,
"operasjon":"ADDERE",
"type":"POST",
"beregningsgrunnlag":[
],
"beregningsposter":[
{
"tekniskNavn":"utbytteFraAksje",
"visningstekst":"Aksjeutbytte",
"operasjon":"ADDERE",
"beloep":27493,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"04817299771",
"infotekst":null,
"eksempeltekst":null
}
]
}
]
},
"fradrag":{
"beloep":234591,
"beregning":[
{
"tekniskNavn":"skatt",
"visningstekst":"Skatt",
"beloep":234591,
"operasjon":"ADDERE",
"type":"GRUNNLAG",
"beregningsgrunnlag":[
{
"tekniskNavn":"beregnetSkatt",
"visningstekst":"Beregnet skatt",
"beloep":234591,
"operasjon":"ADDERE",
"beregningsposter":[
{
"tekniskNavn":"/beregnetSkattFastland/informasjonTilSkattelister/beregnetSkatt",
"visningstekst":"Beregnet skatt",
"operasjon":"ADDERE",
"beloep":234591,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"04817299771",
"infotekst":null,
"eksempeltekst":null
}
]
}
],
"beregningsposter":[
]
},
{
"tekniskNavn":"forsorgerfradrag",
"visningstekst":"Forsørgerfradrag",
"beloep":0,
"operasjon":"ADDERE",
"type":"GRUNNLAG",
"beregningsgrunnlag":[
{
"tekniskNavn":"mellomregningPaarorende",
"visningstekst":"Forsørgerfradrag OPPRIKTIG DAMESYKKEL (PARTNER)",
"beloep":0,
"operasjon":"ADDERE",
"beregningsposter":[
{
"tekniskNavn":"kommune.tenktEtterlattePensjon",
"visningstekst":"Tenkt etterlattepensjon",
"operasjon":"ADDERE",
"beloep":0,
"kilde":"MANUELL_INPUT",
"kanEndreVisningstekst":false,
"identifikator":"27847099416",
"infotekst":null,
"eksempeltekst":"Tenkt etterlattepensjon beregnes etter reglene i egenandelsforskriften. Hvis etterlattepensjon ikke er aktuelt, fyller du inn 0."
},
{
"tekniskNavn":"avkortetFordelVedElektroniskKommunikasjon",
"visningstekst":"Fordel elektronisk kommunikasjon",
"operasjon":"SUBTRAHERE",
"beloep":3600,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"27847099416",
"infotekst":null,
"eksempeltekst":null
},
{
"tekniskNavn":"samletLoennsinntektMedTrygdeavgiftspliktOgMedTrekkplikt",
"visningstekst":"Lønn og naturalytelser med mer",
"operasjon":"SUBTRAHERE",
"beloep":142622,
"kilde":"SKATTEETATEN",
"kanEndreVisningstekst":false,
"identifikator":"27847099416",
"infotekst":null,
"eksempeltekst":null
}
]
}
],
"beregningsposter":[
]
}
]
},
"soeketidspunkt":"2024-08-13T13:47:36.829089195Z",
"beregningstype":"LANGTIDSOPPHOLD_INSTITUSJON",
"feilmeldinger":[
]
}