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:skattemeldingupersonlig
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: Skattemelding upersonlig API.
Grensesnittbeskrivelse
URL har følgende oppbygging:
For å hente en fastsatt upersonlig skattemelding:
GET https://{env}/api/formueinntekt/skattemeldingupersonlig/v2/fastsatt/{rettighetspakke}/{inntektsaar}/{organisasjonsnummer}?gjelderPaaTidspunkt={gjelderPaaTidspunkt}
env
: Miljø-spesifikk adresserettighetspakke
: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakkeinntektsaar
: Inntektsåret man spør om informasjon for, i formatet YYYY.organisasjonsnummer
: Organisasjonsnummeret man spør etter informasjon om.gjelderPaaTidspunkt
: Returnerer skattemeldingen som gjelder pr. angitt tidspunkt. Feltet er ikke påkrevd.
Open Api Specification
Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Skattemelding upersonlig API
Støttetjenester
Hendelsesliste
For å følge med på endringer i fastsatte upersonlige skattemeldinger tilbyr vi en hendelsesliste. URL er:
GET https://{env}/api/formueinntekt/skattemeldingupersonlig/fastsatt/hendelser/
Versjonering
Se generelle regler for versjonering.
Skattemelding upersonlig API følger ikke de generelle reglene for versjonering. Skattemelding upersonlig API har en egen versjon pr inntektsår. For øyeblikket leverer applikasjonen skattemelding for 2022.
Eksempel på respons fra tjenesten
Her er et eksempel på et kall med curl mot tjenesten for å hente fastsatt skattemelding. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.
$ curl -v -H "Authorization: Bearer <maskinporten_token>" "https://api-test.sits.no/api/formueinntekt/skattemeldingupersonlig/v2/fastsatt/ssb/2022/210962492"
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
{
"norskIdentifikator": "824889880",
"inntektsaar": "2022",
"spesifikasjonAvSkattefradragForKostnaderTilForskningOgUtvikling": {
"forskningOgUtviklingsprosjekt": [
{
"id": "1c9c453c-a54a-4193-8a0e-e491bda1d5a5",
"prosjektnummer": 1,
"prosjekttittel": "2",
"prosjektperiode": {
"start": "2022-04-27",
"slutt": "2022-11-03"
},
"prosjektstatus": {
"status": "8"
},
"prosjektkategori": "forskning",
"samledeKostnaderTidligereAar": 32432,
"skattefradragForKostnaderTilForskningOgUtvikling": {
"nettoSkattefradragFoerAvkortingMotAnnenOffentligStoette": 0,
"tilleggIBeregnetSkattPerProsjekt": 0
},
"annenOffentligStoette": {
"virksomhetskategori": "liten",
"harOmfattendeSpredningGjennomKonferanserPublikasjonerMv": false,
"samletBruttoOffentligStoetteIProsjektperioden": 0
},
"samledeKostnaderIHeleProsjektperioden": 32432,
"maksimalGodkjentOffentligStoetteSomAndelAvTotalkostnad": 70.0,
"vurderingAvOekonomiskeVanskeligheter": {
"varIOekonomiskeVanskeligheterPaaSoeknadstidspunktet": false
},
"maksimaltGodkjentBruttobeloepForOffentligStoette": 22702
},
{
"id": "22ceb123-0f28-4de8-8e5c-dc22c4511a99",
"prosjektnummer": 1,
"prosjekttittel": "Me",
"prosjektperiode": {
"start": "2022-09-28",
"slutt": "2022-12-08"
},
"prosjektstatus": {
"dato": "2023-02-09",
"status": "4"
},
"prosjektkategori": "forskning",
"samledeKostnaderTidligereAar": 0,
"samletBruttoSkattefradragFraTidligereAar": 0,
"kostnadIInntektsaaret": {
"kostnad": 50000,
"heravPersonalkostnad": 677,
"antallEgneTimer": 776
},
"skattefradragForKostnaderTilForskningOgUtvikling": {
"nettoSkattefradragFoerAvkortingMotAnnenOffentligStoette": 9500,
"skattefradragPerProsjekt": 9500
},
"erSamarbeidsprosjektMellomFlereVirksomheter": false,
"annenOffentligStoette": {
"virksomhetskategori": "liten",
"harOmfattendeSpredningGjennomKonferanserPublikasjonerMv": false,
"offentligStoetteSomRedusertArbeidsgiveravgift": 677,
"samletBruttoOffentligStoetteIProsjektperioden": 677
},
"samledeKostnaderIHeleProsjektperioden": 50000,
"maksimalGodkjentOffentligStoetteSomAndelAvTotalkostnad": 70.0,
"vurderingAvOekonomiskeVanskeligheter": {
"varIOekonomiskeVanskeligheterPaaSoeknadstidspunktet": false,
"grunnlagsdokumentasjon": "aarsregnskap"
},
"maksimaltGodkjentBruttobeloepForOffentligStoette": 35000
}
],
"samletTotalkostnad": 50000,
"samletSkattefradrag": 9500
},
"skjermet": false,
"registreringstidspunkt": "2023-02-28T17:05:58.823951Z",
"opprettetDato": "2023-02-28T17:05:58.259609725+01:00"
}
XML
For svar på XML format, sett header Accept
til application/xml
:
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. 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": "SMU-006",
"melding": "Oppgitt inntektsaar er ikke støttet.",
"korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}
XML
Dersom Accept
-header er satt til application/xml
vil også eventuell feilmelding være i XML.
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 |
---|---|---|
SMU-001 | 500 | Uventet feil på tjenesten. |
SMU-002 | 500 | Uventet feil i et bakenforliggende system. |
SMU-003 | 404 | Ukjent url benyttet. |
SMU-004 | 401 | Feil i forbindelse med autentisering. |
SMU-005 | 403 | Feil i forbindelse med autorisering. |
SMU-006 | 400 | Feil i forbindelse med validering av inputdata. |
SMU-007 | 404 | Ingen skattemelding funnet på oppgitt gitt inntektsår og identifikator. |
SMU-008 | 406 | Feil tilknyttet dataformat. Kun json eller xml er støttet. |
SMU-009 | 404 | Ingen organisasjon funnet med oppgitt identifikator. |
SMU-010 | 410 | Skattemeldingen finnes ikke lenger. |