Restanser API leverer informasjon om hvorvidt en skatteyter har restanser til skatteetaten.

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:restanser

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: Restanser API.

Grensesnittbeskrivelse

Denne tjenesten kan kun benyttes med maskinporten. For mer informasjon se, hvordan komme i gang med maskinporten

URL har følgede oppbygging:

GET https://<env>/api/innkreving/restanser/v2/<rettighetspakke>/<organisasjonsnummer>
  • <env>: Miljø-spesifikk adresse
  • <rettighetspakke>: En rettighetspakke er en kode for virksomheten sitt juridiske grunnlag for datauthenting. For mer informasjon se Rettighetspakke
  • <organisasjonsnummer>: Organisasjonsnummeret man spør etter informasjon om.

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 Json Web Token (JWT) signert av Altinn. For informasjon rundt hvordan man skaffer et slikt token, sjekk Altinn: hente token

Eksempel på respons fra tjenesten

Her er et eksempel på en spørring med curl mot tjenesten. Du må ha et gyldig maskinportentoken og altinn samtykketoken som legges ved som headerer i curl-kommandoen.

$ curl -v -H "Authorization: Bearer <maskinporten_token>" -H "AltinnSamtykke: <samtykke_token>" "https://api-at.sits.no/api/innkreving/restanser/v2/ebevis/974761076"

Open API spesifikasjon

Spesifikasjon for tjenesten kan lastes ned her Restanser_API_v.2.0.yaml

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

{
    "levert": "2020-09-21T08:47:34.174294",
    "forespurteOrganisasjon": "974761076",
    "restanser": {
        "arbeidsgiveravgift": {
            "forfaltOgUbetalt": 30550
        },
        "forskuddstrekk": {
            "forfaltOgUbetalt": 884715
        },
        "forskuddsskatt": {
            "forfaltOgUbetalt": 5029271
        },
        "restskatt": {
            "forfaltOgUbetalt": 1235
        },
        "gebyr": {
            "forfaltOgUbetalt": 654321
        },
        "merverdiavgift": {
            "forfaltOgUbetalt": 0
        }
    }
}

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-011",
      "melding": "Du er ikke autorisert for tilgang til den forespurte ressursen.",
      "korrelasjonsid": "456420a2-6689-4cda-8102-8be499a892dd"
}

Feilkoder

Se også felles feilkoder for alle applikasjonene.

Feilkode HTTP Statuskode Tekst
RESTANSE-001 500 Det var en uventet feil på tjenesten. Vennligst ta kontakt med brukerstøtte med applikasjon og korrelasjonsid fra denne meldingen!
RESTANSE-002 404 Ingen restanser funnet for oppgitt organisasjon.
RESTANSE-003 404 Tredjepart leverte feil reponse ved uthenting av restanser.
RESTANSE-004 500 Ingen kontakt med tredjepartssystem”
RESTANSE-005 500 En uventet feil oppstod mot tredjepart ved uthenting av restanser.
RESTANSE-006 403 En uventet feil oppstod mot tredjepart ved autentisering. Kontakt brukerstøtte.
RESTANSE-007 400 Feltet ‘rettighetspakke’ mangler eller er ugyldig.
RESTANSE-008 400 Det skjedde en feil i forbindelse med maskinporten autentisering: token mangler.
RESTANSE-009 403 En uventet feil oppstod ved autentisering. Kontakt brukerstøtte.
RESTANSE-010 403 Det skjedde en feil i forbindelse med maskinporten autentisering: token invalid.
RESTANSE-011 403 Du er ikke autorisert for tilgang på den forespurte ressursen.
RESTANSE-012 400 Request validerer ikke
RESTANSE-013 400 Response validerer ikke
RESTANSE-014 400 Valideringsfeil
RESTANSE-015 500 Feil i parsing av resultat
RESTANSE-016 400 Feil med samtykke signatur. Kunne ikke finne rett sertifikat for validering.
RESTANSE-017 500 Kunne ikke aksessere Altinn truststore. Ta kontakt med brukerstøtte hvis problemet vedvarer.
RESTANSE-018 400 Samtykke er utgått
RESTANSE-019 500 Feil med validering av samtykke fra Altinn. Kan ikke verifisere samtykke.
RESTANSE-020 500 Mangler samtykke.
RESTANSE-021 500 En uventet feil oppsto under validering av samtykke. Vennligst kontakt brukerstøtte.
RESTANSE-022 500 Det mangler nødvendige felter i restanserespons

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: