Skip to content

Commit

Permalink
Merge pull request #44 from Skatteetaten/FIGO-766_skill_ut_NAV-spesif…
Browse files Browse the repository at this point in the history
…ikke_valideringsregler

FIGO-766 skill ut valideringsregler som er felles for alle oppdragsgi…
  • Loading branch information
OysteinSkadsem authored Apr 5, 2024
2 parents 15c805e + cc412ed commit 4a70a04
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 93 deletions.
75 changes: 75 additions & 0 deletions docs/innkrevingsoppdrag/felles-valideringsregler.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Felles valideringsregler

Valideringsreglene på denne siden er felles for alle oppdragsgivere.

## Synkrone valideringsregler

### Valideringsregler for opprett innkrevingsoppdrag

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|-----------------------------------------------------------------|-----------------------------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Kravtype eksisterer ikke | kravtype-eksisterer-ikke | 422 | Verifiserer at kravtypen ligger i Kodelistekatalogen (intern Skatteetaten-modul) |
| Kravtype er inaktiv | kravtype-er-inaktiv | 422 | Verifiserer at kravtypen er aktiv i Kodelistekatalogen |
| Beloep er ikke over 0 | beloep-er-ikke-over-0 | 422 | |
| Tom oppdragsgivers referanse | tom-oppdragsgivers-referanse | 422 | |
| Ugyldig oppdragsgivers referanse | ugyldig-oppdragsgivers-referanse | 422 | Må være mellom 1 og 40 tegn, og kun inneholde bokstaver (a-å, A-Å), tall og spesialtegnene - og / |
| Ugyldig oppdragsgivers kravidentifikator | ugyldig-oppdragsgivers-kravidentifikator | 422 | Dersom denne eksisterer: må være mellom 1 og 40 tegn, og kun inneholde bokstaver (a-å, A-Å), tall og spesialtegnene - og / |
| Oppdragsgivers kravidentifikator eksisterer allerede | oppdragsgivers-kravidentifikator-eksisterer-allerede | 422 | |
| Ugyldig fastsettelsesdato | ugyldig-fastsettelsesdato | 422 | Kan ikke være i fremtiden |
| Ugyldig foreldelsesfristens utgangspunkt | ugyldig-foreldelsesfristens-utgangspunkt | 422 | Må være tidligere enn fastsettelsesdato |
| Foreldelsesfristens utgangspunkt eldre enn 2 aar og 10 maaneder | foreldelsesfristens-utgangspunkt-eldre-enn-2-aar-og-10-maaneder | 422 | |
| Ugyldig tilleggsfrist etter foreldelsesloven | ugyldig-tilleggsfrist-etter-foreldelsesloven | 422 | Kan ikke være angitt når foreldelsesfristensUtgangspunkt er angitt |
| Tilleggsfrist etter foreldelsesloven eldre enn 10 maaneder | tilleggsfrist-etter-foreldelsesloven-eldre-enn-10-maaneder | 422 | tilleggsfristEtterForeldelsesloven kan ikke være mer enn 10 måneder tilbake i tid |
| Ugyldig skyldners identifikator | ugyldig-skyldners-identifikator | 422 | Må være et gyldig personnummer dersom skyldneren er en person, og et gyldig organisasjonsnummer dersom skyldneren er en organisasjon. |
| Ugyldig kravtype | ugyldig-kravtype | 422 | Kravtypen må tilhøre oppdragsgiveren |
| Rentebeloep er ikke over 0 | rentebeloep-er-ikke-over-0 | 422 | |
| Ugyldig renterilagtdato | ugyldig-renterilagtdato | 422 | Kan ikke være i fremtiden |
| Ytelser for avregning er ikke over 0 | ytelser-for-avregning-er-ikke-over-0 | 422 | |
| Ugyldig tilbakekrevingsperiode | ugyldig-tilbakekrevingsperiode | 422 | `fom` må være i fortiden. `tom` kan ikke være i fremtiden. `tom` må være etter `fom`. |
| Ugyldig tilleggsinformasjon | ugyldig-tilleggsinformasjon | 400 | Må være oppgitt om påkrevd for oppdragsgiver og være på rett format |

### Felles valideringsregler for alle de øvrige endepunktene

Dette inkluderer endepunktene hent valideringsfeil og hent mottaksstatus.

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|------------------------------------------|------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Ugyldig kravidentifikator | ugyldig-kravidentifikator | 422 | Dersom kravidentifikatortype settes til `SKATTEETATENS_KRAVIDENTIFIKATOR`, valideres det at kravidentifikatoren er en gyldig UUID. |
| Ugyldig oppdragsgivers kravidentifikator | ugyldig-oppdragsgivers-kravidentifikator | 422 | Dersom kravidentifikatortype settes til `OPPDRAGSGIVERS_KRAVIDENTIFIKATOR`, valideres det at kravidentifikatoren er mellom 1 og 40 tegn, og kun inneholder bokstaver (a-å, A-Å), tall og spesialtegnene - og /. |
| Innkrevingsoppdrag eksisterer ikke | innkrevingsoppdrag-eksisterer-ikke | 404 | |

### Valideringsregler for endring av hovedstol

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|----------------------------------------------|----------------------------------------------|-------------|-------------------------------------------------|
| Hovedstol er ikke over 0 | hovedstol-er-ikke-over-0 | 422 | |
| Innkrevingsoppdrag er ikke reskontrofoert | innkrevingsoppdrag-er-ikke-reskontrofoert | 409 | Må være reskontroført for å kunne endres |
| Avskrevet innkrevingsoppdrag kan ikke endres | avskrevet-innkrevingsoppdrag-kan-ikke-endres | 409 | Et avskrevet innkrevingsoppdrag kan ikke endres |

### Valideringsregler for endring av renter

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|----------------------------------------------|----------------------------------------------|-------------|-------------------------------------------------|
| Rentebeloep er under 0 | rentebeloep-er-under-0 | 422 | |
| Innkrevingsoppdrag er ikke reskontrofoert | innkrevingsoppdrag-er-ikke-reskontrofoert | 409 | Må være reskontroført for å kunne endres |
| Avskrevet innkrevingsoppdrag kan ikke endres | avskrevet-innkrevingsoppdrag-kan-ikke-endres | 409 | Et avskrevet innkrevingsoppdrag kan ikke endres |

### Valideringsregler for ny oppdragsgivers referanse

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|----------------------------------------------|----------------------------------------------|-------------|-------------------------------------------------|
| Innkrevingsoppdrag er ikke reskontrofoert | innkrevingsoppdrag-er-ikke-reskontrofoert | 409 | Må være reskontroført for å kunne endres |
| Avskrevet innkrevingsoppdrag kan ikke endres | avskrevet-innkrevingsoppdrag-kan-ikke-endres | 409 | Et avskrevet innkrevingsoppdrag kan ikke endres |

### Valideringsregler for avskriving

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|-------------------------------------------------|-------------------------------------------------|-------------|------------------------------------------------------------|
| Innkrevingsoppdrag er ikke reskontrofoert | innkrevingsoppdrag-er-ikke-reskontrofoert | 409 | Må være reskontroført for å kunne avskrives |
| Avskrevet innkrevingsoppdrag kan ikke avskrives | avskrevet-innkrevingsoppdrag-kan-ikke-avskrives | 409 | Et avskrevet innkrevingsoppdrag kan ikke avskrives på nytt |

### Valideringsregler for hent avstemming

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status |
|-------------------------------------------|-------------------------------------------|-------------|
| Innkrevingsoppdrag er ikke reskontrofoert | innkrevingsoppdrag-er-ikke-reskontrofoert | 404 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Oppdragsgiverspesifikke valideringsregler

## NAV

### Synkrone valideringsregler

#### Opprett innkrevingsoppdrag

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Kravtyper regelen gjelder for | Merknad |
|-----------------------------------------------------------------|-----------------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| Kravtype gjelder kun for person | kravtype-gjelder-kun-for-person | 422 | Alle bortsett fra TILBAKEKREVING\_<br/>OMSORGSPENGER og TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON | Alle kravtyper kan *kun* rettes mot personer, med unntak av TILBAKEKREVING\_<br/>OMSORGSPENGER og TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON |
| Kravtype gjelder kun for organisasjon | kravtype-gjelder-kun-for-organisasjon | 422 | TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON | Det er kun kravtypen TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON som *kun* kan rettes mot organisasjoner. |
| Foreldelsesfristens utgangspunkt eldre enn 2 aar og 11 maaneder | foreldelsesfristens-utgangspunkt-eldre-enn-2-aar-og-11-maaneder | 422 | TILBAKEKREVING\_<br/>FORSKUTTERTE\_<br/>DAGPENGER | |
| Tilleggsfrist etter foreldelsesloven eldre enn 11 maaneder | tilleggsfrist-etter-foreldelsesloven-eldre-enn-11-maaneder | 422 | TILBAKEKREVING\_<br/>FORSKUTTERTE\_<br/>DAGPENGER | |

### Asynkrone valideringsregler

#### Opprett innkrevingsoppdrag

| Regel | Eksempel på respons | Kravtyper regelen gjelder for | Merknad |
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Person eksisterer ikke | <pre><code>{<br/> "error": "PERSON_EKSISTERER_IKKE",<br/> "message": "Person med fødselsnummer=xxxxxx eksisterer ikke"<br/>}</code></pre> | Alle | |
| Person er død | <pre><code>{<br/> "error": "PERSON_ER_DOED",<br/> "message": "Person med fødselsnummer=xxxxxx er død"<br/>}</code></pre> | TILBAKEKREVING\_<br/>FORSKUTTERTE\_<br/>DAGPENGER | Det kan ikke rettes krav mot døde personer for kravtyper som er listet opp i kolonnen til venstre. |
| Organisasjonsnummer finnes ikke | <pre><code>{<br/> "error": "ORGANISASJONSNUMMER_FINNES_IKKE",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx finnes ikke. "<br/>}</code></pre> | Alle | Kan komme tilleggsinformasjon om at virksomheten er slettet, eller slettet som følge av dublett med nytt organisasjonsnummer om denne informasjonen er tilgjengelig. |
| Organisasjon er opphørt | <pre><code>{<br/> "error": "ORGANISASJON_ER_OPPHOERT",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx er opphørt. "<br/>}</code></pre> | Alle | |



## Brønnøysundregistrene

### Synkrone valideringsregler

#### Opprett innkrevingsoppdrag

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status |
|-----------------------------------------------------------------|-----------------------------------------------------------------|-------------|
| Kravtype gjelder kun for organisasjon | kravtype-gjelder-kun-for-organisasjon | 422 |


#### Endring av hovedstol

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|-----------------------------------------------------|-----------------------------------------------------|-------------|----------------------------------------------------------------------------|
| Ny hovedstol er ikke lavere enn gjeldende hovedstol | ny-hovedstol-er-ikke-lavere-enn-gjeldende-hovedstol | 422 | Beløpet for ny hovedstol må være lavere enn eller likt gjeldende hovedstol |

### Asynkrone valideringsregler

#### Opprett innkrevingsoppdrag

| Regel | Eksempel på respons | Merknad |
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Organisasjonsnummer finnes ikke | <pre><code>{<br/> "error": "ORGANISASJONSNUMMER_FINNES_IKKE",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx finnes ikke. "<br/>}</code></pre> | Kan komme tilleggsinformasjon om at virksomheten er slettet, eller slettet som følge av dublett med nytt organisasjonsnummer om denne informasjonen er tilgjengelig. |
| Organisasjon er opphørt | <pre><code>{<br/> "error": "ORGANISASJON_ER_OPPHOERT",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx er opphørt. "<br/>}</code></pre> | |
Loading

0 comments on commit 4a70a04

Please sign in to comment.