Utsjekk API (wip)

API for iverksetting av utbetalinger mot Oppdragssystemet

Hent utbetaling

GET
/utbetalinger/{uid}

Henter utbetalingen slik den ser ut i Utsjekk.

Path-parametre

  • uid

    Påkrevd

    string (uuid)

    ID til utbetalingen. Sendes ikke til OS/UR.

Respons

400: Ugyldig format på uid-parameter
404: Fant ikke utbetalingen

Send utbetaling

POST
/utbetalinger/{uid}

Iverksetter utbetalingen mot Oppdragssystemet.

Path-parametre

  • uid

    Påkrevd

    string (uuid)

    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
      • ...
  • 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.

  • Påkrevd

    array [UtbetalingsperiodeApi]

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.

Path-parametre

  • uid

    Påkrevd

    string (uuid)

    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
      • ...
  • 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.

  • Påkrevd

    array [UtbetalingsperiodeApi]

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}

Annullerer en utbetaling mot Oppdragssystemet.

Path-parametre

  • uid

    Påkrevd

    string (uuid)

    ID til utbetalingen. Sendes ikke til OS/UR.

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)

    ID til utbetalingen. Sendes ikke til OS/UR.

Respons

400: Ugyldig format på uid-parameter
404: Fant ikke utbetalingen

Simuler utbetaling

POST
/simuleringer/{uid}

Simulerer utbetalingen mot Oppdragssystemet.

Path-parametre

  • uid

    Påkrevd

    string (uuid)

    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

  • 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
      • ...
  • 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.

  • Påkrevd

    array [UtbetalingsperiodeApi]

Respons

400: Ugyldig format på utbetalingen
403: Ikke autorisert til å iverksette utbetaling
409: Utbetalingen er i konflikt med tidligere utbetaling