Skip to main content
skatteetaten.no

The Norwegian Tax Administration's APIs

Innrapportering boligselskap API

Tjeneste for innrapportering av tredjepartsopplysninger for boligselskap (RF-1139)

For generell informasjon om tjenestene se egne sider om:

Scope​

Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:innrapporteringboligselskap

Delegering​

Tilgang til dette API-et kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen.

Systemtilgang med systembruker​

Bruk av API-et krever systemtilgang med systembruker, som er ny funksjonalitet i Maskinporten levert av Digdir. Informasjon vedr. dette finnes her.

For å kunne benytte dette api'et med systemtilgang må man gi følgende rettighet til systemet ved opprettelse i systemregisteret:

"Rights": [
    {
      "Resource": [
        {
          "value": "ske-innrapportering-boligselskap",
          "id": "urn:altinn:resource"
        }
      ]
    }
  ]

Teknisk spesifikasjon​

URL-er til API-et, beskrivelsen av parameterne, endepunkter og respons ligger i Open API spesifikasjonen på SwaggerHub

Nødvendige åpninger i en evt. brannmur er beskrevet her

API-et for boligselskap har bare ett endepunkt:

  • POST innsending: Mottar tredjepartsopplysninger for boligselskaper. Ett kall mot API-et er en rapportering for et boligselskap gitt av en oppgavegiver og som gjelder et inntektsår.

API-et validerer mottatte data mot JSON schema beskrevet på SwaggerHub. Se feilkoder for relaterte feilmeldinger.

Se også eksempler for de ulike endepunktene.

Parameter: idempotencyKey​

idempotencyKey parameteren er påkrevet. Innholdet skal være en unik UUID. Hvert nye kall til API-et skal ha en tilsvarende ny idempotencyKey. Flere etterfølgende POST kall med samme request-body og samme idempotencyKey vil gi den samme responsen. Kun det første av denne rekken med like API kall vil behandles. IdempotencyKey muliggjør at man trygt kan prøve innsendinger på nytt der man av ulike årsaker ikke har fått en tilbakemelding fra API-et.

Datakatalog​

Dette API-et er pt. ikke dokumentert i Felles datakatalog.