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"

Open API spesifikasjon

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

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. 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": "IM-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.