Skip to content

Commit

Permalink
Merge pull request #58 from Skatteetaten/FIUT-5431-trekkpaalegg-oppda…
Browse files Browse the repository at this point in the history 
…teringer

Fiut 5431 trekkpaalegg oppdateringer
  • Loading branch information
@HenningOlsgardSkatt
HenningOlsgardSkatt authored Sep 23, 2024
2 parents ca9a374 + 8aec18d commit 0c84c0a
Show file tree
Hide file tree
Showing 31 changed files with 242 additions and 286 deletions.
80 changes: 80 additions & 0 deletions docs/trekkpaalegg/apispesifikasjon/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# API Spesifikasjon

Skatteetaten tilbyr API for å hente trekkpålegg.

Open API spesifikasjonen er tilgjengelig her :

* [swaggerhub](https://app.swaggerhub.com/apis/skatteetaten/trekkpaalegg-app)

# Trekkpålegg API

Alle URIer er relative til *http://localhost:8080*

| 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**

> **GET** /external/v1/trekkpaalegg/{trekkpliktig}
Henter alle gjeldende trekkpålegg for den trekkpliktige.

### 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] |


### Retur type

Liste av [**Trekkpaalegg**](../feltbeskrivelser/Models/Trekkpaalegg.md)

### Autorisasjon

Se [Tilgang](../tilgang.md)

### HTTP request headere

- **Content-Type**: Ikke definert
- **Accept**: application/json, \*/\*

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

# **Hent versjon**

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

### Parametre

| Navn | Type | Beskrivelse | Notater |
|--------------------|------------|--------------------------------------------------------------|--------------------|
| **trekkpliktig** | **String** | Org-/fnr til den trekkpliktige arbeidsgiver/ytelsesutbetaler | [default til null] |
| **trekkid** | **String** | Id til trekkpålegget | [default til null] |
| **trekkversjon** | **String** | Versjonen til det angitte 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

[**Trekkpaalegg**](../feltbeskrivelser/Models/Trekkpaalegg.md)

### Autorisasjon

Se [Tilgang](../tilgang.md)

### HTTP request headere

- **Content-Type**: Ikke definert
- **Accept**: application/json, \*/\*
Binary file added docs/trekkpaalegg/bilder/informasjonsmodell-utleggstrekk-v1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/trekkpaalegg/bilder/oversikt.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
0 ...k-innbetaling-a-melding-og-avstemming.png → ...k-innbetaling-a-melding-og-avstemming.png
View file
File renamed without changes
12 changes: 12 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Feil.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Feil

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|--------------------|-------------|-------------|-------------------------------|
| **kode** | **String** | | [optional] [default til null] |
| **melding** | **String** | | [optional] [default til null] |
| **korrelasjonsid** | **Integer** | | [optional] [default til null] |

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

11 changes: 11 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/KidnummerForPeriode.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# KidnummerForPeriode

## Egenskaper

| 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] |

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

15 changes: 15 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Prioritet.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Trekkstatus

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|------|------|-------------|---------|
| A | | | |
| B | | | |
| C | | | |
| D | | | |
| E | | | |
| F | | | |

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

8 changes: 4 additions & 4 deletions ...kk/feltbeskrivelser/Models/TrekkBeloep.md → ...gg/feltbeskrivelser/Models/Trekkbeloep.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# TrekkBeloep
# Trekkbeloep

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|----------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkBeløp** | **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 [wikipedia] ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b52aef-9fe1-11e5-a9f8-e4115b280940&#39)) | [default til null] |

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

21 changes: 21 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Trekkpaalegg.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Trekkpaalegg

## 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] |

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

4 changes: 2 additions & 2 deletions ...k/feltbeskrivelser/Models/TrekkProsent.md → ...g/feltbeskrivelser/Models/Trekkprosent.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# TrekkProsent
# Trekkprosent

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| **trekkProsent** | **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] |
| **trekkprosent** | **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] |

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

11 changes: 11 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/Trekkstatus.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Trekkstatus

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|-----------|------|-------------|---------|
| aktiv | | | |
| avsluttet | | | |

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

13 changes: 13 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/Models/TrekkstoerrelseForPeriode.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# TrekkstoerrelseForPeriode

## Egenskaper

| Navn | Type | Beskrivelse | Notater |
|------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| **startdato** | **date** | gir verdier for år, måned og dag. 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). Eksempel : 1998-12-21 eller 19981221. ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b52aed-9fe1-11e5-a9f8-e4115b280940&#39)) | [default til null] |
| **sluttdato** | **date** | gir verdier for år, måned og dag. 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). Eksempel : 1998-12-21 eller 19981221. ([Begrapsreferanse](https://data.skatteetaten.no/begrep/20b52aed-9fe1-11e5-a9f8-e4115b280940&#39)) | [optional] [default til null] |
| **trekkbeloep** | [**Trekkbeloep**](Trekkbeloep.md) | Angi enten trekkbeløp eller trekkprosent | [optional] [default til null] |
| **trekkprosent** | [**Trekkprosent**](Trekkprosent.md) | Angi enten trekkbeløp eller trekkprosent | [optional] [default til null] |

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

21 changes: 21 additions & 0 deletions docs/trekkpaalegg/feltbeskrivelser/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Dokumentasjon for trekkpålegg

# Felter
- [Trekkpaalegg](./Models/Trekkpaalegg.md)
- [TrekkstoerrelseForPeriode](./Models/TrekkstoerrelseForPeriode.md)
- [Trekkbeloep](./Models/Trekkbeloep.md)
- [TrekkProsent](./Models/Trekkprosent.md)
- [KidnummerForPeriode](./Models/KidnummerForPeriode.md)
- [Trekkstatus](./Models/Trekkstatus.md)
- [Prioritet](./Models/Prioritet.md)
- [Feil](./Models/Feil.md)



# Oppfølging og støtte
I testfasen vil vi tilby støtte til de eksterne leverandørene gjennom utvikling og test. Mer informasjon kommer her etterhvert.
I mellomtiden – ta kontakt med [email protected].

# Grensesnitt for å innbetale og rapportere trekkpålegg
I tillegg til å trekke arbeidstakere i lønn skal også arbeidsgivere innbetale det som er trukket i lønn til skatteetaten, samt rapportere dette i A-meldingen.
Skatteetaten på sin side vil kontrollere at alle dataene er korrekte.
Loading

0 comments on commit 0c84c0a

Please sign in to comment.