Tjenesten leverer opplysninger om trukket kildeskatt på lønn for personer i kildeskatt på lønn ordningen.

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

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: Trukket kildeskatt på lønn API.

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.

URL har følgede oppbygging:

GET https://{env}/api/formueinntekt/trukketkildeskattpaaloenn/v1/{rettighetspakke}/{inntektsaar}/{personidentifikator}
  • 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.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Trukket kildeskatt på lønn API

Versjonering

Se generelle regler for versjonering.

Eksempel på respons fra tjenesten

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": "07088730296",
  "inntektsaar": 2021,
  "skjermet": false,
  "trekkinformasjonPerMaaned": [
    {
      "maaned": "2021-01",
      "grunnlagForSkattetrekk": 63427,
      "skattetrekk": 15856,
      "samletRapportertLoennsinntekt": 63427
    },
    {
      "maaned": "2021-02",
      "grunnlagForSkattetrekk": 36538,
      "skattetrekk": 9134,
      "samletRapportertLoennsinntekt": 36538
    },
    {
      "maaned": "2021-03",
      "grunnlagForSkattetrekk": 33575,
      "skattetrekk": 8225,
      "samletRapportertLoennsinntekt": 33575
    },
    {
      "maaned": "2021-04",
      "grunnlagForSkattetrekk": 15109,
      "skattetrekk": 3701,
      "samletRapportertLoennsinntekt": 15109
    },
    {
      "maaned": "2021-05",
      "grunnlagForSkattetrekk": 47487,
      "skattetrekk": 11744,
      "samletRapportertLoennsinntekt": 47487
    },
    {
      "maaned": "2021-06",
      "grunnlagForSkattetrekk": 32380,
      "skattetrekk": 8037,
      "samletRapportertLoennsinntekt": 32380
    },
    {
      "maaned": "2021-07",
      "grunnlagForSkattetrekk": 26774,
      "skattetrekk": 6674,
      "samletRapportertLoennsinntekt": 26774
    },
    {
      "maaned": "2021-08",
      "grunnlagForSkattetrekk": 26031,
      "skattetrekk": 6377,
      "samletRapportertLoennsinntekt": 26031
    },
    {
      "maaned": "2021-09",
      "grunnlagForSkattetrekk": 40809,
      "skattetrekk": 10000,
      "samletRapportertLoennsinntekt": 40809
    },
    {
      "maaned": "2021-10",
      "grunnlagForSkattetrekk": 43997,
      "skattetrekk": 10884,
      "samletRapportertLoennsinntekt": 43997
    },
    {
      "maaned": "2021-11",
      "grunnlagForSkattetrekk": 33590,
      "skattetrekk": 8502,
      "samletRapportertLoennsinntekt": 33590
    },
    {
      "maaned": "2021-12",
      "grunnlagForSkattetrekk": 43633,
      "skattetrekk": 10907,
      "samletRapportertLoennsinntekt": 43633
    }
  ]
}

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml:

<?xml version='1.0' encoding='UTF-8'?>
<trukketKildeskattPaaLoenn xmlns="urn:no:skatteetaten:datasamarbeid:TrukketKildeskattPaaLoenn:v1">
  <personidentifikator>25860299472</personidentifikator>
  <inntektsaar>2021</inntektsaar>
  <skjermet>false</skjermet>
  <trekkinformasjonPerMaaned>
    <maaned>2021-01</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-02</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-03</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-04</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-05</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-06</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-07</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-08</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-09</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-10</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-11</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
  <trekkinformasjonPerMaaned>
    <maaned>2021-12</maaned>
    <grunnlagForSkattetrekk>10000</grunnlagForSkattetrekk>
    <skattetrekk>2500</skattetrekk>
    <samletRapportertLoennsinntekt>10000</samletRapportertLoennsinntekt>
  </trekkinformasjonPerMaaned>
</trukketKildeskattPaaLoenn>

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": "TKL-005",
  "melding": "Du er ikke autorisert for bruk av dette endepunktet.",
  "korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}

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
TKL-001 500 Uventet feil på tjenesten.
TKL-002 500 Uventet feil i et bakenforliggende system.
TKL-003 404 Ukjent url benyttet.
TKL-004 401 Feil i forbindelse med autentisering.
TKL-005 403 Feil i forbindelse med autorisering.
TKL-006 400 Feil i forbindelse med validering av inputdata.
TKL-007 404 Ingen kildeskatt funnet på oppgitt gitt inntektsår og identifikator.
TKL-008 406 Feil tilknyttet dataformat. Kun json eller xml er støttet.
TKL-009 404 Ikke treff på oppgitt personidentifikator.
Tags: