Procountor-API (Application Programming Interface) is an interface that enables software queries from another software to Procountor. Procountor-API can be used with Procountor Financials product version (not with Procountor Ledger).
Overview
Procountor-API can be used to build value-added integrations between both commercial software and enterprise systems and Procountor. From the technological aspect, Procountor-API is based on REST (Representational State Transfer) technology, taking advantage of HTTP and supporting JSON format. OAuth2 process is used for authentication.
For Procountor-API's public documentation, visit the separate web site at https://dev.procountor.com/. For general questions related to the Procountor-API, and for additional order orders, our integration specialists can be reached at integrations@procountor.com.
Information about possible issues regarding API interface is presented in the Disruption info page.
Resources
Through the interface, it is possible to create, retrieve, update, and also delete different types of data comprehensively. The resources that are currently available in the interface are listed in the API Reference section of the documentation site. The interface uses HTTP methods as described below:
- GET - retrieve a resource, such as an invoice from Procountor
- POST - create a resource, such as a journal receipt to Procontor
- PUT - update a resource, for example accept a purchase invoice which is already found in Procountor
- DELETE - delete a resource, for example invalidate an invoice which is already found in Procountor
Procountor-API is constantly evolving and new resources will be added to it in the upcoming version updates. From the Release notes section of the documentation site, one can see which new parts will be published in the version releases and through the Subscribe section, it is also possible to join the API mailing list to get the API newsletter.
Pricing of the service
Procountor-API is an additional service for which a company-specific monthly fee will be charged according to Procountor's price list. Receipt fees for the receipts created to Procountor through the interface will be charged according to the price list. Additional API consultation is provided for going through the integration processes and interface documentation. Consultation can be ordered at integrations@procountor.com and pricing details are found in the price list.
Implementation of Procountor-API
Implementing the service requires that the integration from another software or system is built against Procountor-API. It is the customer's responsibility to build or find an integration partner to implement the integration to Procountor to send and receive API queries. Credentials and a separate environment for testing the API can be ordered through the form on our documentation site, found in this link. Testing is completely free of charge.
Ending the use of API
If you have multiple integrations and want to disable only some of them, you can either deactivate the technical/API user account or the active API key in your environment. The method of deactivation depends on the type of integration being used.
- API Key (M2M Authentication Model): If the integration uses an API key, you can remove the API key created for the specific integration in Procountor. Go to Basics (Human shaped icon) > API client Keys and select Revoke Key.
- Method (API Authentication Model with Refresh Token): If the integration uses the method with a refresh token, you can close any open session for the integration. Navigate to Basics (Human shaped icon) > API Client Sessions and choose Terminate Session.
- If you’re unsure which method your API interface uses, you can check both views.
To completely disable all API integrations, go to Management -> Company Info -> Usage Settings -> Integration Settings -> Allow the usage of invoiceable API clients.
Disabling the checkbox mentioned above will prevent all API integrations from functioning in the environment. However, it won’t affect integrations related to other products within the Procountor product family (such as Procountor Solo, Procountor Mobile App, Procountor Mini, Kassaturva, Procountor Toiminnanohjaus, eTasku, Ecom/EcomJet, Procountor TehoPalkat, and Mepco).
If there’s any external paid API integration active in your environment, usage fees for the API interface will apply on a monthly basis.
Additionally, if you’ve been using an external API integration and wish to discontinue its usage, it’s essential to inform the integration provider. They need to cease service usage and any billing on their end as well.