Skip to main content

Felles valideringsregler

Valideringsreglene på denne siden er felles for alle oppdragsgivere.

Synkrone valideringsregler

Ved feil i synkrone valideringer returneres et responsobjekt som følger RFC 7807-formatet. Et eksempel på en valideringsfeil for "Ugyldig fastsettelsesdato" vises nedenfor:

{
"type": "tag:skatteetaten.no,2024:innkreving:innkrevingsoppdrag:ugyldig-fastsettelsesdato",
"title": "Ugyldig fastsettelsesdato",
"status": 422,
"detail": "Ugyldig fastsettelsesdato=2024-04-20. Fastsettelsesdatoen kan ikke være i fremtiden",
"instance": "/api/innkreving/innkrevingsoppdrag/v1/innkrevingsoppdrag"
}

Tabellene nedenfor beskriver verdiene til de ulike delene av responsobjektet. Kolonnen "Title i feilobjekt" viser verdien satt i title-feltet; i dette tilfellet Ugyldig fastsettelsesdato. "Siste del av type-felt i feilobjekt" viser hva som settes etter det siste kolonet i type-feltet; i dette tilfellet ugyldig-fastsettelsesdato. HTTP-statuskoden i status-feltet er oppført i kolonnen "Http-status". Disse tre verdiene er konstante og kan benyttes til å utvikle feilhåndteringslogikk. Feltet detail gir ytterligere detaljer om feilen og vil variere avhengig av feilens årsak. Feltet instance viser hvilket endepunkt som er kalt.

Valideringsregler for opprett innkrevingsoppdrag

Title i feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Kravtype eksisterer ikkekravtype-eksisterer-ikke422Verifiserer at kravtypen ligger i Kodelistekatalogen (intern Skatteetaten-modul)
Kravtype er inaktivkravtype-er-inaktiv422Verifiserer at kravtypen er aktiv i Kodelistekatalogen
Beloep er ikke over 0beloep-er-ikke-over-0422
Tom oppdragsgivers referansetom-oppdragsgivers-referanse422
Ugyldig oppdragsgivers referanseugyldig-oppdragsgivers-referanse422Må være mellom 1 og 40 tegn, og kun inneholde bokstaver (a-å, A-Å), tall og spesialtegnene - og /
Ugyldig oppdragsgivers kravidentifikatorugyldig-oppdragsgivers-kravidentifikator422Dersom denne eksisterer: må være mellom 1 og 40 tegn, og kun inneholde bokstaver (a-å, A-Å), tall og spesialtegnene - og /
Oppdragsgivers kravidentifikator eksisterer alleredeoppdragsgivers-kravidentifikator-eksisterer-allerede422
Ugyldig fastsettelsesdatougyldig-fastsettelsesdato422Kan ikke være i fremtiden
Ugyldig foreldelsesfristens utgangspunktugyldig-foreldelsesfristens-utgangspunkt422Må være tidligere enn fastsettelsesdato
Ugyldig tilleggsfrist etter foreldelseslovenugyldig-tilleggsfrist-etter-foreldelsesloven422Kan ikke være angitt når foreldelsesfristensUtgangspunkt er angitt
Tilleggsfrist etter foreldelsesloven eldre enn 10 maanedertilleggsfrist-etter-foreldelsesloven-eldre-enn-10-maaneder422tilleggsfristEtterForeldelsesloven kan ikke være mer enn 10 måneder tilbake i tid
Ugyldig skyldners identifikatorugyldig-skyldners-identifikator422Må være et gyldig personnummer dersom skyldneren er en person, og et gyldig organisasjonsnummer dersom skyldneren er en organisasjon.
Ugyldig kravtypeugyldig-kravtype422Kravtypen må tilhøre oppdragsgiveren
Rentebeloep er ikke over 0rentebeloep-er-ikke-over-0422
Ugyldig renterilagtdatougyldig-renterilagtdato422Kan ikke være i fremtiden
Ugyldig tilleggsinformasjonugyldig-tilleggsinformasjon400Må 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 feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Ugyldig kravidentifikatorugyldig-kravidentifikator422Dersom kravidentifikatortype settes til SKATTEETATENS_KRAVIDENTIFIKATOR, valideres det at kravidentifikatoren er en gyldig UUID.
Ugyldig oppdragsgivers kravidentifikatorugyldig-oppdragsgivers-kravidentifikator422Dersom 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 ikkeinnkrevingsoppdrag-eksisterer-ikke404

Valideringsregler for endring av hovedstol

Title i feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Hovedstol er ikke over 0hovedstol-er-ikke-over-0422
Innkrevingsoppdrag er ikke reskontrofoertinnkrevingsoppdrag-er-ikke-reskontrofoert409Må være reskontroført for å kunne endres
Avskrevet innkrevingsoppdrag kan ikke endresavskrevet-innkrevingsoppdrag-kan-ikke-endres409Et avskrevet innkrevingsoppdrag kan ikke endres

Valideringsregler for endring av renter

Title i feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Rentebeloep er under 0rentebeloep-er-under-0422
Innkrevingsoppdrag er ikke reskontrofoertinnkrevingsoppdrag-er-ikke-reskontrofoert409Må være reskontroført for å kunne endres
Avskrevet innkrevingsoppdrag kan ikke endresavskrevet-innkrevingsoppdrag-kan-ikke-endres409Et avskrevet innkrevingsoppdrag kan ikke endres

Valideringsregler for ny oppdragsgivers referanse

Title i feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Innkrevingsoppdrag er ikke reskontrofoertinnkrevingsoppdrag-er-ikke-reskontrofoert409Må være reskontroført for å kunne endres
Avskrevet innkrevingsoppdrag kan ikke endresavskrevet-innkrevingsoppdrag-kan-ikke-endres409Et avskrevet innkrevingsoppdrag kan ikke endres

Valideringsregler for avskriving

Title i feilobjektSiste del av type-felt i feilobjektHttp-statusMerknad
Innkrevingsoppdrag er ikke reskontrofoertinnkrevingsoppdrag-er-ikke-reskontrofoert409Må være reskontroført for å kunne avskrives
Avskrevet innkrevingsoppdrag kan ikke avskrivesavskrevet-innkrevingsoppdrag-kan-ikke-avskrives409Et avskrevet innkrevingsoppdrag kan ikke avskrives på nytt

Valideringsregler for henting av grensesnittavstemming

Title i feilobjektSiste del av type-felt i feilobjektHttp-status
Innkrevingsoppdrag er ikke reskontrofoertinnkrevingsoppdrag-er-ikke-reskontrofoert404