Innrapportering Skattefrie utbetalinger fra offentlige myndigheter API
For generell informasjon om tjenestene se egne sider om:
- Bruk av tjenestene
- Sikkerhetsmekansimer
- Systemtilgang
- Feilhåndtering
- Versjonering
- Teknisk spesifikasjon
Scope
Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:innrapporteringskattefrieutbetalinger
Delegering
Tilgang til dette API-et kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen.
Systemtilgang
Bruk av API-et krever systemtilgang, som er ny funksjonalitet i Maskinporten levert av Digdir. Informasjon vedr. dette finnes her.
For å kunne benytte dette api-et med systemtilgang må man gi følgende rettighet til systemet ved opprettelse i systemregisteret:
"Rights": [
{
"Resource": [
{
"value": "ske-innrapportering-skattefrie-utbetalinger",
"id": "urn:altinn:resource"
}
]
}
]
Teknisk spesifikasjon
URL-er til API-et, beskrivelse av parametere, endepunkter og respons ligger i Open API spesifikasjonen på SwaggerHub
Nødvendige åpninger i en evt. brannmur er beskrevet her
API-et for innrapportering av skattefrie utbetalinger fra offentlige myndigheter har to endepunkter
- POST innsending: Mottar tredjepartsopplysninger for skattefrie utbetalinger. Et kall mot API-et er en rapportering for en organisasjon gitt av en oppgavegiver og som gjelder et inntektsår.
- GET uthenting_dokument: Henter ut et spesifikt dokument knyttet til en transmission i dialogporten
API-et validerer mottatte data mot JSON schema beskrevet på SwaggerHub. Se feilkoder for relaterte feilmeldinger.
Se også eksempler for de ulike endepunktene.
Parameter: idempotencyKey
idempotencyKey
-parameteren er påkrevet. Innholdet skal være en unik UUID. Hvert nye kall til API-et skal ha en
tilsvarende ny idempotencyKey. Flere etterfølgende POST kall med samme request-body og samme idempotencyKey vil gi den
samme responsen. Kun det første av denne rekken med like API kall vil behandles. IdempotencyKey muliggjør at man trygt
kan prøve innsendinger på nytt der man av ulike årsaker ikke har fått en tilbakemelding fra API-et.
Datakatalog
Dette API-et er pt. ikke dokumentert i Felles datakatalog.