{"openapi":"3.0.3","info":{"description":"Tjenesten leverer informasjon om arbeidsgivers (opplysningspliktiges) innrapporterte inntektsopplysninger som er relevante for arbeidsforholdet for en inntektsmottaker for en gitt periode.","version":"1.0.0","title":"Opptjeningsgrunnlag arbeidsforhold 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/opptjeningsgrunnlagarbeidsforhold"},"servers":[{"url":"https://opptjeningsgrunnlagarbeidsforhold.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://opptjeningsgrunnlagarbeidsforhold.api.skatteetaten.no/v1","description":"Produksjon"}],"components":{"schemas":{"Feil":{"description":"Feilstruktur for alle feilmeldinger.","type":"object","properties":{"kode":{"type":"string","description":"Feilkode, for maskinell håndtering","example":"OAF-0xx"},"melding":{"type":"string","description":"Beskrivelse av feilen som har oppstått","example":"Oppgitt rettighetspakke er ugyldig."},"korrelasjonsid":{"type":"string","description":"Korrelasjonsid","example":"123e4567-e89b-12d3-a456-426655440000"}}},"OpptjeningsgrunnlagArbeidsforhold":{"type":"object","description":"","properties":{"inntektsmottakerOgArbeidsgiver":{"type":"array","description":"","items":{"$ref":"#/components/schemas/InntektsmottakerOgArbeidsgiver"}}}},"DetaljerOpptjeningsgrunnlag":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/8ea2df44-7662-11e6-a74e-7e18b36b3fd9'>Begrepsreferanse</a>)","properties":{"opptjeningsland":{"description":"","$ref":"#/components/schemas/Landkode"},"antallTimer":{"description":"","$ref":"#/components/schemas/Desimaltall"}}},"InntektsmottakerOgArbeidsgiver":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb474b-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"aggregatId":{"description":"","$ref":"#/components/schemas/Heltall"},"norskIdentifikator":{"description":"","$ref":"#/components/schemas/NorskIdentifikator"},"internasjonalIdentifikator":{"type":"array","description":"","items":{"$ref":"#/components/schemas/InternasjonalIdentifikator"}},"identifiserendeInformasjon":{"description":"","$ref":"#/components/schemas/IdentifiserendeInformasjon"},"kalendermaaned":{"description":"","$ref":"#/components/schemas/AarOgMaaned"},"avvik":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Avvik"}},"opplysningspliktig":{"description":"","$ref":"#/components/schemas/NorskIdentifikator"},"underenhet":{"description":"","$ref":"#/components/schemas/NorskIdentifikator"},"kildesystem":{"description":"","$ref":"#/components/schemas/Tekst"},"opptjeningsgrunnlag":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Opptjeningsgrunnlag"}}},"required":["kalendermaaned"]},"Opptjeningsgrunnlag":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb474a-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"startdatoOpptjeningsperiode":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb47c1-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"sluttdatoOpptjeningsperiode":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb47b6-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"avvik":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Avvik"}},"detaljerOpptjeningsgrunnlag":{"description":"","$ref":"#/components/schemas/DetaljerOpptjeningsgrunnlag"}}},"Avvik":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4706-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"id":{"description":"Id som unikt identifiserer kontrollen som er utført","$ref":"#/components/schemas/Tekst"},"navn":{"description":"Beskrivende navn på kontrollen","$ref":"#/components/schemas/Tekst"},"alvorlighetsgrad":{"description":"Forteller i hvilken grad kontrollen avstedkommer sanksjoner","$ref":"#/components/schemas/Alvorlighetsgrad"}},"required":["id","navn","alvorlighetsgrad"]},"Alvorlighetsgrad":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb46e2-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)"},"Landkode":{"type":"string","description":""},"Desimaltall":{"type":"number","description":"tall som er satt sammen av en heltallsdel og en fraksjondel [wikipedia] (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52aef-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"double"},"Heltall":{"type":"integer","description":"hele tall, dvs. hele tall i mengden {..., -2, -1, 0, 1, 2, ...} (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52af0-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"int64"},"NorskIdentifikator":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4778-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)"},"InternasjonalIdentifikator":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4752-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"identifikator":{"description":"","$ref":"#/components/schemas/TekstMedRestriksjon"},"identifikatortype":{"description":"","$ref":"#/components/schemas/InternasjonalIdentifikatortype"},"land":{"description":"","$ref":"#/components/schemas/Landkode"}}},"IdentifiserendeInformasjon":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/f031c740-2405-11e7-8e60-0050568351d2'>Begrepsreferanse</a>)","properties":{"navn":{"description":"","$ref":"#/components/schemas/TekstMedRestriksjon"},"foedselsdato":{"description":"","$ref":"#/components/schemas/Dato"},"ansattnummer":{"description":"","$ref":"#/components/schemas/TekstMedRestriksjon"}},"required":["navn","foedselsdato"]},"AarOgMaaned":{"type":"string","description":"årstall og måned angitt i nummer (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b2e149-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","pattern":"^(19|20)\\d\\d-(0[1-9]|1[012])$"},"Tekst":{"type":"string","description":""},"Dato":{"type":"string","description":"gir verdier for år, måned og dag. Kodes som en tekststreng etter datoformatering spesifisert i  ISO 8601 (ISO 8601:2004 Data elements and interchange formats -- Information interchange -- Representation of dates and times). Eksempel : 1998-12-21 eller 19981221. (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52aed-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"date"},"TekstMedRestriksjon":{"type":"string","description":""},"InternasjonalIdentifikatortype":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb47d3-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)"}}},"paths":{"/{rettighetspakke}/person/{personidentifikator}":{"get":{"summary":"Hent opptjeningsgrunnlag arbeidsforhold for inntektsmottaker","description":"Informasjon om arbeidsgivers (opplysningspliktiges) innrapporterte inntektsopplysninger som er relevante for arbeidsforholdet for en inntektsmottaker for en gitt periode.","operationId":"hentOpptjeningsgrunnlagArbeidsforholdForInntektsmottaker","tags":["opptjeningsgrunnlag arbeidsforhold"],"parameters":[{"name":"rettighetspakke","in":"path","description":"Datakonsumenter plasseres i en rettighetspakke (per datasett) basert på 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":"personidentifikator","in":"path","description":"personidentifikator","required":true,"schema":{"type":"string"},"example":12345678901},{"name":"virksomhet","in":"query","description":"Identifikator (Organisasjonsnummer, fødselsnummer eller d-nummer) for virksomhet.","required":false,"schema":{"type":"string"},"example":123456789},{"name":"opplysningspliktig","in":"query","description":"Identifikator (Organisasjonsnummer, fødselsnummer eller d-nummer) for opplysningspliktig.","required":false,"schema":{"type":"string"},"example":12345678901},{"name":"fraOgMed","in":"query","description":"Fra og med hvilken periode innrapporterte opplysninger skal leveres.","required":true,"schema":{"type":"string"},"example":"2022-01"},{"name":"tilOgMed","in":"query","description":"Til og med hvilken periode innrapporterte opplysninger skal leveres. Dersom tilOgMed ikke er satt brukes inneværende år og måned som parameter.","required":false,"schema":{"type":"string"},"example":"2023-01"},{"name":"historikk","in":"query","description":"historikk – boolean (default false): false – bare sist rapporterte opplysninger (gjeldende opplysninger) for en periode vil bli returnert. True - alle rapporterte opplysninger i en periode vil bli returnert","required":false,"schema":{"type":"boolean","default":false},"example":"true"},{"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/OpptjeningsgrunnlagArbeidsforhold"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}},"/{rettighetspakke}/{aggregatId}":{"get":{"summary":"Hent opptjeningsgrunnlag arbeidsforhold for gitt ID","description":"Informasjon om arbeidsgivers (opplysningspliktiges) innrapporterte inntektsopplysninger som er relevante for arbeidsforholdet for en inntektsmottaker for en gitt aggregatId fra hendelse.","operationId":"hentOpptjeningsgrunnlagArbeidsforholdMedAggregatId","tags":["opptjeningsgrunnlag arbeidsforhold"],"parameters":[{"name":"rettighetspakke","in":"path","description":"Datakonsumenter plasseres i en rettighetspakke (per datasett) basert på 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":"aggregatId","in":"path","description":"aggregatId fra hendelse","required":true,"schema":{"type":"integer","format":"int64"},"example":100},{"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/OpptjeningsgrunnlagArbeidsforhold"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}}}