Mva-register – avgiftssubjekter med skattemeldingsplikt API

Sikkerhet

Denne tjenesten støtter kun bruk av maskinporten. Se Sikkerhetsmekanismer for informasjon om de ulike sikkerhetsløsningene.

Bruk med Maskinporten

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

Delegering

Tilgang til denne tjenesten kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen. Søk opp følgende tjeneste i Altinn for å delegere tilgangen: Mva-register – avgiftssubjekter med skattemeldingsplikt API.

Grensesnittbeskrivelse

Se Sikkerhetsmekanismer for informasjon om hva som kreves for å få tilgang til grensesnittet.

URL har følgede oppbygging:

GET https://{env}/api/merverdiavgift/mvaregister/v1/{rettighetspakke}/avgiftssubjekter/{organisasjonsnummer}

• env: Miljø-spesifikk adresse
• rettighetspakke: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakke
• organisasjonsnummer: Organisasjonsnummeret man spør etter informasjon om.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Mva-register – avgiftssubjekter med skattemeldingsplikt API

Versjonering

Se generelle regler for versjonering.

Støttetjenester

Hendelsesliste

For å følge med på endringer tilbyr vi en hendelsesliste. URL er:

GET https://{env}/api/merverdiavgift/mvaregister/avgiftssubjekter/hendelser/

Se felles API-dokumentasjon for hendelseslister for bruk.

Eksempel på respons fra tjenesten

Suksess (HTTP status 200)

Dersom kallet lykkes får man HTTP status 200 og data i JSON format.

JSON

{
  "organisasjonsnummer": "313327337",
  "registrertAvgiftssubjekt": {
    "registreringsstatus": "aktiv",
    "foersteregistreringsdato": "2022-01-01",
    "skattemeldingsplikt": [
      {
        "meldingskategori": "alminnelig",
        "skattleggingsperiodetype": "toMaaned",
        "registreringsperiode": {
          "start": "2022-01-01"
        },
        "foersteTermin": {
          "periode": "januar-februar",
          "aar": "2022"
        }
      }
    ]
  }
}

Feilmeldinger (HTTP status ikke 200)

Hvis statuskode ikke er 200, men man får svar fra applikasjonen, så kommer en feilmelding på følgende format. I enkelte tilfeller kan forespørsler stoppes i infrastrukturen før den når applikasjonen. I disse tilfellene kan det forekomme feilmeldinger som ikke følger formatet oppgitt ovenfor.

JSON

{
  "kode": "MRA-005",
  "melding": "Du er ikke autorisert for bruk av dette endepunktet.",
  "korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}

Feilkoder

Tabellen under viser en oversikt over hvilke typer feil applikasjonen kan gi. Feilmeldingen vil kunne variere selv om samme feilkode returneres. Dette er for å kunne gi en så presis beskrivelse av feilen som mulig. Ved vedvarende feil vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra feilmelding.