API for utkast til skattemelding og fastsatt skattemelding. Utkastet er et forslag til skattemelding Skatteetaten har laget for den skattepliktige basert på innrapporterte data. Fastsatt betyr at skattemeldingen er myndighetsfastsatt, manuelt innlevert, eller automatisk innlevert ved utløp av innleveringsfrist

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:skattemelding

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 API.

Grensesnittbeskrivelse

URL har følgede oppbygging:

For å hente utkast til skattemelding:

GET https://<env>/api/formueinntekt/skattemelding/utkast/<rettighetspakke>/<inntektsaar>/<personidentifikator>?gjelderPaaTidspunkt=<gjelderPaaTidspunkt>

For å hente fastsatt skattemeldning:

GET https://<env>/api/formueinntekt/skattemelding/fastsatt/<rettighetspakke>/<inntektsaar>/<personidentifikator>?gjelderPaaTidspunkt=<gjelderPaaTidspunkt>
  • <env>: Miljø-spesifikk adresse
  • <rettighetspakke>: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakke
  • <inntektsaar>: Inntektsåret man spør om informasjon for, i formatet YYYY. Foreløpig er kun inntektsår 2018 og 2019 støttet.
  • <personidentifikator>: Hvilket fødselsnummer eller D-nummer man spør om informasjon for.
  • <gjelderPaaTidspunkt>: Returnerer skattemeldingen som gjelder pr. angitt tidspunkt. Feltet er ikke påkrevd.

Støttetjenester

Hendelsesliste

For å følge med på endringer i utkast til Skattemelding tilbyr vi en hendelsesliste. URL er:

GET https://<env>/api/formueinntekt/skattemelding/utkast/hendelser/

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

GET https://<env>/api/formueinntekt/skattemelding/fastsatt/hendelser/

Se støttetjeneste - hendelsesliste for generell informasjon om bruk av hendelseslistene.

Versjonering

Se generelle regler for versjonering.

Skattemelding-api følger ikke de generelle reglene for versjonering. Skattemelding-api har en egen versjon pr inntektsår. Foreløpig leverer skattemelding-api to versjoner: 2018 og 2019. Under XML finner du XSD for inntektsårene.

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 --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/formueinntekt/skattemelding/fastsatt/ssb/2018/05086900124"

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.

XML

For svar på XML format, sett header Accept til application/xml:

$ curl -v --header "Accept: application/xml" --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/formueinntekt/skattemelding/fastsatt/ssb/2018/05086900124"

For inntektsår 2018: Skattemelding_2018.xsd

skattemelding_2018.xml (eksempel)

For inntektsår 2019: Skattemelding_2019.xsd

skattemelding_2019.xml (eksempel)

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": "SP-002",
 "melding": "identifikator har ugyldig format. Forventet en personidentifikator på 11 siffer",
 "korrelasjonsid": "b0e88d88ab83b3cd417d2ee88a696afb"
 
}

XML

Dersom Accept-header er satt til application/xml vil også eventuell feilmelding være i XML:

feil.xsd

feil.xml (eksempel)

Feilkoder

Se også felles feilkoder for alle applikasjonene.

HTTP status Feilkode Feilmelding  
404 SM-001 Fant ikke noen person for gitt personidentifikator  
404 SM-002 Fant ikke noen skattemelding for gitt år og personidentifikator  
400 SM-003 Feltet ‘rettighetspakke’ mangler eller ugyldig.  
400 SM-004 Feltet ‘prosesstype’ mangler eller ugyldig. Må være enten ‘fastsatt’ eller ‘utkast’  
400 SM-005 Obligatorisk felt ‘personidentifikator’ mangler.  
400 SM-006 Feltet ‘personidentifikator’ har ugyldig format. Må være nøyaktig 11 siffer  
400 SM-007 Obligatorisk felt ‘inntektsaar’ mangler.  
400 SM-008 Angitt inntektsaar er ikke støttet.  
400 SM-009 Ugyldig format på inntektsaar. Forventet et år på formatet YYYY.  
500 SM-010 Inkonsistens i data. Fant flere skattemeldinger for gitt år og personidentifikator  
403 SM-011 En uventet feil oppstod ved autentisering. Kontakt brukerstøtte gi
400 SM-012 Ugyldig format på gjelderPaaTidspunkt: Forventer format på ISO 8601  
410 SM-013 Skattemeldingen finnes ikke lenger  
403 SM-014 Det skjedde en feil ved maskinporten autentisering: token ugyldig.  
400 SM-015 Ingen JWT token i forespoersel  
400 SM-016 Token inneholder ikke claims.  
403 SM-017 Rettighetspakken din har ikke tilgang til angitt url. Må være …skattemelding/fastsatt/  
Tags: