Innrapportering aksjonærregisteroppgave API
For generell informasjon om tjenestene se egne sider om:
Scope
Følgende scope skal benyttes ved autentisering i Maskinporten: skatteetaten:innrapporteringaksjonaerregisteroppgave
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.
Dette API-et krever at systemet og dets systembrukere har tilgang til én eller flere av følgende tilgangspakker:
"accessPackages": [
{
"urn": "urn:altinn:accesspackage:regnskapsforer-med-signeringsrettighet"
},
{
"urn": "urn:altinn:accesspackage:ansvarlig-revisor"
},
{
"urn": "urn:altinn:accesspackage:skattegrunnlag"
},
{
"urn": "urn:altinn:accesspackage:revisormedarbeider"
}
]
Teknisk spesifikasjon
URL-er til API-et, beskrivelsen av parameterne, endepunkter og respons ligger i Open API spesifikasjonen på SwaggerHub
Oppbygning av URL-er og åpninger i en evt. brannmur er beskrevet her Brannmur
API-et for innsending av aksjonaerregisteroppgaven har bare fem endepunkter:
- POST hovedskjema: Mottar hovedskjema for aksjonærregisteroppgaven
- POST underskjema: Mottar underskjema for aksjonærregisteroppgaven
- POST bekreft: Bekrefter at alle underskjemaer er innsendt og oppgaven er klar til videre behandling
- GET dokumenter: Henter ut flere dokumenter fra en forsendelse
- Dette endepunktet anbefales brukt om man ønsker å hente ut alle innsendte hoved/underskjemaer. Endepunktet kan levere opp til 50 skjemaer pr kall og hovedskjemaet vil alltid være første skjema på første page.
- GET dokument: Henter ut et enkelt dokument fra en forsendelse
- Dette endepunktet anbefales brukt om man skal hente ut enkeltdokumenter som f.eks tilbakemeldinger.
Innsendt data på hovedskjema endepunktet valideres etter følgende xsd: hovedskjema
Innsendt data på underskjema endepunktet valideres etter følgende xsd: underskjema
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.