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 adresserettighetspakke
: En rettighetspakke er en kode for virksomheten sitt juridiske grunnlag for datauthenting. For mer informasjon se Rettighetspakkeorganisasjonsnummer
: Organisasjonsnummeret man spør etter informasjon om.
Open Api Specification
Teknisk spesifikasjon av API’et er publisert på SwaggerHub: Restanser API
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-test.sits.no/api/innkreving/restanser/v2/ebevis/974761076"
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. 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": "RESTANSE-005",
"melding": "Du er ikke autorisert for tilgang til den forespurte ressursen.",
"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.
Feilkode | HTTP Statuskode | Feilområde |
---|---|---|
RESTANSE-001 | 500 | Uventet feil på tjenesten. |
RESTANSE-002 | 500 | Uventet feil i et bakenforliggende system. |
RESTANSE-003 | 404 | Ukjent url benyttet. |
RESTANSE-004 | 401 | Feil i forbindelse med autentisering. |
RESTANSE-005 | 403 | Feil i forbindelse med autorisering. |
RESTANSE-006 | 400 | Feil i forbindelse med validering av inputdata. |
RESTANSE-007 | 403 | Feil i forbindelse med samtykke. |
RESTANSE-008 | 404 | Ingen restanser funnet på oppgitt organisasjonsnummer. |
RESTANSE-009 | 406 | Feil tilknyttet dataformat. Kun json eller xml er støttet. |