Mva-melding 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:mvamelding

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-melding 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/mvamelding/v1/{rettighetspakke}/meldinger/{referanse}

• env: Miljø-spesifikk adresse
• rettighetspakke: En kode for virksomheten sitt juridiske grunnlag for datauthenting. Se Rettighetspakke
• referanse: Referanse fra hendelsesliste.

Open Api Specification

Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Mva melding API

Versjonering

Se generelle regler for versjonering.

Støttetjenester

Hendelsesliste

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

GET https://{env}/api/merverdiavgift/mvamelding/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 eller XML format. Dersom man ikke spesifiserer ønsket format får man JSON.

JSON

{
  "skattegrunnlagOgBeregnetSkatt": {
    "skattleggingsperiode": {
      "periode": "mai-juni",
      "aar": "2022"
    },
    "fastsattMerverdiavgift": 250000.0,
    "mvaSpesifikasjonslinje": [
      {
        "mvaKode": "3",
        "grunnlag": 1000000.0,
        "sats": "25",
        "merverdiavgift": 250000.0
      }
    ]
  },
  "skattepliktig": {
    "organisasjonsnummer": "910150804"
  },
  "meldingskategori": "alminnelig",
  "fastsettingsstatus": {
    "status": "egenfastsattMerverdiavgift"
  },
  "referanse": "180300"
}

XML

Dersom man ønsker XML i stedet for JSON kan dette spesifiseres med header Accept satt til application/xml:

<?xml version='1.0' encoding='UTF-8'?>
<mvaMelding>
  <skattegrunnlagOgBeregnetSkatt>
    <skattleggingsperiode>
      <periode>mai-juni</periode>
      <aar>2022</aar>
    </skattleggingsperiode>
    <fastsattMerverdiavgift>250000.0</fastsattMerverdiavgift>
    <mvaSpesifikasjonslinje>
      <mvaKode>3</mvaKode>
      <grunnlag>1000000.0</grunnlag>
      <sats>25</sats>
      <merverdiavgift>250000.0</merverdiavgift>
    </mvaSpesifikasjonslinje>
  </skattegrunnlagOgBeregnetSkatt>
  <skattepliktig>
    <organisasjonsnummer>910150804</organisasjonsnummer>
  </skattepliktig>
  <meldingskategori>alminnelig</meldingskategori>
  <fastsettingsstatus>
    <status>egenfastsattMerverdiavgift</status>
  </fastsettingsstatus>
  <referanse>180300</referanse>
</mvaMelding>

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": "MVA-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.