{"openapi":"3.0.3","info":{"description":"Tjenesten leverer en liste over inntektsmottakere der arbeidsgiver (opplysningspliktig), via a-ordningen, har rapportert pensjonsavtale med pensjonsinnretningen som utfører kallet.","version":"1.1.1","title":"Inntektsmottakere API","termsOfService":"https://www.skatteetaten.no/deling/bruksvilkar-for-delingstjenester","contact":{"name":"Brukerstøtte","url":"https://www.skatteetaten.no/deling/kontakt/"}},"externalDocs":{"description":"Dokumentasjon på Skatteetatens GitHub","url":"https://skatteetaten.github.io/api-dokumentasjon/api/inntektsmottakere"},"servers":[{"url":"https://inntektsmottakere.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://inntektsmottakere.api.skatteetaten.no/v1","description":"Produksjon"}],"security":[{"maskinporten":["skatteetaten:inntektsmottakere"]}],"components":{"securitySchemes":{"maskinporten":{"type":"http","description":"Maskinporten benyttes for autentisering","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Feil":{"description":"Feilstruktur for alle feilmeldinger.","type":"object","properties":{"kode":{"type":"string","description":"Feilkode, for maskinell haandtering","example":"IM-0xx"},"melding":{"type":"string","description":"Beskrivelse av feilen som har oppstaatt","example":"Fant ikke gitt personidentifikator"},"korrelasjonsid":{"type":"string","description":"Korrelasjonsid","example":"123e4567-e89b-12d3-a456-426655440000"}},"xml":{"name":"feil","namespace":"urn:no:skatteetaten:datasamarbeid:feil:v1"}},"Inntektsmottakere":{"type":"object","description":"","properties":{"opplysningspliktig":{"description":"","$ref":"#/components/schemas/Opplysningspliktig"},"fraOgMed":{"description":"","$ref":"#/components/schemas/AarOgMaaned"},"tilOgMed":{"description":"","$ref":"#/components/schemas/AarOgMaaned"},"skjermet":{"description":"","$ref":"#/components/schemas/Boolsk"},"inntektsmottaker":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Inntektsmottaker"}}},"xml":{"name":"inntektsmottakere","namespace":"urn:no:skatteetaten:datasamarbeid:inntektsmottaker:rapporterte:v1"},"required":["opplysningspliktig","fraOgMed","tilOgMed"]},"Inntektsmottaker":{"type":"object","description":"","properties":{"personidentifikator":{"description":"","$ref":"#/components/schemas/Foedselsnummer"}},"required":["personidentifikator"]},"Opplysningspliktig":{"type":"object","description":"","properties":{"norskIdentifikator":{"description":"","$ref":"#/components/schemas/NorskIdentifikator"}},"required":["norskIdentifikator"]},"AarOgMaaned":{"type":"string","description":"årstall og måned angitt i nummer (<a href='https://data.skatteetaten.no/begrep/20b2e149-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","pattern":"^(19|20)\\d\\d-(0[1-9]|1[012])$"},"Boolsk":{"type":"boolean","description":"angir verdien sann eller usann (<a href='https://data.skatteetaten.no/begrep/20b52aec-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)"},"Foedselsnummer":{"type":"string","description":"ellevesifret identifikasjonsnummer for personer bosatt i Norge, der de seks første sifrene angir fødselsdato og de fem siste personnummer. (<a href='https://data.skatteetaten.no/begrep/5138da10-be20-11e6-8004-005056825ca0'>Begrepsreferanse</a>)","minLength":11,"pattern":"[0-9]+","maxLength":11},"NorskIdentifikator":{"type":"string","description":""}}},"paths":{"/{rettighetspakke}/{opplysningspliktig}/inntektsmottakere":{"get":{"summary":"Hent inntektsmottakere for en arbeidsgiver","description":"Henter en liste over inntektsmottakere der arbeidsgiver (opplysningspliktig), via a-ordningen, har rapportert pensjonsavtale med pensjonsinnretningen.","operationId":"hentInntektsmottakereForArbeidsgiver","tags":["Inntektsmottakere"],"parameters":[{"name":"rettighetspakke","in":"path","description":"Datakonsumenter plasseres i en rettighetspakke (per datasett) basert paa en juridisk vurdering. Rettighetspakken styrer Skjermingsregler, Filtrering og Detaljering som benyttes nÃ¥r det gis innsyn i data i datasett.","required":true,"schema":{"type":"string"}},{"name":"opplysningspliktig","in":"path","description":"Identifikator (Organisasjonsnummer, fødselsnummer eller d-nummer) for opplysningspliktig. Parameteren opplysningspliktig er kun påkrevd for rettighetspakken OTP, for å sjekke at pensjonsinnretning har en gyldig avtale med opplysningspliktig for en forespurt periode. Kun med gyldig avtale kan en pensjonsinnretning få tilgang til inntektsmottaker data. Parameteren opplysningspliktig skal ikke brukes for andre rettighetspakker.","required":true,"schema":{"type":"string"},"example":12345678901},{"name":"fraOgMed","in":"query","description":"Fra og med hvilken periode.","required":false,"schema":{"type":"string"},"example":"2020-01"},{"name":"tilOgMed","in":"query","description":"Til og med hvilken periode. Valgfritt parameter. Dersom tilOgMed ikke er satt brukes inneværende måned som parameter.","required":false,"schema":{"type":"string"},"example":"2021-01"},{"name":"Korrelasjonsid","in":"header","description":"Korrelasjonsid, unik identifikator for den tekniske forespørselen. Må være på UUID-format","required":false,"schema":{"type":"string","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426655440000"}],"responses":{"200":{"description":"Gyldig respons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inntektsmottakere"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Inntektsmottakere"}}}},"default":{"description":"Diverse feilmeldinger, se egen dokumentasjon","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}}}