Innrapportering betalinger til selvstendig næringsdrivende API
For generell informasjon om tjenestene se egne sider om:
- Bruk av tjenestene
- Sikkerhetsmekansimer
- Systembruker
- Feilhåndtering
- Versjonering
- Teknisk spesifikasjon
Scope
Følgende scope skal benyttes ved autentisering i Maskinporten:
skatteetaten:innrapporteringbetalingerselvstendignaeringsdrivende
Delegering
Tilgang til dette API-et kan delegeres i Altinn, f.eks. dersom leverandør benyttes for den tekniske oppkoblingen.
Systemtilgang med systembruker
Bruk av API-et krever systemtilgang med systembruker, 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-betalinger-selvstendig-naeringsdrivende",
"id": "urn:altinn:resource"
}
]
}
]
Teknisk spesifikasjon
URL-er til API-et, beskrivelsen av parameterne, 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 innskudd, utlån og renter har to endepunkter:
- POST innsending: Mottar tredjepartsopplysninger om betalinger til selvstendig næringsdrivende. Et kall mot API-et sender inn rapportering om betalinger til selvstendig næringsdrivende for én oppgavegiver på et gitt inntektsår.
- GET uthenting_dokument: Henter ut ett 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 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.