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/v3/utkast/{rettighetspakke}/{inntektsaar}/{personidentifikator}?gjelderPaaTidspunkt={gjelderPaaTidspunkt}

For å hente fastsatt skattemeldning:

GET https://{env}/api/formueinntekt/skattemelding/v3/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. 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/skattemelding/v3/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

{
  "personidentifikator": "28090267061",
  "inntektsaar": "2022",
  "bankLaanOgForsikring": {
    "konto": [
      {
        "id": "16a4454f4ae18e55dc7978e4ce986320c65f8d5f",
        "bankensNavn": "LYNSKARPE FERSKE MUS ASA",
        "organisasjonsnummer": "804080546",
        "kontonummer": "59398109435",
        "innskudd": {
          "beloep": 90059
        },
        "opptjenteRenter": {
          "beloep": 59
        }
      },
      {
        "id": "8965828a9ce50315ebf692fbb9dd88a49f0ac21e",
        "bankensNavn": "LIVLIGE IDEELLE SÅPEBOBLER ORGL",
        "organisasjonsnummer": "862275756",
        "kontonummer": "8631607",
        "prosentandelAvGjeldOgPaaloepteRenter": 100.0,
        "gjeld": {
          "beloep": 170583
        },
        "andelAvGjeld": {
          "beloep": 170583
        }
      }
    ],
    "boligsparingForUngdom": {
      "innberettetSparebeloepTilBoligsparingForUngdomINorskBankOppspartISkattleggingsperioden": {
        "beloep": 27500
      },
      "beregnetSparebeloepTilBoligsparingForUngdomISkattleggingsperioden": {
        "fradragsberettigetBeloep": {
          "beloep": 27500
        },
        "beloepUtenHensynTilValgtPrioritertFradragstype": {
          "beloep": 27500
        }
      }
    }
  },
  "arbeidTrygdOgPensjon": {
    "loennOgTilsvarendeYtelser": {
      "arbeidsgiver": [
        {
          "id": "860252829b20a1eadfa57777b67871063119f581",
          "navn": "DYKTIGE LANGE PINKODER KOMM",
          "samledeYtelserFraArbeidsgiverPerBehandlingsart": [
            {
              "id": "b47972d1a88b540651db661074125b96be805354",
              "beloep": {
                "beloep": 1500
              },
              "antall": 8.0,
              "behandlingsart": "LONN"
            }
          ],
          "organisasjonsnummer": "936017290"
        },
        {
          "id": "326073be8c1b820e3be324a2e2090fbf74bf16a0",
          "navn": "TRISTE TRISTE MØBLER AS",
          "samledeYtelserFraArbeidsgiverPerBehandlingsart": [
            {
              "id": "7a2471c0eb2c7ae1588ee783c0847ee90e2509e2",
              "beloep": {
                "beloep": 6048
              },
              "antall": 35.0,
              "behandlingsart": "LONN"
            }
          ],
          "organisasjonsnummer": "808947633"
        },
        {
          "id": "173dcb5bf852de1e2a5b4dc076cad3dca3204f70",
          "navn": "GENIALE NYDELIGE OPPSLAGSVERK AS",
          "samledeYtelserFraArbeidsgiverPerBehandlingsart": [
            {
              "id": "acbbd83cfc72c0da873e1d52f9ac94d12dd90afc",
              "beloep": {
                "beloep": 2240
              },
              "antall": 16.0,
              "behandlingsart": "LONN"
            }
          ],
          "organisasjonsnummer": "967334022"
        },
        {
          "id": "1c131f958ea65d7a766342b46e958d3ba9a20c4d",
          "navn": "FORSTÅELIGE DIREKTE MARKISER AS",
          "samledeYtelserFraArbeidsgiverPerBehandlingsart": [
            {
              "id": "4abf9ea4b7449b68644b43fa212cb2b7f0eee93f",
              "beloep": {
                "beloep": 64413
              },
              "antall": 334.0,
              "behandlingsart": "LONN"
            }
          ],
          "organisasjonsnummer": "815023005"
        }
      ]
    },
    "minstefradragOgKostnader": [
      {
        "id": "MINSTEFRADRAG_OG_KOSTNADER_KNYTTET_TIL_ARBEID_OG_ANNEN_INNTEKT",
        "minstefradragIInntekt": {
          "fradragsberettigetBeloep": {
            "beloep": 34132
          },
          "beloepUtenHensynTilValgtPrioritertFradragstype": {
            "beloep": 34132
          }
        }
      }
    ]
  },
  "skjermet": false,
  "registreringstidspunkt": "2023-03-01T14:34:20.231+01:00",
  "opprettetDato": "2023-03-01T13:34:19.922930411+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: