Tjenesten leverer informasjon som fremkommer i skattemelding for en person.

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: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ølgende 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.
  • 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.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Skattemelding API

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 -H "Authorization: Bearer <maskinporten_token>" "https://api-test.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.

JSON

{
  "skjermet": false,
  "registreringstidspunkt": "2022-02-10T14:47:12.249+01:00",
  "personidentifikator": "16922048030",
  "inntektsaar": "2021",
  "bankLaanOgForsikring": {
    "forsikring": {
      "livsforsikring": [
        {
          "id": "72540f62c52341999c5340327baa4568f521aee1",
          "livsforsikringsselskapetsNavn": "DY PSINDIG UFRUKTBAR LEOPARD ASA",
          "livsforsikringsselskapetsOrganisasjonsnummer": "310091995",
          "forsikringsnummer": "762724741",
          "avkastningAvKapitalforsikringsavtale": {
            "beloep": 139013.0
          },
          "gjenkjoepsverdiAvKapitalforsikringsavtale": {
            "beloep": 8109780.0
          }
        }
      ]
    },
    "konto": [
      {
        "id": "8e0e4f87a91c40e660720bdc313bd83efdaf354e",
        "bankensNavn": "UNGT SOSIAL ISBJØRN SA",
        "organisasjonsnummer": "313032604",
        "kontonummer": "96702145306",
        "innskudd": {
          "beloep": 121471.0
        },
        "opptjenteRenter": {
          "beloep": 2429.0
        }
      }
    ]
  },
  "arbeidTrygdOgPensjon": {
    "loennOgTilsvarendeYtelser": {
      "arbeidsgiver": [
        {
          "id": "e83af408065bad1e2cd32afc114c837deee9486a",
          "navn": "PRESIS TYPISK TIGER AS",
          "samledeYtelserFraArbeidsgiverPerBehandlingsart": [
            {
              "id": "4109138e9208ce98add8b1eb78f8ed9419a47899",
              "beloep": {
                "beloep": 52260.0
              },
              "behandlingsart": "LONN"
            },
            {
              "id": "278a1b82176fb19892c271994dc148bd27419f2d",
              "beloep": {
                "beloep": 6000.0
              },
              "behandlingsart": "EL_KOMMUNIKASJON"
            }
          ],
          "organisasjonsnummer": "313994678"
        }
      ],
      "avkortetFordelVedElektroniskKommunikasjon": [
        {
          "id": "61b00ee66af66f5b824a64828b771c12da1a7c88",
          "beloep": {
            "beloep": 4392
          }
        }
      ]
    },
    "minstefradragOgKostnader": [
      {
        "id": "MINSTEFRADRAG_OG_KOSTNADER_KNYTTET_TIL_ARBEID_OG_ANNEN_INNTEKT",
        "minstefradragIInntekt": {
          "fradragsberettigetBeloep": {
            "beloep": 31800
          },
          "beloepUtenHensynTilValgtPrioritertFradragstype": {
            "beloep": 31800
          }
        }
      }
    ]
  },
  "opprettetDato": "2022-02-10T13:47:11.993+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": "SM-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
SM-001 500 Uventet feil på tjenesten.
SM-002 500 Uventet feil i et bakenforliggende system.
SM-003 404 Ukjent url benyttet.
SM-004 401 Feil i forbindelse med autentisering.
SM-005 403 Feil i forbindelse med autorisering.
SM-006 400 Feil i forbindelse med validering av inputdata.
SM-007 404 Ingen skattemelding funnet på oppgitt gitt inntektsår og identifikator.
SM-008 406 Feil tilknyttet dataformat. Kun json eller xml er støttet.
SM-009 404 Ingen person funnet med oppgitt identifikator.
SM-010 410 Skattemeldingen finnes ikke lenger.
Tags: