Tässä ohjeessa kerrotaan, miten API-integraation käyttöoikeudet määritellään Finago Procountorissa ja miten ne vaikuttavat API -rajapinnan kautta tehtäviin toimenpiteisiin.
Käyttöoikeuksien asettaminen
API-integraatioyhteys on liitettynä yhteen Procountor-ympäristön käyttäjään. Kyseiselle käyttäjälle Procountorissa asetetut käyttöoikeudet määrittävät, mitä toimenpiteitä rajapinnan kautta pystyy tekemään.
Rajapinnassa pätevät samat käyttöoikeudet ja rajoitukset kuin mitä käyttäjälle on määritelty ohjelmassa. Mikäli käyttäjällä ei ole oikeutta tiettyyn toiminnallisuuteen ohjelmassa, ei sama toiminto ole mahdollista myöskään API-rajapinnan kautta.
Suosittelemme, että integraatiota varten perustetaan Procountor-ympäristöön oma käyttäjä, eli niin sanottu API-käyttäjä. Tällöin integraatioon liitettävän käyttäjän käyttöoikeudet voidaan määrittää juuri kyseisen integraation tarpeisiin sopiviksi.
Jos integraatio on jo otettu käyttöön, voit tarkistaa integraatioon liitetyn käyttäjän seuraavilta näkymiltä:
- API-avainta käyttävissä integraatioissa näet, mille käyttäjälle API-avain on luotu Procountorin API-avaimet -näkymällä, jonne pääset oikean yläkulman Henkilöhahmo-kuvakkeesta
- Avoimet API-Client-istunnot näet valitsemalla oikean yläkulman Henkilöhahmo-kuvakkeesta API client istunnot.
Pääset määrittelemään käyttöoikeudet käyttäjälle Procountorin Käyttäjät ja käyttöoikeudet – näkymällä.
Käyttöoikeuksien määrittelyssä voit hyödyntää Procountoriin luotuja käyttäjärooleja. Roolin asettamisen jälkeen käyttöoikeuksia voidaan tarvittaessa laajentaa tai supistaa.
API-käyttäjän käyttöoikeudet
Alle on koottu keskeisimpien rajapinnan kautta suoritettavien toimintojen edellyttämiä käyttöoikeuksia.
Käyttöoikeudet tulee määrittää laajimman tarpeen mukaan. Tietojen hakemiseen Procountorista riittävät katseluoikeudet. Uusien tietojen luominen sekä tietojen käsittely tai muokkaaminen edellyttävät täydet käyttöoikeudet.
Myyntilaskut ja niiden käsittely
Käyttäjärooli Myynti sopii usein pohjaksi, jos integraatiossa siirretään myyntilaskuja toisesta järjestelmästä Procountoriin. Poista tarvittaessa oikeudet osto- sekä matka- ja kululaskuihin, jos niitä ei tarvita.
Myyntilaskujen luonti (POST /invoices)
Käyttöoikeus myynti- ja joukkolaskuille | Kaikki oikeudet
Myyntilaskujen hyväksyntä (PUT /invoices/{invoiceId}/approve) ja lähetys (PUT /invoices/{invoiceId}/send)
Käyttöoikeus myynti- ja joukkolaskuille | Kaikki oikeudet
Myyntilaskujen haku | Katseluoikeudet
Myyntilaskujen haku Procountorista (GET /invoices, type SALES_INVOICE)
Käyttöoikeus myynti- ja joukkolaskuille | Katseluoikeudet
Myyntilaskujen haku | Katseluoikeudet
Myyntien tuoterekisteri
Myyntituotteiden hakeminen Procountorista (GET/products)
Myyntien tuoterekisteri | Katseluoikeudet
Uusien tuotteiden luonti (POST /products) tai muokkaaminen myyntien tuorekisterissä (PUT /products/{productId})
Myyntien tuoterekisteri | Kaikki oikeudet
Asiakasrekisteri
Asiakasrekisterin tietojen hakeminen Procountorista (GET /businesspartners)
Asiakasrekisteri | Katseluoikeudet
Uusien asiakkaiden luonti (POST /businesspartners) tai muokkaaminen asiakasrekisterissä (PUT & PATCH /businesspartners/{id})
Asiakasrekisteri | Kaikki oikeudet
Ostolaskut ja niiden käsittely
Käyttäjärooli Osto sopii usein pohjaksi, jos integraatiossa käsitellään ostolaskuja. Poista tarvittaessa oikeudet myynti- sekä matka- ja kululaskuihin, jos niitä ei tarvita.
Ostolaskujen hakeminen Procountorista (GET /invoices, type PURCHASE_INVOICE)
Ostolaskujen haku | Katseluoikeudet
Ostolaskujen luonti (POST /invoices)
Käyttöoikeus ostolaskuille | Kaikki oikeudet
Ostolaskujen asiatarkastaminen (PUT /invoices/{invoiceId}/verify)
Käyttöoikeus ostolaskuille | Katseluoikeudet
Ostolaskujen haku | Katseluoikeudet
Asiatarkastaminen | Kaikki oikeudet
Ostolaskujen hyväksyminen (PUT /invoices/{invoiceId}/approve)
Käyttöoikeus ostolaskuille | Katseluoikeudet
Ostolaskujen haku | Katseluoikeudet
Hyväksyminen | Kaikki oikeudet
Toimittajarekisteri
Asiakasrekisterin tietojen hakeminen Procountorista (GET /businesspartners)
Toimittajarekisteri | Katseluoikeudet
Uusien toimittajien luonti (POST /businesspartners) tai muokkaaminen toimittajaekisterissä (PUT & PATCH /businesspartners/{id})
Toimittajarekisteri | Kaikki oikeudet
Ostojen tuoterekisteri
Ostotuotteiden hakeminen Procountorista (GET/products)
Ostojen tuoterekisteri | Katseluoikeudet
Uusien tuotteiden luonti (POST /products) tai muokkaaminen ostojen tuorekisterissä (PUT /products/{productId})
Ostojen tuoterekisteri | Kaikki oikeudet
Kirjanpitodata ja sen käsittely
Dimensioiden (Hallinta > Kirjanpidon tiedot > Dimensiot) hakeminen Procountorista (GET /dimensions)
Kirjanpidon perustiedot | Katseluoikeudet
Uusien nimikkeiden luonti (POST /dimensions/{dimensionId}/items)
Kirjanpidon perustiedot | Kaikki oikeudet
Kirjanpitotositteiden hakeminen Procountorista (GET /ledgerreceipts)
Katseluoikeudet haluttuun tositetyyppiin ja niiden hakuun.
Esimerkiksi myyntilaskujen (type SALES_INVOICE) kirjanpitotositteiden hakeminen:
Käyttöoikeus myynti- ja joukkolaskuille | Katseluoikeudet
Myyntilaskujen haku | Katseluoikeudet
Esimerkiksi ostolaskujen (type PURCHASE_INVOICE) kirjanpitotositteiden hakeminen:
Käyttöoikeus ostolaskuille | Katseluoikeudet
Ostolaskujen haku | Katseluoikeudet
Muistiotositteiden haku | Katseluoikeudet
Jos integraation kautta halutaan hakea kaikki kirjanpitodata, sopii roolin pohjaksi Johto/Tarkastaja, jolla on oikeudet nähdä kaikki data, mutta ei oikeutta tehdä muokkauksia.
Kirjanpitotositteiden muokkaaminen (PUT /ledgerreceipts/id)
Käyttöoikeudet haluttuun tositetyyppiin ja niiden hakuun.
Esimerkiksi myyntilaskujen (type SALES_INVOICE) kirjanpitotositteiden muokkaaminen:
Käyttöoikeus myynti- ja joukkolaskuille | Kaikki oikeudet
Myyntilaskujen haku | Katseluoikeudet
Esimerkiksi ostolaskujen (type PURCHASE_INVOICE) kirjanpitotositteiden muokkaaminen:
Käyttöoikeus ostolaskuille | Kaikki oikeudet
Ostolaskujen haku | Katseluoikeudet
Muistiotositteiden haku | Katseluoikeudet
Muistiotositteet ja niiden käsittely
Muistiotositteiden luonti (POST /ledgerreceipts)
Käyttöoikeus muistiotositteille | Kaikki oikeudet
Muistiotositteiden hyväksyminen (PUT /ledgerreceipts/{receiptId}/approve)
Muistiotositteiden haku | Katseluoikeudet
Käyttöoikeus muistiotositteille | Kaikki oikeudet