Inntektsmottakere API

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

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

Grensesnittbeskrivelse

URL har følgede oppbygging:

GET https://<env>/api/innrapportert/opplysningspliktig/v1/<rettighetspakkenavn>/<opplysningspliktig>/inntektsmottakere?fraOgMed=<fraOgMed>&tilOgMed=<tilOgMed>

• <env>: Miljø-spesifikk adresse
• <rettighetspakke>: En rettighetspakkene er en kode for virksomheten sitt juridiske grunnlag for datauthenting. For mer informasjon se Rettighetspakke
• <opplysningspliktig>: Organisasjonsnummeret for opplysningsplikltig.
• <fraOgMed>: Start årstall og måned angitt i nummer, må oppgis som YYYY-MM.
• <tilOgMed>: Slutt årstall og måned angitt i nummer, må oppgis som YYYY-MM.

Lenke til informasjonsmodell: Inntektsmottakere

Versjonering

Se generelle regler for versjonering.

Begrenset til rettighetspakke otp

Datakonsumenter som henter data tildeles rettighetspakken otp.

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må ha et gyldig maskinportentoken som legges ved som headerer i curl-kommandoen.

$ curl -v -H "Authorization: Bearer <maskinporten_token>" "https://api-at.sits.no/api/innrapportert/opplysningspliktig/v1/otp/999999999/inntektsmottakere"

Spesifikasjon

Spesifikasjon for tjenesten kan lastes ned her Inntektsmottakere.json

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

 {
     "opplysningspliktig": {
         "norskIdentifikator": "910996215"
     },
     "fraOgMed": "2020-01",
     "tilOgMed": "2020-08",
     "inntektsmottaker": [
         {
             "personidentifikator": "01012066666"
         },
         {
             "personidentifikator": "01012066667"
         },
         {
             "personidentifikator": "01012066668"
         },
         {
             "personidentifikator": "01012066669"
         },
         {
             "personidentifikator": "01012066670"
         }
     ]
 }

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": "IM-006",
  "melding": "Påkrevd felt 'fraOgMed' kan ikke være frem i tid."
}

Feilkoder

Se også felles feilkoder for alle applikasjonene.