Skip to content

Commit

Permalink
FIGO-783 rename teknisk-dokumentasjon til kom i gang. Sett inn sekven… (
Browse files Browse the repository at this point in the history 
#57)

* FIGO-783 rename teknisk-dokumentasjon til kom i gang. Sett inn sekvensdiagrammer og legg til funksjonell beskrivelse.

* FIGO-783 endringer etter kommentarer i qa
  • Loading branch information
@jakobskatt
jakobskatt authored Sep 25, 2024
1 parent 0c84c0a commit f04f223
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 22 deletions.
51 changes: 31 additions & 20 deletions docs/innkrevingsoppdrag/beskrivelse-av-tjenester.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,26 @@ brukes, og eventuelle hensyn som må tas.
## Innholdsfortegnelse

<!-- TOC -->

* [Beskrivelse av tjenester](#beskrivelse-av-tjenester)
* [Innholdsfortegnelse](#innholdsfortegnelse)
* [Opprett et innkrevingsoppdrag](#opprett-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak)
* [Asynkron validering](#asynkron-validering)
* [Hent mottaksbekreftelse](#hent-mottaksbekreftelse)
* [Hent valideringsfeil](#hent-valideringsfeil)
* [Feilhåndtering](#feilhåndtering)
* [Endre et innkrevingsoppdrag](#endre-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak-1)
* [Asynkron validering](#asynkron-validering-1)
* [Feilhåndtering](#feilhåndtering-1)
* [Avskriv et innkrevingsoppdrag](#avskriv-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak-2)
* [Asynkron validering](#asynkron-validering-2)
* [Feilhåndtering](#feilhåndtering-2)
* [Grensesnittavstemming av et innkrevingsoppdrag](#grensesnittavstemming-av-et-innkrevingsoppdrag)

* [Innholdsfortegnelse](#innholdsfortegnelse)
* [Opprett et innkrevingsoppdrag](#opprett-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak)
* [Asynkron validering](#asynkron-validering)
* [Hent mottaksbekreftelse](#hent-mottaksbekreftelse)
* [Hent valideringsfeil](#hent-valideringsfeil)
* [Feilhåndtering](#feilhåndtering)
* [Sekvensdiagram](#sekvensdiagram)
* [Endre et innkrevingsoppdrag](#endre-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak-1)
* [Asynkron validering](#asynkron-validering-1)
* [Feilhåndtering](#feilhåndtering-1)
* [Sekvensdiagram](#sekvensdiagram-1)
* [Avskriv et innkrevingsoppdrag](#avskriv-et-innkrevingsoppdrag)
* [Synkron validering ved mottak](#synkron-validering-ved-mottak-2)
* [Asynkron validering](#asynkron-validering-2)
* [Feilhåndtering](#feilhåndtering-2)
* [Sekvensdiagram](#sekvensdiagram-2)
* [Grensesnittavstemming av et innkrevingsoppdrag](#grensesnittavstemming-av-et-innkrevingsoppdrag)
<!-- TOC -->

## Opprett et innkrevingsoppdrag
Expand Down Expand Up @@ -65,8 +66,6 @@ Ved valideringsfeil vil mottaksstatus settes til `VALIDERINGSFEIL`. Da må feile
innkrevingsoppdrag må sendes inn på nytt. Ansvaret for oppfølging ligger da hos oppdragsgiver.
Se [hent valideringsfeil](#hent-valideringsfeil).

*Seksjonen vil utvides med dokumentasjon som beskriver valideringsreglene pr kravtype.*

### Hent mottaksbekreftelse

1. Opprett nytt innkrevingsoppdrag med POST-kall til `/api/innkreving/innkrevingsoppdrag/v1/innkrevingsoppdrag` (Se
Expand Down Expand Up @@ -108,6 +107,10 @@ blitt opprettet hos Skatteetaten. Dersom kravet allerede finnes i vårt system,
en HTTP 422-statuskode med en beskrivende feilmelding. Hvis det ikke finnes, vil innkrevingsoppdraget bli opprettet og
prosessert. *Dette mønsteret for feilhåndtering kan kun benyttes om `oppdragsgiversKravidentifikator` er utfylt.*

### Sekvensdiagram

![](../../static/download/innkrevingsoppdrag/sekvensdiagram_nytt_krav.png)

## Endre et innkrevingsoppdrag

Innkrevingsoppdrag kan endres ved et PUT-kall til følgende endepunkter:
Expand Down Expand Up @@ -150,6 +153,10 @@ usikker på om kravet faktisk ble endret hos Skatteetaten, anbefales det å send
endringen kan sendes inn et vilkårlig antall ganger med samme resultat. Dersom en allerede eksisterende gyldig endring
sendes inn på nytt, vil det fremdeles returneres en HTTP 200-statuskode.

### Sekvensdiagram

![](../../static/download/innkrevingsoppdrag/sekvensdiagram_endre_krav.png)

## Avskriv et innkrevingsoppdrag

Innkrevingsoppdrag kan avskrives ved et POST-kall til
Expand Down Expand Up @@ -187,6 +194,10 @@ usikker på om kravet faktisk ble avskrevet hos Skatteetaten, anbefales det å s
Et innkrevingsoppdrag som allerede er avskrevet, kan ikke avskrives på nytt. I slike tilfeller returneres en HTTP
409-statuskode med en feilmelding.

### Sekvensdiagram

![](../../static/download/innkrevingsoppdrag/sekvensdiagram_avskriv_krav.png)

## Grensesnittavstemming av et innkrevingsoppdrag

Tjenesten gjør det mulig for oppdragsgiver å avstemme at krav, endringer på krav og avskrivinger er registrert korrekt i
Expand Down
33 changes: 33 additions & 0 deletions docs/innkrevingsoppdrag/funksjonell-beskrivelse.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Funksjonell beskrivelse

## Felles informasjonselementer

| Informasjonselement fra oppdragsgiver | Påkrevd felt | Funksjonell beskrivelse |
|---------------------------------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Oppdragsgivers referanse | ja | Dette er oppdragsgivers referanse til saken hvor pengekravet er fastsatt, eksempelvis et saksnummer.<br></br><br></br> Denne referansen kan brukes når det skal utveksles informasjon mellom oppdragsgiver og innkrevingsmyndigheten om saken. I tillegg oppgir vi som innkrevingsmyndighet oppdragsgivers referanse i vår faktura, slik at skyldner vet hvilke sak fra oppdragsgiver det gjelder. Skyldner kan også bruke oppdragsgivers referanse når vedkommende tar kontakt med oppdragsgiver om spørsmål knyttet til fastsettelse av kravet. |
| Oppdragsgivers kravidentifikator | nei | Dette er en unik id til pengekravet hos oppdragsgiver.<br></br><br></br> Oppdragsgivers kravidentifikator brukes i avstemming av overførte krav fra oppdragsgiver til innkrevingsmyndigheten og er viktig for å sikre sporbarhet i regnskapet.<br></br><br></br> Forskjellen mellom oppdragsgivers referanse og oppdragsgivers kravidentifikator er at oppdragsgivers referanse kan inneholde en sak med flere pengekrav mens kravidentifikator er en unik id for hvert enkelt pengekrav. Typiske tilfelle hvor oppdragsgivers referanse kan inneholde sak med flere pengekrav er en sak hvor det fastsettes et vedtak med løpende tvangsmulkt. I disse tilfellene vil tvangsmulkt som er påløpt for en gitt periode overføres til innkreving som et særskilt pengekrav. Jo lengre tid tvangsmulkten løper, jo flere perioder med påløpt mulkt som vil overføres til innkreving som flere enkeltstående pengekrav. |
| Fastsettelsesdato | ja | Med fastsettelsesdato menes dato da pengekravet oppsto/ ble fastsatt av oppdragsgiver, eksempelvis vedtaksdato.<br></br><br></br>Innkrevingsmyndigheten informerer skyldner om fastsettelsesdatoen i faktura slik at skyldner vet hvilket vedtak fra oppdragsgiver det gjelder, hvor pengekravet er fastsatt. Fastsettelsesdatoen er som hovedregel starttidspunktet for når foreldelsesfristen på pengekravet begynner å løpe. Innkrevingsmyndigheten vil som hovedregel ha 3 år på å få innkrevd pengekravet eller skaffe fristavbrudd på kravet før foreldelsesfristen utløper og pengekravet er foreldet. |
| Hovedstol | ja | Utestående beløp som innkrevingsmyndigheten skal kreve inn. Oppdragsgiver må oppgi beløp og valuta. Valuta er i norske kroner. Beløp må være større enn null. <br></br><br></br>Påløpte renter og gebyrer inngår ikke i hovedstol. |
| Rentebeløp | nei | Spesifikt for NAV. Med rentebeløp menes et fastsatt beløp som skal kreves inn. NAV må oppgi beløp og valuta. Valuta er i norske kroner.<br></br><br></br>Innkrevingsmyndigheten krever inn rentebeløpet fra NAV sammen med tilbakekreving av feilutbetalt ytelse. |
| Renter ilagt dato | nei | Spesifikt for NAV. Dette er en opplysning som er knyttet til rentebeløp. NAV må oppgi dato for når renter ble ilagt.<br></br><br></br>Innkrevingsmyndigheten tar utgangspunkt i denne datoen for å beregne når rentene vil bli foreldet såfremt vi ikke får fristavbrudd for å hindre at renter foreldes. |
| Rentetype | nei | Spesifikt for NAV. NAV oppgir strafferente som rentetype. |
| Skyldner | ja | Den som er pliktig til å betale kravet, det kan enten være en virksomhet eller privatperson. Da oppgis organisasjonsnummeret til virksomheten eller fødsels- og personnummeret eller d-nummeret til privatpersonen.<br></br><br></br>For virksomheter er det organisasjonsnummeret til hovedenheten, og ikke til underenheten som skal oppgis fordi det er hovedenheten som vanligvis har partsevne og som kan være part i en sak. |
| Kravtype | ja | Samlebetegnelse på kravet som skal kreves inn, eksempelvis tilbakekreving av barnetrygd eller tvangsmulkt. |
| Foreldelsesfristens utgangspunkt | nei | Med dette menes datoen for når foreldelsesfristen på kravet starter å løpe. I mange tilfeller er denne datoen det samme som fastsettelsesdatoen/ datoen for vedtaket. Foreldelsesfristens utgangspunkt er starttidspunktet for når foreldelsesfristen på pengekravet begynner å løpe. For tilbakebetalingskrav fra NAV er foreldelsesfristens utgangspunktet det samme som dato for første utbetaling av ytelsen/stønaden. <br></br><br></br>Innkrevingsmyndigheten vil som hovedregel ha 3 år på å få innkrevd pengekravet eller skaffe fristavbrudd på kravet før foreldelsesfristen utløper og pengekravet anses foreldet. |
| Tilleggsfrist etter foreldelsesloven | nei | Dersom vilkårene i foreldelsesloven § 10 er oppfylte, kan oppdragsgiver få en forlenget frist på 1 år fra uvitenheten om kravet eller skyldneren oppdages eller burde vært oppdaget, for å hindre at krav som er eldre enn 3 år anses foreldet. Datoen da forholdet ble oppdaget oppgis som tilleggsfrist, slik at innkrevingsmyndigheten kan forsøke å skaffe fristavbrudd på kravet innen 1 års fristen utløper slik at kravet ikke foreldes. |

## Tilleggsinformasjon NAV

| Informasjonselement fra oppdragsgiver | Påkrevd felt | Funksjonell beskrivelse |
|---------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Tilbakekrevingsperiode | ja | Er knyttet til feilutbetalt stønad og viser til perioden feilutbetalingen ble foretatt og som det kreves tilbakebetaling for. Her oppgis fra- og-med-dato og til-og-med-dato.<br></br><br></br> Innkrevingsmyndigheten må vite hvilken periode feilutbetalingskravet gjelder, blant annet i dialog med skyldner eller dersom deler av tilbakebetalingskravet må avskrives som foreldet. |
| Ytelse for avregning beløp | nei | NAV må oppgi beløp og valuta. Innkrevingsmyndigheten benytter avregning som et innkrevingstiltak. |

## Tilleggsinformasjon Brønnøysundregistrene

### For løpende tvangsmulkt

| Informasjonselement fra oppdragsgiver | Påkrevd felt | Funksjonell beskrivelse |
|---------------------------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Periode med tvangsmulkt | ja | Periode: periode som angir tidsintervallet for fastsatt og påløpt tvangsmulkt. <br></br><br></br> Fom: fra-og-med dato for periode med påløpt tvangsmulkt.<br></br><br></br> Tom: til-og-med dato for periode med påløpt tvangsmulkt. |
| Stoppdato for løpende mulkt | nei | |
7 changes: 6 additions & 1 deletion ...nkrevingsoppdrag/teknisk-dokumentasjon.md → docs/innkrevingsoppdrag/kom-i-gang.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Teknisk dokumentasjon
# Kom i gang

## Tilgang til tjenestene

Expand All @@ -20,3 +20,8 @@ Helt konkret under denne baseurlen: https://api-test.sits.no/api/innkreving/innk

Dvs. at en POST mot https://api-test.sits.no/api/innkreving/innkrevingsoppdrag/v1/innkrevingsoppdrag med tilhørende
token fra Maskinporten vil opprette et nytt innkrevingsoppdrag.

## Tjenester

![](../../static/download/innkrevingsoppdrag/tjenester_oppdragsinnkreving.png)

Loading

0 comments on commit f04f223

Please sign in to comment.