Økonomitjenester - Eksport av fakturaer fra Klubbadmin
- Sigurd Sagen
Disse tjenestene avvikles 01.02.2025 - de er erstattet med nye tjenester: Klubbadmin - eksport av betalinger (BETA)
Disse tjenestene er tilgjengelige kun over SOAP.
Introduksjon
Denne siden forklarer hvordan man som tredjepart kan få tilgang til å eksportere faktura og betalingsobjekter fra klubbadmin via våre soap tjenester knyttet til Klubbadmin
Hvordan komme igang
For å få tilgang til tjenestene for eksport av betalingsobjekter kreves det at det inngås en integrasjonsavtale mellom systemleverandøren og NIF Digital.
For mer informasjon om en integrasjonsavtale, ta kontakt med oss direkte.
Brukertilgang
Våre soaptjenester har et komplekst brukerhierarki, hvor NIF gir tilgang til metoder ved behov og basert på kriteriene som integrasjonsavtalen beskriver.
En typisk integrasjonsavtale med en systemleverandør for regnskapssystemer vil ha følgende tilgangskontroll, hvor de har en eller flere kunder (idrettslag) i sin portefølje:
Systemleverandør vil få en masterbruker, som har tilgang til en spesifikk metode som tillater partneren å generere en tilgang på et sett med metoder for eksport, for en spesifikk organisasjon. Med masterbrukeren kan man som systemleverandør opprette tilgang til sin kunde selv, uten å kontakte NIF support. Organisasjonsbrukeren vil dermed få tilgang til de predefinerte metodene som trengs for å utføre det integrasjonsavtalen regulerer.
Oppbygningen av brukernavnet for å spørre i metodene:
Brukernavn og passord legges inn i soap header objektet i din request. Brukernavnet er bygget opp som du ser i eksempelet.
<aut:Username>AppID/FunctionID/UserName</aut:Username>
<aut:Password>PassordSomErOpprettet</aut:Password>AppID: Denne får du av NIF Digital
FunctionID: Dette får du når du oppretter OrgBrukeren
UserName: Dette oppretter du selv når du kjører CreateIntegratorUser
Hele brukernavnet består derfor av tre komponenter, og skilles med /
Arkitektur og dataflyt
Tegningen viser et eksempel på dataflyt og systemsamspill, som kan være et ideelt integrasjonsoppsett for en systemleverandør av f.eks regnskapssystemer.
Tegningen er å anse som et high level arkitekturforslag.
Kodeeksempler
GetChangesPayment (på orgid)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:syn="http://www.idrett.no/Services/SynchronizationService/">
<soap:Header xmlns:aut="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<aut:Security mustUnderstand="true">
<aut:UsernameToken>
<aut:Username>AppID/FunctionID/UserName</aut:Username>
<aut:Password>PassordSomErOpprettet</aut:Password>
</aut:UsernameToken>
</aut:Security></soap:Header>
<soap:Body>
<syn:SynchronizationSimpleRequest>
<syn:FromDate>2021-04-05T00:00:00</syn:FromDate>
<syn:ToDate>2021-04-30T00:00:00</syn:ToDate>
</syn:SynchronizationSimpleRequest>
</soap:Body>
</soap:Envelope>Eksempelet viser hvordan man henter ut alle fakturaobjekter innenfor en gitt tidsperiode
GetPaymentDetailsByIds (på orgid, og ider fra resultatet fra spørringen over )
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:pay="http://www.idrett.no/Services/PaymentService/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<soap:Header xmlns:aut="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<aut:Security mustUnderstand="true">
<aut:UsernameToken>
<aut:Username>AppID/FunctionID/UserName</aut:Username>
<aut:Password>PassordSomErOpprettet</aut:Password>
</aut:UsernameToken>
</aut:Security></soap:Header>
<soap:Body>
<pay:PaymentIdsRequest>
<pay:PaymentsIds>
<arr:int>100428401</arr:int>
<arr:int>100429340</arr:int>
<arr:int>100429497</arr:int>
</pay:PaymentsIds>
</pay:PaymentIdsRequest>
</soap:Body>
</soap:Envelope>Eksempelet viser hvordan man henter ut tre stk fakturaobjekter fra Klubbadmin basert på ID.
Endepunkter
Oversikt over metoder som trengs for å eksportere betalingsobjekter fra klubbadmin via SOAP webservices.
Navn | Beskrivelse | URL | Scope |
|---|---|---|---|
CreateIntegrationUser | Metode for å opprette nye OrgBrukere, som gir tilgang til metodene som trengs for å oppfylle integrasjonsavtalen. | Masterbruker | |
GetChangesPayment | Metode for å hente ut betalingsobjekter som har oppstått eller endret seg, innenfor ett gitt tidsintervall | OrgBruker | |
GetPaymentsDetailsByID | Metode for å hente ut betalingsdetaljer på ID (som du får fra GetChangesPayment) | OrgBruker | |
GetPaymentsDetailsByIDs | Metode for å hente ut betalingsdetaljer på flere ID’er (som du får fra GetChangesPayment) | OrgBruker |
Annet