Gå til innholdet

API-referanse

Referansen er delt i områder. Hver side lister metode, sti og rettigheten handleren krever, generert fra rutetabellen i koden. Forespørsels- og svarformer for de mest brukte kallene står i Eksempler. Hvert område peker til det tekniske dokumentet som forklarer reglene bak.

Område Omfang
Identitet og tilgang /me, medlemmer, roller, invitasjoner, byrå og oppdrag, abonnement, vilkår
Selskap og hovedbok Onboarding, kontoplan, bilag, vedlegg, periodelås, dimensjoner, årsavslutning
Salg og reskontro Faktura, tilbud, ordre, produkter, kunder, åpne poster
Regnskap og rapporter Spesifikasjoner, resultat, balanse, mva, SAF-T, revisjon, budsjett
Bank og betaling Avstemming, OCR, betalingslister, kort, valuta
Lønn, timer og utlegg Ansatte, lønn, a-melding, timer, utlegg
Innboks, import og jobber Bilagsinnboks, e-post-inn, SAF-T og CSV-import
Aksjeeierbok og anlegg Aksjonærer, utbytte, RF-1086, anleggsregister
Integrasjoner, agenter og meldinger Maskintilgang, agentoppgaver, samtaler
Forankring og verifisering Åpen feed, bevis per selskap
Plattform Leverandørens konsoll (ikke integrasjons-API)
  • Autentisering: Authorization: Bearer <token>. Se Autentisering.
  • Alle selskapsendepunkter ligger under /companies/{company_id}/…. Uten tilgang er svaret 404.
  • Beløp i øre, datoer YYYY-MM-DD, feil som {"error": "…"}. Se Konvensjoner.
  • Endepunkter som har en egen rettighet for «egne» og «alle» (_EGNE og _ALLE) lar _ALLE medføre _EGNE.
Sti Hvorfor
/, /callback, /assets/*, /ny, /portal-config, /manifest.webmanifest, /sw.js, ikoner Betjener nettportalen
/auth/token, /auth/refresh, /auth/logout, /auth/device, /auth/device/poll Portalens innlogging, ikke for integrasjoner
/webhooks/stripe, /webhooks/altinn Innkommende kall fra Stripe og Altinn, signert av dem. Ikke for deg å kalle

Den lengre, håndskrevne oversikten i repoet (docs/api.md) henger noe etter rutetabellen, og referansen her er generert fra koden.