Restanser inneholder informasjon om hvorvidt en skatteyter har restanser til skatteetaten.

Grensesnittbeskrivelse

For å bruke grensesnittet kreves autentisering med X.509-sertifikat.

URL har følgede oppbygging:

GET https://<env>/api/innkreving/restanser/<rettighetspakke>/<organisasjonsnummer>
  • <env>: Miljø-spesifikk adresse
  • <rettighetspakke>: En av rettighetspakkene dibk eller ebevis.
  • <organisasjonsnummer>: 9 sifret nummer gitt de som er registrert i Enhetsregisteret. .

Versjonering

Se generelle regler for versjonering.

Bruk med samtykke

For Datakonsumenter som benytter Samtykke gjelder en del tilleggskrav:

AltinnSamtykke header

Må legge ved en ekstra header AltinnSamtykke. Verdien i denne headeren skal være et base64-encodet Json Web Token (JWT) signert av Altinn. Tokenet er en representasjon av samtykket man har innhentet fra skattyteren man henter data for. For informasjon rundt hvordan man skaffer et slikt token, sjekk Altinn: hente token

Begrenset til rettighetspakke ebevis

Rettighetspakke med samtykke er ebevis

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må legge sertifikat og nøkkel som parametre til curl-kommandoen.

$ curl -v --cert datakonsument.cer --key datakonsument.key "https://api-at.sits.no/api/innkreving/restanser/012345678"

Suksess (HTTP status 200)

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

JSON

{
  "organisasjonsnummer": "995666162",
  "skatt": {
    "forfaltOgUbetalt": 2010020,
    "renterOgGebyrer": 21010
  },
  "arbeidsgiveravgift": {
    "forfaltOgUbetalt": 3001039,
    "renterOgGebyrer": 30129
  },
  "merverdiavgift": {
    "forfaltOgUbetalt": 913035,
    "renterOgGebyrer": 45378
  },
  "forskuddstrekk": {
    "forfaltOgUbetalt": 251080,
    "renterOgGebyrer": 10079
  },
  "ansvarskravSkatt": {
    "forfaltOgUbetalt": 120100,
    "renterOgGebyrer": 5790
  },
  "ansvarskravMva": {
    "forfaltOgUbetalt": 11000,
    "renterOgGebyrer": 0
  },
  "andreRelaterteOrganisasjonsnummer": [
    "982405645"
  ]
}

restanser.xsd

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. Dersom feilmeldingen ikke er på dette formatet, kan det være forespørselen ikke har kommet fram til applikasjonen. Se den generelle informasjonen om statuskoder og feilmeldinger.

JSON

{
 "kode": "RESTANSE-02",
 "melding": "Organisasjonsnummer ikke funnet.",
 "korrelasjonsid": "13a865f5-28f9-47db-9abd-ab78977c79fe"
 
}

feil.xsd

Feilkoder

Se også felles feilkoder for alle applikasjonene.

HTTP status Feilkode Feilmelding
401 RESTANSE-00 Autentisering feilet
403 RESTANSE-01 Du er ikke autorisert for bruk av dette endepunktet.
404 RESTANSE-02 Organisasjonsnummer ikke funnet.
500 RESTANSE-03 Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte!
500 RESTANSE-04 Den forespurte informasjonen er for øyeblikket utilgjengelig, vennligst prøv igjen senere! Dersom problemet vedvarer, ta kontakt med brukerstøtte!
400 RESTANSE-05 Feltet ‘organisasjonsnummer’ er ugyldig. Det må inneholde nøyaktig 9 tall.
400 RESTANSE-06 Feil med samtykke signatur. Kunne ikke finne rett sertifikat for validering
500 RESTANSE-07 Kunne ikke aksessere Altinn truststore. Ta kontakt med brukerstøtte hvis problemet vedvarer.
400 RESTANSE-08 Samtykke er utgått på tid.
400 RESTANSE-09 Feil med validering av samtykke fra Altinn. Kan ikke verifisere samtykke.
400 RESTANSE-10 Mangler samtykke.
500 RESTANSE-11 En uventet feil oppsto under validering av samtykke. Vennligst kontakt brukerstøtte.

Miljøer

Miljø URL
Akseptansetest (AT) https://api-at.sits.no
Produksjon (Prod) https://api.skatteetaten.no

Ønsker du å komme i kontakt med oss for spørsmål eller andre henvendelser, se veiledning på Skatteetaten.no.

Tags: