Skip to content

Commit

Permalink
Fiut 5731 betaapier oppdater dokumentasjon utleggsbegjaering (#60)
Browse files Browse the repository at this point in the history 
* FIUT-5731 
- Betaapier-oppdater dokumentasjon - Utleggsbegjæring

* FIUT-5490
- Justert i henhold til tilbakemeldinger i jira
- Tatt bort prioritet
- Lagt til maksAntall
- Lagt til faktisk server (test)
- Rettet url'er
- Noen andre justeringer

---------

Co-authored-by: Børge Haugsdal <[email protected]>
Co-authored-by: Henning Olsgård <henning.olsgå[email protected]>
  • Loading branch information
@HenningOlsgardSkatt @k70099
3 people authored Oct 21, 2024
1 parent 3ed8771 commit b9f93d4
Show file tree
Hide file tree
Showing 14 changed files with 88 additions and 74 deletions.
41 changes: 23 additions & 18 deletions docs/trekkpaalegg/apispesifikasjon/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,34 @@ Open API spesifikasjonen er tilgjengelig her :

# Trekkpålegg API

Alle URIer er relative til *http://localhost:8080*
Alle URIer er relative til
* https://api-test.sits.no (test)
* --- (prod)


| Metode | HTTP request | Beskrivelse |
|-----------------------------------------------|----------------------------------------------------------------------|-------------------------------------------------------|
| [**hent alle gjeldende**](#hentAlleGjeldende) | **GET** /api/trekkpaalegg/v1/{trekkpliktig} | Hent alle gjeldende trekkpålegg for den trekkpliktige |
| [**hent versjon**](#hentVersjon) | **GET** /api/trekkpaalegg/v1/{trekkpliktig}/{trekkid}/{trekkversjon} | Hent en spesifikk versjon av et trekkpålegg. |

| Metode | HTTP request | Beskrivelse |
|----------------------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------|
| [**hent alle gjeldende**](#hentAlleGjeldende) | **GET** /external/v1/trekkpaalegg/{trekkpliktig} | Hent alle gjeldende trekkpålegg for den trekkpliktige |
| [**hent versjon**](#hentVersjon) | **GET** /external/v1/trekkpaalegg/{trekkpliktig}/{trekkid}/{trekkversjon} | Hent en spesifikk versjon av et trekkpålegg. |
<a name="hentAlleGjeldende"></a>

# **Hent alle gjeldende**
### Hent alle gjeldende

> **GET** /external/v1/trekkpaalegg/{trekkpliktig}
> **GET** /api/trekkpaalegg/v1/{trekkpliktig}
Henter alle gjeldende trekkpålegg for den trekkpliktige.
Returnerer siste versjon av samtlige trekkpålegg for en trekkpliktig. Dersom en trekkpliktig har svært mange trekkpålegg (flere tusen) så bør man benytte fraSekvensnummer og maksAntall for begrense returen til kun å inneholde trekkpålegg som er endret siden forrige spørring. Dersom antall returnerte trekkpålegg er lik maksAntall så må det gjøres en ny spørring med fraSekvensnummer lik det største sekvensnummeret i siste retur inntil man har fått returnert samtlige endrede trekkpålegg.

### Parametre

| Navn | Type | Beskrivelse | Notater |
|----------------------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkpliktig** | **String** | Orgnummeret til den trekkpliktige arbeidsgiver/ytelsesutbetaler | [default til null] |
| **fraSekvensnummer** | **String** | QueryParam. Angir at man kun ønsker trekkpålegg som er oppdateret etter forrige uthenting. Mest relevant for arbeidgivere med svært mange trekkpålegg | [default til null] |
| **KlientId** | **String** | Klientens unike id | [default til null] |
| **Korrelasjonsid** | **String** | Id for å spore kall på tvers av systemer | [default til null] |
| **Meldingsid** | **String** | Meldingsid mellom systemer | [default til null] |
| Navn | Type | Beskrivelse | Notater |
|----------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkpliktig** | **String** | Orgnummeret til den trekkpliktige arbeidsgiver/ytelsesutbetaler | [default til null] || **trekkpliktig** | **String** | Orgnummeret til den trekkpliktige arbeidsgiver/ytelsesutbetaler | [default til null] |
| **fraSekvensnummer** | **String** | QueryParam. Begrenser returnerte trekkpålegg til bare inneholde nyere enn angitt sekvensnummer. 0 eller større. Oppgis sammen med maksAntall. Mest relevant for trekkpliktige med svært mange trekkpålegg | [default til null] |
| **maksAntall** | **String** | QueryParam. Angir maks antall trekkpålegg som skal returneres. 1 eller større. Skal bare brukes sammen med fraSekvensnummer. Mest relevant for trekkpliktige med svært mange trekkpålegg | [default til null] |
| **KlientId** | **String** | Klientens unike id | [default til null] |
| **Korrelasjonsid** | **String** | Id for å spore kall på tvers av systemer | [default til null] |
| **Meldingsid** | **String** | Meldingsid mellom systemer | [default til null] |


### Retur type
Expand All @@ -48,11 +53,11 @@ Se [Tilgang](../tilgang.md)

<a name="hentVersjon"></a>

# **Hent versjon**
### Hent versjon

> **GET** /external/v1/trekkpaalegg/{trekkpliktig}/{trekkid}/{trekkversjon}
> **GET** /api/trekkpaalegg/v1/{trekkpliktig}/{trekkid}/{trekkversjon}
Henter angitt versjon av et trekkpålegg for den trekkpliktige.
Returnerer den angitte versjonen av et trekkpålegg

### Parametre

Expand Down
4 changes: 2 additions & 2 deletions docs/trekkpaalegg/feltbeskrivelser/Models/KidnummerForPeriode.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

| Navn | Type | Beskrivelse | Notater |
|-----------------|------------|--------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **aarOgMaaned** | **string** | År og måned på formatet 'yyyy-mm'. Forteller i hvilken periode kidnummeret skal benyttes. Samsvarer med rapporteringen i a-ordningen | [default til null] |
| **kidnummer** | **string** | Kidnummer for angitt periode | [default til null] |
| **aarOgMaaned** | **string** | År og måned på formatet 'yyyy-mm'. Forteller i hvilken måned kidnummeret skal benyttes. Samsvarer med rapporteringen i a-ordningen | [default til null] |
| **kidnummer** | **string** | Kidnummer for angitt måned | [default til null] |

[[Tilbake til modell liste]](../index.md)

15 changes: 0 additions & 15 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Prioritet.md
View file

This file was deleted.

6 changes: 3 additions & 3 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Trekkbeloep.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|-----------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkbeloep** | **Double** | tall som er satt sammen av en heltallsdel og en fraksjondel [wikipedia] ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b52aef-9fe1-11e5-a9f8-e4115b280940&#39)) | [default til null] |
| Navn | Type | Beskrivelse | Notater |
|-----------------|------------|-------------------------------------------------------------|--------------------|
| **trekkbeloep** | **Double** | Tall som er satt sammen av en heltallsdel og en fraksjondel | [default til null] |

[[Tilbake til modell liste]](../index.md)

27 changes: 13 additions & 14 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Trekkpaalegg.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|-------------------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkid** | **String** | Id til et trekkpålegg. Trekkpålegg med samme id kan bli oppdater. Da vil det få et nytt versjonsnummer. | [default til null] |
| **trekkversjon** | **Integer** | Versjonen til et trekkpålegg med en id. Inkrementeres med 1 for hver nye versjon. | [default til null] |
| **sekvensnummer** | **Integer** | Globalt løpenummer på tvers av alle trekkpålegg. Kan benyttes som et 'vannmerke' for å huske siste mottatte trekkpålegg. | [default til null] |
| **opprettet** | **Date** | En kombinasjon av typene Dato og Klokkeslett. Kodes som en tekststreng etter datoformatering spesifisert i ISO 8601 (ISO 8601:2004 Data elements and interchange formats -- Information interchange -- Representation of dates and times). ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b52aee-9fe1-11e5-a9f8-e4115b280940&#39)) | [default til null] |
| **saksnummer** | **String** | Identifiserer saken hvor trekkpålegget ble besluttet. | [default til null] |
| **trekkpliktig** | **String** | 9 sifret nummer gitt de som er registrert i Enhetsregisteret. ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b2e1a8-9fe1-11e5-a9f8-e4115b280940&#39) | [default til null] |
| **skyldner** | **String** | Fødsels eller dnummer til ansatt/ytelsesmottaker som skal trekkes i lønn/ytelse. | [default til null] |
| **trekkstatus** | [**Trekkstatus**](Trekkstatus.md) | Status på trekket. Når et trekkpålegg er avsluttet skal det ikke lenger trekkes. | [default til null] |
| **trekkstoerrelseForPeriode** | [**List**](TrekkstoerrelseForPeriode.md) | Liste over beløp eller prosentsats som skal trekkes. Den trekkpliktige må velge korrekt beløp eller prosent avhengig av utbetalingsdato for lønn/ytelse. | [default til null] |
| **kidnummerForPeriode** | [**List**](KidnummerForPeriode.md) | Liste over kidnummer som skal benyttes ved innbetaling. Den trekkpliktige må velge korrekt kidnummer i forhold til utbetalingsdato for lønn/ytelse. | [default til null] |
| **kontonummer** | **String** | Kontonummer som trekket skal betales til ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b2e328-9fe1-11e5-a9f8-e4115b280940&#39) | [default til null] |
| **prioritet** | [**Prioritet**](Prioritet.md) | Forteller hvordan ulike trekk på samme arbeidstaker skal prioriteres av en arbeidsgiver. Denne vil fases ut med innflring av nytt lovverk, ettersom trekkpliktig i praksis bare vil motta ett trekkpålegg for hver arbeidstaker, og da vil ikke lenger arbeidsgiver ha et behov for å prioritere mellom flere trekkpålegg | [default til null] |
| Navn | Type | Beskrivelse | Notater |
|-------------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkid** | **String** | Id til et trekkpålegg. Trekkpålegg med samme id kan bli oppdatert. Da vil det få et nytt versjonsnummer. | [default til null] |
| **trekkversjon** | **Integer** | Versjonen til et trekkpålegg med en id. Inkrementeres med 1 for hver nye versjon. | [default til null] |
| **sekvensnummer** | **Integer** | Globalt løpenummer på tvers av alle trekkpålegg. Kan benyttes som et 'vannmerke' for å huske siste mottatte trekkpålegg. | [default til null] |
| **opprettet** | **Date** | En kombinasjon av typene Dato og Klokkeslett. Kodes som en tekststreng etter datoformatering spesifisert i ISO 8601 (ISO 8601:2004 Data elements and interchange formats -- Information interchange -- Representation of dates and times). | [default til null] |
| **saksnummer** | **String** | Identifiserer saken hvor trekkpålegget ble besluttet. | [default til null] |
| **trekkpliktig** | **String** | Orgnummeret til den trekkpliktige. | [default til null] |
| **skyldner** | **String** | Fødsels- eller d-nummer til ansatt/ytelsesmottaker som skal trekkes i lønn/ytelse. | [default til null] |
| **trekkstatus** | [**Trekkstatus**](Trekkstatus.md) | Status på utleggstrekket. Når et trekkpålegg er avsluttet skal det ikke lenger trekkes i lønn/ytelse. | [default til null] |
| **trekkstoerrelseForPeriode** | [**List**](TrekkstoerrelseForPeriode.md) | Liste over beløp eller prosent som skal trekkes. Den trekkpliktige må velge korrekt beløp eller prosent avhengig av utbetalingsdatoen for lønnen/ytelsen. | [default til null] |
| **kidnummerForPeriode** | [**List**](KidnummerForPeriode.md) | Liste over kidnummer som skal benyttes ved innbetaling. Den trekkpliktige må velge det kidnummeret som gjelder måneden lønnen/ytelsen utbetales. | [default til null] |
| **kontonummer** | **String** | Kontonummer som trekket skal betales til. | [default til null] |

[[Tilbake til modell liste]](../index.md)

Loading

0 comments on commit b9f93d4

Please sign in to comment.