{"openapi":"3.0.3","info":{"description":"Tjenesten leverer informasjon om BSU renteinntekter pr kalenderår for en person.","version":"1.2.0","title":"Boligsparing for ungdom 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/bsu.html"},"servers":[{"url":"https://bsu.api.skatteetaten-test.no/v1","description":"Ekstern test"},{"url":"https://bsu.api.skatteetaten.no/v1","description":"Produksjon"}],"paths":{"/{rettighetspakke}/{inntektsaar}/{foedselsnummer}":{"get":{"summary":"Hent boligsparing for ungdom for person","description":"Hent boligsparing for ungdom for person","operationId":"hentBoligsparingForUngdomForPerson","tags":["Boligsparing for ungdom"],"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":"inntektsaar","in":"path","description":"Inntektsåret det skal hentes opplysninger fra.","required":true,"schema":{"type":"string"},"example":2020},{"name":"foedselsnummer","in":"path","description":"Fødselsnummer til personen det spørres på.","required":true,"schema":{"type":"string"},"example":12345678901},{"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/BoligsparingForUngdom"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BoligsparingForUngdom"}}}},"default":{"description":"Alle feil fra applikasjonen kommer på følgende format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Feil"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Feil"}}}}}}}},"components":{"schemas":{"Feil":{"description":"Feilstruktur for alle feilmeldinger.","type":"object","properties":{"kode":{"type":"string","description":"Feilkode, for maskinell håndtering","example":"BSU-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"}},"BoligsparingForUngdom":{"type":"object","description":"","properties":{"personidentifikator":{"description":"","$ref":"#/components/schemas/Foedselsnummer"},"inntektsaar":{"description":"","$ref":"#/components/schemas/Aarstall"},"aaretsRenter":{"description":"","$ref":"#/components/schemas/Beloep"}},"xml":{"name":"boligsparingForUngdom","namespace":"no:skatteetaten:datasamarbeid:boligsparingforungdom:v1"},"required":["personidentifikator","inntektsaar"]},"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},"Aarstall":{"type":"string","description":"årstall er et tall som angir årets nummer i tidsregningen i den gregorianske kalender (<a href='https://data.skatteetaten.no/begrep/20b2e14a-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"year"},"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/begrep/20b2e146-9fe1-11e5-a9f8-e4115b280940'>Begrepsreferanse</a>)","format":"double"}}}}