{"openapi":"3.0.3","info":{"description":"Tjenesten leverer informasjon om opplysningspliktiges innrapporterte opplysninger for en gitt periode.","version":"1.0.1","title":"Opplysningspliktig 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/opplysningspliktig"},"servers":[{"url":"https://opplysningspliktig.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://opplysningspliktig.api.skatteetaten.no/v1","description":"Produksjon"}],"security":[{"maskinporten":["skatteetaten:opplysningspliktig"]}],"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 håndtering","example":"AFO-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"}}},"Opplysningspliktig":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4783-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"norskIdentifikator":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4778-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/NorskIdentifikator"},"periodeOgOpplysningspliktigInformasjon":{"type":"array","description":"Informasjon om den opplysningspliktige som gjelder en gitt periode.","items":{"$ref":"#/components/schemas/PeriodeOgOpplysningspliktigInformasjon"}}},"xml":{"name":"opplysningspliktig","namespace":"urn:no:skatteetaten:bruk:delingstjeneste:opplysningspliktig:v1"},"required":["periodeOgOpplysningspliktigInformasjon"]},"PeriodeOgOpplysningspliktigInformasjon":{"type":"object","description":"Informasjon om den opplysningspliktige som gjelder en gitt periode.","properties":{"kalendermaaned":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4756-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/AarOgMaaned"},"ajourholdstidspunkt":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/0df14fd1-702b-4d57-aacc-18b9e95b2611'>Begrepsreferanse</a>)","$ref":"#/components/schemas/DatoKlokkeslett"},"betalingsinformasjon":{"description":"Begrepsdefinisjon av betalingsinformassjon: informasjon om hvilke beløp en opplysningspliktig har fastsatt for riktig arbeidsgiveravgift og riktig forkuddstrekk for aktuell rapporteringsperiode (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4716-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Betalingsinformasjon"},"betalingsinformasjonForForenkletOrdning":{"type":"array","description":"Fortsatt riktig?BetalingsinformasjonForForenkletOrdning:Definisjon: informasjon om lønnsutbetalingsdato og hvilket beløp en opplysningspliktig har fastsatt for riktig forkuddstrekk og evt. riktig arbeidsgiveravgift for perioden for når arbeidet er utført.Merknad til definisjon:Gjelder 'Melding om lønnet arbeid i hjemmet  (A04)' og 'Forenklet a-melding for veldedig eller allmennyttig organisasjon (A05)' (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/7fed9850-1b5f-11e7-8e60-0050568351d2'>Begrepsreferanse</a>)","items":{"$ref":"#/components/schemas/BetalingsinformasjonForForenkletOrdning"}},"annenBagatellmessigStoette":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb46e3-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Beloep"},"pensjonsinnretning":{"type":"array","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/3fa05500-9517-11ea-ba5c-0050568351d2'>Begrepsreferanse</a>)","items":{"$ref":"#/components/schemas/PensjonsinnretningIdentifikator"}},"avvik":{"type":"array","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4706-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","items":{"$ref":"#/components/schemas/Avvik"}}}},"Avvik":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4706-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"id":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4708-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Tekst"},"navn":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4709-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Tekst"},"alvorlighetsgrad":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb46e2-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Alvorlighetsgrad"}}},"BeloepPerLoennsutbetalingsdato":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/7dcd0007-c510-4006-b1b9-f4fda4248a1c'>Begrepsreferanse</a>)","properties":{"loennsutbetalingsdato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/65b29a5d-9c44-48f8-a8db-b85207accafb'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"},"beloep":{"description":"Beløpet som har blitt trukket.","$ref":"#/components/schemas/BeloepSomHeltall"}}},"Betalingsinformasjon":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4716-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","properties":{"sumForskuddstrekkPerLoennsutbetalingsdato":{"type":"array","description":"Det totale beløpet som trekkes i forskudd fra en inntektsmottakers lønn på en spesifikk lønnsutbetalingsdato.","items":{"$ref":"#/components/schemas/BeloepPerLoennsutbetalingsdato"}},"sumArbeidsgiveravgift":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb46f7-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"},"sumFinansskattLoenn":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/afa01570-2986-11e7-8081-0050568351d2'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"},"sumUtleggstrekk":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/56b797da-35f0-4e80-9067-b797c0051d79'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"},"sumForskuddstrekk":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4736-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"}}},"BetalingsinformasjonForForenkletOrdning":{"type":"object","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/7fed9850-1b5f-11e7-8e60-0050568351d2'>Begrepsreferanse</a>)","properties":{"sumForskuddstrekk":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/b3f87310-2986-11e7-8081-0050568351d2'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"},"sumArbeidsgiveravgift":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/ababd0d0-2986-11e7-8081-0050568351d2'>Begrepsreferanse</a>)","$ref":"#/components/schemas/BeloepSomHeltall"},"loennsutbetalingsdato":{"description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/65b29a5d-9c44-48f8-a8db-b85207accafb'>Begrepsreferanse</a>)","$ref":"#/components/schemas/Dato"}}},"PensjonsinnretningIdentifikator":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/3fa05500-9517-11ea-ba5c-0050568351d2'>Begrepsreferanse</a>)"},"Alvorlighetsgrad":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb46e2-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)","enum":["øyeblikkelig","retningslinje"]},"NorskIdentifikator":{"type":"string","description":"(<a href='https://data.skatteetaten.no/web/datakatalog/begrep/dcfb4778-e484-11e6-9cb3-005056821322'>Begrepsreferanse</a>)"},"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])$"},"DatoKlokkeslett":{"type":"string","description":"en kombinasjon av typene Dato og Klokkeslett. 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). (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52aee-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"date-time"},"Beloep":{"type":"number","description":"en sum av penger brukt i en kontekst. Dette kan være en transaksjon, saldo o.l. (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b2e146-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"double"},"Tekst":{"type":"string","description":"vilkårlig lang sekvens av tegn inkludert aksenter og spesielle tegn fra standardiserte tegnsett (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b52af3-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","maxLength":4000},"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"},"BeloepSomHeltall":{"type":"integer","description":"en sum av penger i hele kroner brukt i en kontekst. Dette kan være en transaksjon, saldo o.l. (<a href='https://data.skatteetaten.no/web/datakatalog/begrep/20b2e146-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"int64"}}},"paths":{"/{rettighetspakke}/opplysningspliktig/{opplysningspliktigIdentifikator}":{"get":{"summary":"Hent informasjon om opplysningspliktig","description":"Informasjon om arbeidsgivers (opplysningspliktiges) innrapporterte opplysninger for en gitt periode","operationId":"hentOpplysningspliktigesInformasjon","tags":["opplysningspliktig"],"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":"opplysningspliktigIdentifikator","in":"path","description":"Identifikator (Organisasjonsnummer, fødselsnummer eller d-nummer) for opplysningspliktig.","required":true,"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":"2023-07"},{"name":"tilOgMed","in":"query","description":"Til og med hvilken periode innrapporterte opplysninger skal leveres. Dersom tilOgMed ikke er satt brukes dagens dato som parameter.","required":false,"schema":{"type":"string"},"example":"2024-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/Opplysningspliktig"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}}}