{"openapi":"3.0.3","info":{"description":"Tjeneste hvor pensjonsinnretninger kan registrere, oppdatere og slette opplysninger om pensjonsavtaleforhold. Tjenesten kan også levere informasjon om det foreligger gyldig avtaleforhold mellom arbeidsgiver og pensjonsinnretning.","version":"1.1.0","title":"Tjenestepensjonsavtale 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/tjenestepensjonsavtale"},"servers":[{"url":"https://tjenestepensjonsavtale.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://tjenestepensjonsavtale.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":"OTP-0xx"},"melding":{"type":"string","description":"Beskrivelse av feilen som har oppstått","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"}},"Avtaleforhold":{"type":"object","description":"","properties":{"avtalereferanse":{"description":"","$ref":"#/components/schemas/Tekst"},"fraOgMed":{"description":"","$ref":"#/components/schemas/AarOgMaaned"},"tilOgMed":{"description":"","$ref":"#/components/schemas/AarOgMaaned"},"opplysningspliktig":{"description":"","$ref":"#/components/schemas/Opplysningspliktig"}},"xml":{"name":"avtaleforhold","namespace":"urn:no:skatteetaten:datasamarbeid:tjenestepensjonsavtale:avtaleforhold:v1"},"required":["avtalereferanse","fraOgMed","opplysningspliktig"]},"AvtaleforholdGyldighet":{"type":"object","description":"","properties":{"gyldig":{"description":"","$ref":"#/components/schemas/Boolsk"},"maanederUtenGyldigAvtaleforhold":{"description":"","$ref":"#/components/schemas/MaanederUtenGyldigAvtaleforhold"}},"xml":{"name":"avtaleforholdGyldighet","namespace":"urn:no:skatteetaten:datasamarbeid:tjenestepensjonsavtale:avtaleforholdgyldighet:v1"},"required":["gyldig"]},"MaanederUtenGyldigAvtaleforhold":{"type":"object","description":"","properties":{"maaned":{"type":"array","description":"","items":{"$ref":"#/components/schemas/AarOgMaaned"}}},"required":["maaned"]},"Opplysningspliktig":{"type":"object","description":"","properties":{"norskIdentifikator":{"description":"","$ref":"#/components/schemas/NorskIdentifikator"}},"required":["norskIdentifikator"]},"AvtaleforholdForSletting":{"type":"object","description":"","properties":{"avtalereferanse":{"description":"","$ref":"#/components/schemas/Tekst"},"opplysningspliktig":{"description":"","$ref":"#/components/schemas/Opplysningspliktig"}},"xml":{"name":"avtaleforhold","namespace":"urn:no:skatteetaten:datasamarbeid:tjenestepensjonsavtale:avtaleforhold:slett:v1"},"required":["avtalereferanse","opplysningspliktig"]},"VirkningsperiodeGyldighet":{"type":"object","description":"","properties":{"gyldig":{"description":"","$ref":"#/components/schemas/Boolsk"},"maanederUtenforGyldigVirkningsperiode":{"description":"","$ref":"#/components/schemas/MaanederUtenforGyldigVirkningsperiode"}},"xml":{"name":"virkningsperiodeGyldighet","namespace":"urn:no:skatteetaten:datasamarbeid:tjenestepensjonsavtale:virkningsperiodegyldighet:v1"},"required":["gyldig"]},"MaanederUtenforGyldigVirkningsperiode":{"type":"object","description":"","properties":{"maaned":{"type":"array","description":"","items":{"$ref":"#/components/schemas/AarOgMaaned"}}},"required":["maaned"]},"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>)"},"Tekst":{"type":"string","description":"vilkårlig lang sekvens av tegn inkludert aksenter og spesielle tegn fra standardiserte tegnsett (<a href='https://data.skatteetaten.no/begrep/20b52af3-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","maxLength":4000},"NorskIdentifikator":{"type":"string","description":"","pattern":"^([0-9]{9}|[0-9]{11})$"}}},"paths":{"/{rettighetspakke}/avtaleforhold/gyldighet":{"get":{"summary":"Hent gyldighet for avtaleforhold","description":"Hent gyldighet for avtaleforhold","operationId":"HentGyldighetForAvtaleforhold","tags":["Tjenestepensjonsavtale"],"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":"pensjonsinnretning","in":"query","description":"Identifikator (Organisasjonsnummer) for pensjonsinnretning.","required":true,"schema":{"type":"string"},"example":"123456789"},{"name":"opplysningspliktig","in":"query","description":"Identifikator (Organisasjonsnummer eller Fødsels/D-nummer) for opplysningspliktig.","required":true,"schema":{"type":"string"},"example":"12345678901"},{"name":"fraOgMed","in":"query","description":"Start årstall og måned for første måned som skal hentes, må oppgis som YYYY-MM.","required":true,"schema":{"type":"string"},"example":"2020-06"},{"name":"tilOgMed","in":"query","description":"Slutt årstall og måned for siste måned som skal hentes, må oppgis som YYYY-MM.","required":true,"schema":{"type":"string"},"example":"2022-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/AvtaleforholdGyldighet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AvtaleforholdGyldighet"}}}},"default":{"description":"Diverse feilmeldinger, se egen dokumentasjon","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}},"/{rettighetspakke}/avtaleforhold/virkningsperiode/gyldighet":{"get":{"summary":"Hent gyldighet for avtaleforhold med virkningsperiode","description":"Hent gyldighet for avtaleforhold med virkningsperiode","operationId":"HentGyldighetForAvtaleforholdMedVirkningsperiode","tags":["Tjenestepensjonsavtale"],"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":"pensjonsinnretning","in":"query","description":"Identifikator (Organisasjonsnummer) for pensjonsinnretning.","required":true,"schema":{"type":"string"},"example":"123456789"},{"name":"opplysningspliktig","in":"query","description":"Identifikator (Organisasjonsnummer eller Fødsels/D-nummer) for opplysningspliktig.","required":true,"schema":{"type":"string"},"example":"12345678901"},{"name":"fraOgMed","in":"query","description":"Start årstall og måned for første måned som skal hentes, må oppgis som YYYY-MM.","required":true,"schema":{"type":"string"},"example":"2020-06"},{"name":"tilOgMed","in":"query","description":"Slutt årstall og måned for siste måned som skal hentes, må oppgis som YYYY-MM.","required":true,"schema":{"type":"string"},"example":"2022-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/VirkningsperiodeGyldighet"}},"application/xml":{"schema":{"$ref":"#/components/schemas/VirkningsperiodeGyldighet"}}}},"default":{"description":"Diverse feilmeldinger, se egen dokumentasjon","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}},"/{rettighetspakke}/avtaleforhold":{"post":{"summary":"Opprett og endre avtaleforhold","description":"Opprett og endre avtaleforhold for person","operationId":"opprettOgEndreAvtaleforholdForPerson","tags":["Tjenestepensjonsavtale"],"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":"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"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Avtaleforhold"}}}},"responses":{"201":{"description":"Gyldig respons"},"default":{"description":"Diverse feilmeldinger, se egen dokumentasjon","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}},"delete":{"summary":"Slett avtaleforhold for person","description":"Slett avtaleforhold for person","operationId":"slettAvtaleforholdForPerson","tags":["Tjenestepensjonsavtale"],"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":"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"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvtaleforholdForSletting"}}}},"responses":{"201":{"description":"Gyldig respons"},"default":{"description":"Diverse feilmeldinger, se egen dokumentasjon","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}}}