Iverksetting

POST /api/iverksetting

Sender en utbetaling til NAVs økonomisystem. Når API-et mottar en utbetaling som skal iverksettes, gjør den noen enkle valideringer og svarer med en 202 Accepted dersom valideringene går gjennom. Resten av løypa for å utbetale er helt asynkron og orkestreres internt i Utsjekk. En ok-respons fra API-et betyr altså ikke at utbetalingen er kvittert ok i økonomisystemet, men at Utsjekk tar ansvaret for videre håndtering. Bruk status-endepunktet for å sjekke status på utbetalingen.

Validering

Tabellene under viser hva som må være oppfylt for at Utsjekk skal akseptere utbetalingen.

Format på utbetalingen

Tilstand på saken i Utsjekk

Utbetalinger

Listen av utbetalinger som Utsjekk tar i mot følger dette formatet:

{
    "beløp": "uint",
    "satstype": "enum",
    "fraOgMed": "date",
    "tilOgMed": "date",
    "stønadsdata": {
        "stønadstype": "enum",
        // <ekstra_felter_spesifikke_for_ytelsen>
    }
}

Utbetalingene må altså periodiseres og klienten må fastsette et beløp og satstype perioden. Dersom beløpet eller stønadstypen endrer seg må det opprettes ny periode. For utbetalinger med dagsats må det opprettes nye perioder dersom brukeren har dager i perioden uten utbetaling, som f.eks. helg.

Eksempler

[
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2023-11-13",
    "tilOgMed": "2023-11-15"
  },
  {
    "beløp": 400,
    "satstype": "DAGLIG",
    "fraOgMed": "2023-11-16",
    "tilOgMed": "2023-11-17"
  }
]

[
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2023-11-13",
    "tilOgMed": "2023-11-17"
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2023-11-20",
    "tilOgMed": "2023-11-24"
  }
]

Merk at Utsjekk må ha beløp per dag for meldepliktsytelser uavhengig av hvordan vedtaksløsningen representerer utbetalingene internt. Dette kommer av føringer fra NAVs økonomisystem. Dersom din vedtaksløsning feks. representerer utbetalingen som et totalbeløp for en 14-dagers periode, må dere på konsumentsiden fordele dette totalbeløpet på dagsbeløp slik dere ser det hensiktsmessig.

Gjeldende totalbilde av utbetalinger på saken

Listen av utbetalinger som Utsjekk tar i mot skal være det gjeldende totalbildet av utbetalinger for hele saken. Utsjekk håndterer utbetalingene på samme måte uavhengig av om vedtaket som iverksettes er en førstegangsutbetaling eller en korrigering: Når Utsjekk beregner hva som skal sendes til utbetalingssystemet, regner den ut forskjellen på totalbildet for det nye vedtaket og totalbildet for det evt. forrige vedtaket som ble iverksatt.

Konseptet er illustrert i figuren under for 3 meldekort, der ett meldekort korrigeres (klikk for å åpne i ny fane):

I denne figuren er D en dag med utbetaling og H er en helgedag uten utbetaling. Rosa farge indikerer en dag med korrigert utbetaling.

Under er et eksempel på hvordan dataen for dette totalbildet kan se ut for 7 meldekort som sendes inn og korrigeres (klikk for å åpne i ny fane):

I det første meldekortet som sendes inn (B-2) er det gjeldende totalbildet utbetaling for uke 1 og 2. For det neste meldekortet som sendes inn (B-3) er det gjeldende totalbildet utbetaling for uke 1 og 2 og uke 3 og 4. Dersom vedtaksløsningen vil iverksette en korrigering av utbetalingen for uke 1 og 2 (B-4), sender den inn den nye sannheten for uke 1 og 2 og uendret utbetaling for uke 3 og 4. Her er det tre ting å merke seg:

1. Ved en korrigering skal Utsjekk alltid ha ny gjeldende sannhet, ikke differansen mellom ny og forrige utbetaling.
2. Utsjekk vil ikke agere på noe dersom totalbildet er uendret. Hvis totalbildet for deler av utbetalingen er uendret, som uke 3 og 4 over, vil det ikke skje noe med denne perioden. Hvis totalbildet for hele saken er uendret, vil ikke Utsjekk sende noe til utbetalingssystemet.
3. Dersom det har vært utbetaling på saken tidligere, må Utsjekk ha behandlingsid for den forrige behandlingen som ble iverksatt. Behandlingsid-en brukes til å hente ut det forrige totalbildet av utbetalinger på saken, slik at Utsjekk kan utlede om den nye behandlingen er utbetaling for en ny periode eller om det er en korrigering (og i så fall hva som skal korrigeres).

Merk også at korrigeringen av utbetalingen for uke 5-6 (B-6) er et opphør. Ved opphør av utbetaling forventer Utsjekk at det ikke finnes noen utbetalinger for perioden opphøret gjelder for. I dette eksempelet er altså alle utbetalingene for uke 5-6 fjernet fra listen. Dersom man vil iverksette et opphør av alle utbetalinger på saken, kan man sende en tom liste av utbetalinger til Utsjekk.

Periodisering av utbetalinger

Utbetalingsperiodene som sendes til utbetalingstjenesten vil bli sendt videre til Økonomisystemet med samme periodisering som utbetalingstjenesten mottar. Økonomisystemet/PO Utbetaling har et ønske om å minimere antall identiske utbetalingsperioder som sendes. Dette illustreres best ved et eksempel. Dersom man vil iverksette en utbetaling for mandag-fredag med likt dagsbeløp og stønadstype, er det bedre å sende dette som én periode:

[
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-12",
    "tilOgMed": "2024-02-16",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  }
]

Heller enn å sende 5 identiske perioder:

[
  {
    "beløp": 500,
    "satstype":"DAGLIG",
    "fraOgMed": "2024-02-12",
    "tilOgMed": "2024-02-12",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-13",
    "tilOgMed": "2024-02-13",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-14",
    "tilOgMed": "2024-02-14",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-15",
    "tilOgMed": "2024-02-15",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-16",
    "tilOgMed": "2024-02-16",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  }
]

Utbetalingsperioder som sendes på tvers av behandlinger må imidlertid deles opp selv om de er like og ligger back-to-back i tid. Eksempelvis:

Dersom man i behandling #1 iverksetter følgende utbetalingsperiode:

[
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-12",
    "tilOgMed": "2024-02-16",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  }
]

Og man i behandling #2 vil iverksette flere dager med utbetaling, må dette deles i to:

[
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-12",
    "tilOgMed": "2024-02-16",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  },
  {
    "beløp": 500,
    "satstype": "DAGLIG",
    "fraOgMed": "2024-02-17",
    "tilOgMed": "2024-02-23",
    "stønadsdata": {
      "stønadstype": "DAGPENGER_ARBEIDSSØKER_ORDINÆR"
    }
  }
]

Dersom disse utbetalingene hadde blitt slått sammen til én periode, vil vi ikke klare å utlede hva som er differansen fra totalbildet i forrige utbetaling.