EfterloensudbetalingService [UDV](Version 1, 2023-3)
Manuel udgave af servicesiden til specifikationsbrug
Indberetning af data vedrørende udbetaling af efterløn - en af flere FLEUR services
Metoder
CreateEfterloensudbetaling (POST /v1/Efterloensudbetaling)
(tidl. CreateEarlyRetirementPaymentData)
Metode til indberetning af data vedrørende udbetaling af efterløn indenfor en måned
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang |
---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 2920 dage efter medlemskab |
|
|
|
STAR | X |
|
|
|
|
|
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
x-civilRegistrationIdentifier [Header] | PersonCivilRegistrationIdentifierType | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Borgers personnummer |
x-requestId [Header] | string |
| 1 |
|
CreateEfterloensudbetalingRequest | CreateEarlyRetirementPaymentDataRequestType |
| 1 |
|
- efterloensudbetalingId | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Entydig identifikation af indberetningen. |
- udbetalingsmaaned | string | Længde: 7 tegn | 1 | Det år og den måned der indberettes for i formatet ÅÅÅÅ-MM, Fx 2017-07 for juli 2017. |
- udbetalteTimer | decimal | MinInclusive: 0 | 1 | Udbetalte timer i måneden. Decimaler angives i hundrededele. (Hvis der ikke er udbetalte timer angives 0) |
- efterloenTimesatsUdenPension | decimal | MinInclusive: 0 | 1 | Efterlønssatsen pr. time efter fradrag for pension |
- fradragIKroner | decimal | MinInclusive: 0 | 1 | Fradrag i kroner pr. måned for f.eks med udbetaling af feriekompensation eller udenlandsk social pension. |
- dageMedBelaegning | dageMedBelaegningDto |
| 0 - 1 | Samling af fradrag og andre belægninger for udbetaling af efterløn |
- - dagMedBelaegning | EarlyRetirementPaymentDataDaysWithDeductionType |
| 0 - * | Fradrag og andre belægninger. |
- - - dato | date |
| 1 | Dato. |
- - - belaegningssamling | EarlyRetirementPaymentDeductionTypeCollection |
| 1 | Liste som indeholder fradrag eller anden belægning med årsag. |
- - - - belaegning | EarlyRetirementPaymentDeductionType |
| 0 - * | Det enkelte Belaegning eller anden belægning. |
- - - - - belaegningIEfterloenType | BelaegningIEfterloenType |
| 1 | Årsag til fradrag eller anden belægning |
- - - - - timeantal | decimal | MinInclusive: 0 | 1 | Timer med fradrag eller anden belægning. Decimaler angives i hundrededele. |
- timerFrivilligtUloennetArbejde | decimal | MinInclusive: 0 | 0 - 1 | Summen af timer med frivilligt ulønnet arbejde i måneden (både med og uden fradrag).Decimaler angives i hundrededele. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | uuid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 0 - 1 | Unik identifikation for den oprettede entitet. |
Fejlkoder
Fejlkode | Ny Fejltekst | Fejltekst | Beskrivelse |
---|---|---|---|
4977 | Det angivne Id findes allerede i systemet | The submitted identifier already exists | The submitted identifier already exists |
9221 | Fradrags- eller belægningsdagen er ikke en del af måneden der rapporteres for | The date of deduction is not contained in the reported month | The date of deduction is not contained in the reported month |
9315 | Måneden der rapporteres ligger forud for servicens lovlige periode | The indicated month is earlier than accepted in this service | The indicated month is earlier than accepted in this service |
GetEfterloensudbetalinger (GET /v1/Efterloensudbetaling)
(tidl. EarlyRetirementPaymentData)
Metode til at hente de senest indberettede data vedr. efterlønsudbetaling for en eller flere måneder.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang |
---|---|---|---|---|---|---|
A-kasse |
| X | Fra 120 dage inden medlemskab til 2920 dage efter medlemskab |
|
|
|
STAR | X |
|
|
|
|
|
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetEfterloensudbetalingerRequest | GetEarlyRetirementPaymentDataRequestType |
| 1 |
|
- PersonCivilRegistrationIdentifier [Header] | PersonCivilRegistrationIdentifierType | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Borgers personnummer. |
- startEfterloensmaaned | string | Længde: 7 tegn | 1 | Det år og den måned der indberettes for i formatet ÅÅÅÅ-MM, Fx 2017-07 for juli 2017. |
- slutEfterloensmaaned | string | Længde: 7 tegn | 0 - 1 | Sidste måned (i et specifikt år) for udtrækket. Hvis ikke angivet, udtrækkes der frem til dags dato |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetEfterloenResponse | GetEarlyRetirementPaymentDataResponseType |
| 1 |
|
- efterloensmaaneder | EarlyRetirementPaymentReportingMonthGetTypeCollection |
| 1 |
|
- - efterloensmaaned | EarlyRetirementPaymentReportingMonthGetType |
| 0 - * | De måneder der returneres. |
- - - organisationType | Ydelsesudstilling.OrganisationTypeIdentifierType |
| 1 | Hvilken type organisation har foretaget registreringen |
- - - organisationskode | string |
| 1 | Hvilken organisation har foretaget registreringen |
- - - efterloensudbetalingId | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Entydig identifikation af indberetningen. |
- - - udbetalingsmaaned | string | Længde: 7 tegn | 1 | Det år og den måned der indberettes for i formatet ÅÅÅÅ-MM, Fx 2017-07 for juli 2017. |
- - - udbetaltetimer | decimal | FractionDigits: 2 | 1 | Udbetalte timer i måneden.Decimaler angives i hundrededele. (Hvis der ikke er udbetalte timer angives 0). |
- - - efterloenTimesatsUdenPension | decimal | FractionDigits: 2 | 1 | Efterlønssatsen pr. time efter fradrag for pension |
- - - fradragIKroner | decimal | FractionDigits: 2 | 0 - 1 | Fradrag i kr. pr. måned for f. eks. med udbetaling af feriekompensation eller udenlandsk social pension |
- - - dageMedBelaegning | EarlyRetirementPaymentDataDaysWithDeductionGetTypeCollection |
| 0 - 1 | Samling af fradrag eller anden belægning for udbetaling af efterløn. |
- - - - dagMedBelaegning | EarlyRetirementPaymentDataDaysWithDeductionGetType |
| 0 - * | Fradrag eller anden belægning. |
- - - - - dato | date |
| 1 | Dato. |
- - - - - belaegningssamling | EarlyRetirementPaymentDeductionGetTypeCollection |
| 1 | Liste som indeholder fradrag eller anden belægningmed årsag. |
- - - - - - belaegning | EarlyRetirementPaymentDeductionGetType |
| 0 - * | Det enkelte fradrag eller anden belægning. |
- - - - - - belaegningIEfterloenType CauseForDeductionInEarlyRetirementPaymentTypeIdentifier | BelaegningIEfterloenType |
| 1 | Årsag til fradrag eller anden belægning |
- - - - - - - timeantal | decimal | FractionDigits: 2 | 1 | Timer med fradrag eller anden belægning. Decimaler angives i hundrededele. |
- - - timerFrivilligtUloennetArbejde | decimal |
| 0 - 1 | Summen af timer med frivilligt ulønnet arbejde i måneden (både timer med og uden fradrag). Timer (2 decimaler). Decimaler angives i hundrededele. |
- - - dfdgRegistreringstidspunkt | dateTime |
| 1 | Indberetningsdato. |
Fejlkoder
Fejlkode | Dansk fejltekst | Fejltekst | Beskrivelse |
---|---|---|---|
4589 | Det angivne id er ikke kendt i systemet | Unknown identifier | The submitted Identifier is unknown to the system |
XXX | Den angivne maaned overholder ikke formatet ÅÅÅÅ-MM, fx 2017-07 for juli 2017 |
|
|
DeleteEfterloensudbetaling (DELETE /v1/Efterloensudbetaling/{efterloensudbetalingId})
(tidl. DeleteEarlyRetirementPaymentData)
Metoden slettemarkerer den seneste efterlønsudbetaling fra den pågældende a-kasse i den pågældende måned.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang |
---|---|---|---|---|---|---|
A-kasse | X |
|
|
|
|
|
STAR | X |
|
|
|
|
|
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
DeleteEfterloensudbetaling | DeleteEarlyRetirementPaymentDataRequestType |
| 1 |
|
- PersonCivilRegistrationIdentifier [Header] | PersonCivilRegistrationIdentifierType | Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000 | 1 | Borgers personnummer |
- efterloensudbetalingId | guid | Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} | 1 | Entydig identifikation af indberetningen. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
(tomt response) | EmptyResponseType |
| 1 | Tom kvittering |
Fejlkoder
Fejlkode | Dansk fejltekst | Fejltekst | Beskrivelse |
---|---|---|---|
4575 | Star.foundation fejl som ikke annoteres på servicen | You are not authorized | You are not authorized to execute the operation |
4589 | Det angivne id er ikke kendt i systemet | Unknown identifier | The submitted Identifier is unknown to the system |