Overview

Pleo as a spend management platform can be integrated with other third-party ERP/accounting applications or Human Resources Information Systems (HRIS) to make it more optimised for our customers. These applications make Pleo more dynamic and are useful in automating workflows and supporting additional functionalities.

All these applications that are available for integration with your Pleo account are listed in the App Marketplace.

Installations

An installation is an integration between an application and a Pleo subject. When an application is installed for a Pleo subject, an installation is created.

As an external developer, you can manage the installations of your application using the Installations API. The API allows you to create, update, and delete installations, as well as retrieve information about them.

The installation has a metadata attribute that the application uses to store additional information about the installation. This can be useful for storing configuration settings or other data specific to the installation. This data is in no way used or processed by Pleo, and is only stored for the application to use.

Creating Installations

OAuth

If you are using OAuth 2.0 as your authorisation method, the installation would automatically complete when the OAuth process is finished. If the application that you have installed requires configurations for activation, you might need to send a request to the POST Activate the installation for a client endpoint to set the status to ACTIVATED. Otherwise, the installation is created with the status ACTIVATED by default.

Installation Status

There are the following possible status of an installation:

StatusDescription
AUTHORIZEDThe user has completed the authorisation process, but the installation is not yet active or ready for use.
ACTIVATEDThe installation is active and ready for use.
INACTIVEThe installation is inactive and cannot be used. This status occurs after multiple failed attempts to connect to the target application. It also happens if the authorisation method used for the installation is no longer valid, for example using expired refresh tokens for the integration.
PENDING_INTEGRATIONThis status occurs when the integration is synchronising or performing other background tasks. When an installation is in progress, the integration synchronises the user's Pleo account with the target application, so that tax codes, tags, and vendors are all similar in both Pleo and the third-party application. The user must not disconnect the application in this state; else there would be data loss.