Utbetalinger

API for iverksetting av utbetalinger mot Oppdragssystemet

Hent utbetaling

GET

/utbetalinger/{uid}

Henter utbetalingen slik den ser ut hos oss.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til utbetalingen. Sendes ikke til OS/UR.

Respons

400: Ugyldig format på uid-parameter

404: Fant ikke utbetalingen

Send utbetaling

POST

/utbetalinger/{uid}

Oppretter en utbetaling hos oss som vi effektuerer i Oppdragssystemet.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til utbetalingen. Sendes ikke til OS/UR.

Request body:

application/json

Påkrevd

sakId

Påkrevd

string [1 ... 25] tegn

Eksempel: ASD123NLDQ23

Id på saken i vedtaksløsningen.

```
behandlingId
```
Påkrevd
```
string [1 ... 30] tegn
```
```
Eksempel: ADNLK123lDLJNWQ1
```
Id på behandlingen i vedtaksløsningen. Brukes for å spore utbetalingen tilbake til den konkrete hendelsen som trigget den. Kan også være id på vedtak, meldekort etc. DVH bruker denne når de sammenstiller stønadsstatistikk.

personident

Påkrevd

string 11 tegn

Eksempel: 15507600333

Fødselsnummer eller D-nummer

vedtakstidspunkt

Påkrevd

string (date-time)

Eksempel: 2024-11-26T09:34:10.912Z

Tidspunkt vedtaket ble fattet. Bruker ISO 8601-format.

stønad

Påkrevd

string

Eksempel: ARBEIDSSØKER_ORDINÆR

Stønadstypen som gjelder for utbetalingen

En av:

```
ARBEIDSSØKER_ORDINÆR
```
```
PERMITTERING_ORDINÆR
```
```
PERMITTERING_FISKEINDUSTRI
```
```
EØS
```

```
beslutterId
```
Påkrevd
```
string 
```
```
Eksempel: Z123456
```
Enten NAV-ident på beslutter når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
saksbehandlerId
```
Påkrevd
```
string 
```
```
Eksempel: A234567
```
Enten NAV-ident på saksbehandler når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
periodeType
```
Påkrevd
```
string 
```
```
Eksempel: UKEDAG
```
Type periode periodene skal tolkes som. F.eks. 'UKEDAG' er vanlige ukedager (man-fre) mens 'DAG' er alle dager (man-søn). 'MDN' er hele måneder og 'EN_GANG' er engangsbeløp som utbetales med en gang.
En av:
- ```
UKEDAG
```
- ```
DAG
```
- ```
MND
```
- ```
EN_GANG
```
Påkrevd
```
array [UtbetalingsperiodeApi]
```

Eksempler:

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "ARBEIDSTRENING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "DAG",
  "perioder": {
    "fom": "2024-10-04",
    "tom": "2024-10-04",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-05",
    "tom": "2024-10-05",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-06",
    "tom": "2024-10-06",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "TILSYN_BARN_ENSLIG_FORSØRGER",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "AAP_UNDER_ARBEIDSAVKLARING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

Respons

201: Utbetalingen er mottatt

400: Ugyldig format på utbetalingen

403: Ikke autorisert til å iverksette utbetaling

409: Utbetalingen er i konflikt med tidligere utbetaling

Endre utbetaling

PUT

/utbetalinger/{uid}

Endrer en eksisterende utbetaling. Brukes typisk om man skal foreta en revurdering/korrigering av en tidligere utbetalt periode. De nye periodene man sender inn må ha samme periodetype som de gamle. Hvis man f.eks. tidligere har sendt inn perioder med periodetype 'MND' kan man ikke her sende inn nye perioder med periodetype 'DAG'. Om man av en eller annen grunn trenger å endre periodetype må man annullere utbetalingen.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til utbetalingen. Sendes ikke til OS/UR.

Request body:

application/json

Påkrevd

sakId

Påkrevd

string [1 ... 25] tegn

Eksempel: ASD123NLDQ23

Id på saken i vedtaksløsningen.

```
behandlingId
```
Påkrevd
```
string [1 ... 30] tegn
```
```
Eksempel: ADNLK123lDLJNWQ1
```
Id på behandlingen i vedtaksløsningen. Brukes for å spore utbetalingen tilbake til den konkrete hendelsen som trigget den. Kan også være id på vedtak, meldekort etc. DVH bruker denne når de sammenstiller stønadsstatistikk.

personident

Påkrevd

string 11 tegn

Eksempel: 15507600333

Fødselsnummer eller D-nummer

vedtakstidspunkt

Påkrevd

string (date-time)

Eksempel: 2024-11-26T09:34:10.912Z

Tidspunkt vedtaket ble fattet. Bruker ISO 8601-format.

stønad

Påkrevd

string

Eksempel: ARBEIDSSØKER_ORDINÆR

Stønadstypen som gjelder for utbetalingen

En av:

```
ARBEIDSSØKER_ORDINÆR
```
```
PERMITTERING_ORDINÆR
```
```
PERMITTERING_FISKEINDUSTRI
```
```
EØS
```

```
beslutterId
```
Påkrevd
```
string 
```
```
Eksempel: Z123456
```
Enten NAV-ident på beslutter når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
saksbehandlerId
```
Påkrevd
```
string 
```
```
Eksempel: A234567
```
Enten NAV-ident på saksbehandler når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
periodeType
```
Påkrevd
```
string 
```
```
Eksempel: UKEDAG
```
Type periode periodene skal tolkes som. F.eks. 'UKEDAG' er vanlige ukedager (man-fre) mens 'DAG' er alle dager (man-søn). 'MDN' er hele måneder og 'EN_GANG' er engangsbeløp som utbetales med en gang.
En av:
- ```
UKEDAG
```
- ```
DAG
```
- ```
MND
```
- ```
EN_GANG
```
Påkrevd
```
array [UtbetalingsperiodeApi]
```

Eksempler:

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "ARBEIDSTRENING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "DAG",
  "perioder": {
    "fom": "2024-10-04",
    "tom": "2024-10-04",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-05",
    "tom": "2024-10-05",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-06",
    "tom": "2024-10-06",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "TILSYN_BARN_ENSLIG_FORSØRGER",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "AAP_UNDER_ARBEIDSAVKLARING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

Respons

204: Endret utbetaling er mottatt

400: Ugyldig format på utbetalingen

403: Ikke autorisert til å iverksette utbetaling

404: Utbetalingen finnes ikke

409: Utbetalingen er i konflikt med tidligere utbetaling

Annullér utbetaling

DELETE

/utbetalinger/{uid}

Sletter utbetalingen hos oss og annullerer utbetalingen i Oppdragssystemet. Dette vil typisk opprette en tilbakekrevingssak. For å unngå at man sletter feil utbetaling ved et uhell (f.eks. hvis man har feil/utdatert utbetaling), må man sende inn hele utbetalingen man ønsker å slette som vi da validerer mot det vi har lagret hos oss.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til utbetalingen. Sendes ikke til OS/UR.

Request body:

application/json

Påkrevd

sakId

Påkrevd

string [1 ... 25] tegn

Eksempel: ASD123NLDQ23

Id på saken i vedtaksløsningen.

```
behandlingId
```
Påkrevd
```
string [1 ... 30] tegn
```
```
Eksempel: ADNLK123lDLJNWQ1
```
Id på behandlingen i vedtaksløsningen. Brukes for å spore utbetalingen tilbake til den konkrete hendelsen som trigget den. Kan også være id på vedtak, meldekort etc. DVH bruker denne når de sammenstiller stønadsstatistikk.

personident

Påkrevd

string 11 tegn

Eksempel: 15507600333

Fødselsnummer eller D-nummer

vedtakstidspunkt

Påkrevd

string (date-time)

Eksempel: 2024-11-26T09:34:10.912Z

Tidspunkt vedtaket ble fattet. Bruker ISO 8601-format.

stønad

Påkrevd

string

Eksempel: ARBEIDSSØKER_ORDINÆR

Stønadstypen som gjelder for utbetalingen

En av:

```
ARBEIDSSØKER_ORDINÆR
```
```
PERMITTERING_ORDINÆR
```
```
PERMITTERING_FISKEINDUSTRI
```
```
EØS
```

```
beslutterId
```
Påkrevd
```
string 
```
```
Eksempel: Z123456
```
Enten NAV-ident på beslutter når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
saksbehandlerId
```
Påkrevd
```
string 
```
```
Eksempel: A234567
```
Enten NAV-ident på saksbehandler når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
periodeType
```
Påkrevd
```
string 
```
```
Eksempel: UKEDAG
```
Type periode periodene skal tolkes som. F.eks. 'UKEDAG' er vanlige ukedager (man-fre) mens 'DAG' er alle dager (man-søn). 'MDN' er hele måneder og 'EN_GANG' er engangsbeløp som utbetales med en gang.
En av:
- ```
UKEDAG
```
- ```
DAG
```
- ```
MND
```
- ```
EN_GANG
```
Påkrevd
```
array [UtbetalingsperiodeApi]
```

Eksempler:

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "ARBEIDSTRENING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "DAG",
  "perioder": {
    "fom": "2024-10-04",
    "tom": "2024-10-04",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-05",
    "tom": "2024-10-05",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-06",
    "tom": "2024-10-06",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "TILSYN_BARN_ENSLIG_FORSØRGER",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "AAP_UNDER_ARBEIDSAVKLARING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

Respons

204: Annullerte utbetalingen

400: Ugyldig format på uid-parameter

404: Fant ikke utbetalingen

Hent status på utbetaling

GET

/utbetalinger/{uid}/status

Henter status på utbetalingen.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til utbetalingen. Sendes ikke til OS/UR.

Respons

400: Ugyldig format på uid-parameter

404: Fant ikke utbetalingen

Eksempler:

"SENDT_TIL_OPPDRAG"

{
  "msg": "missing path param",
  "field": "uid",
  "doc": "https://navikt.github.io/utsjekk"
}

Simuler utbetaling

POST

/utbetalinger/{uid}/simuler

Simulerer utbetalingen mot Oppdragssystemet.

Path-parametre

uid

Påkrevd

string (uuid)

Eksempel: 7832faed-2140-4884-9e5c-5ab434e57fbb

ID til simuleringen. Sendes ikke til OS/UR.

Request body:

application/json

Påkrevd

sakId

Påkrevd

string [1 ... 25] tegn

Eksempel: ASD123NLDQ23

Id på saken i vedtaksløsningen.

```
behandlingId
```
Påkrevd
```
string [1 ... 30] tegn
```
```
Eksempel: ADNLK123lDLJNWQ1
```
Id på behandlingen i vedtaksløsningen. Brukes for å spore utbetalingen tilbake til den konkrete hendelsen som trigget den. Kan også være id på vedtak, meldekort etc. DVH bruker denne når de sammenstiller stønadsstatistikk.

personident

Påkrevd

string 11 tegn

Eksempel: 15507600333

Fødselsnummer eller D-nummer

stønad

Påkrevd

string

Eksempel: ARBEIDSSØKER_ORDINÆR

Stønadstypen som gjelder for utbetalingen

En av:

```
ARBEIDSSØKER_ORDINÆR
```
```
PERMITTERING_ORDINÆR
```
```
PERMITTERING_FISKEINDUSTRI
```
```
EØS
```

```
saksbehandlerId
```
Påkrevd
```
string 
```
```
Eksempel: A234567
```
Enten NAV-ident på saksbehandler når behandlingen er gjort manuelt, eller navn på system/applikasjon/servicebruker dersom behandlingen er gjort automatisk. Utsjekk gjør ingen validering av dette feltet.
```
periodeType
```
Påkrevd
```
string 
```
```
Eksempel: UKEDAG
```
Type periode periodene skal tolkes som. F.eks. 'UKEDAG' er vanlige ukedager (man-fre) mens 'DAG' er alle dager (man-søn). 'MDN' er hele måneder og 'EN_GANG' er engangsbeløp som utbetales med en gang.
En av:
- ```
UKEDAG
```
- ```
DAG
```
- ```
MND
```
- ```
EN_GANG
```
Påkrevd
```
array [UtbetalingsperiodeApi]
```

Eksempler:

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "ARBEIDSTRENING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "DAG",
  "perioder": {
    "fom": "2024-10-04",
    "tom": "2024-10-04",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-05",
    "tom": "2024-10-05",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }{
    "fom": "2024-10-06",
    "tom": "2024-10-06",
    "beløp": 1024,
    "betalendeEnhet": "1234"
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "TILSYN_BARN_ENSLIG_FORSØRGER",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

{
  "sakId": "ASD123NLDQ23",
  "behandlingId": "ADNLK123lDLJNWQ1",
  "personident": "15507600333",
  "vedtakstidspunkt": "2024-11-26T09:34:10.912Z",
  "stønad": "AAP_UNDER_ARBEIDSAVKLARING",
  "beslutterId": "Z123456",
  "saksbehandlerId": "A234567",
  "periodeType": "UKEDAG",
  "perioder": {
    "fom": "2024-10-01",
    "tom": "2024-10-01",
    "beløp": 256
  }{
    "fom": "2024-10-02",
    "tom": "2024-10-02",
    "beløp": 256
  }
}

Respons

400: Ugyldig format på utbetalingen

403: Ikke autorisert til å iverksette utbetaling

409: Utbetalingen er i konflikt med tidligere utbetaling