Skip to main content
POST
/
v1
/
installations
/
me
Create a client installation
curl --request POST \
  --url https://external.pleo.io/v1/installations/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "metadata": {
    "externalConfigurationId": "123456789"
  },
  "status": "ACTIVATED"
}
'
{
  "applicationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2021-01-01T00:00:00Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {
    "key": "value"
  },
  "resource": "urn:pleo:company:123e4567-e89b-12d3-a456-426614174000",
  "status": "ACTIVATED",
  "updatedAt": "2021-01-01T00:00:00Z",
  "errorCode": "NOT_ENTITLED"
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Bearer <token>

Body

application/json;charset=UTF-8

Installation request

​
metadata
object

Metadata associated with the installation. This can be used to store additional information about the installation, for example external references, but it is not used by any Pleo system.

Example:
{ "externalConfigurationId": "123456789" }
​
status
enum<string>
ValueDescription
ACTIVATEDThe installation is active and operational.
INACTIVEThe installation is inactive and not currently in use.
AUTHORIZEDThe Pleo authorisation server has authorised the user, but the installation is not yet active or ready for use.
PENDING_INTEGRATIONThe 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.
ERRORThe installation has encountered an error and is not operational. An error code will be provided to explain the reason for the error.
Available options:
ACTIVATED,
INACTIVE,
AUTHORIZED,
PENDING_INTEGRATION,
ERROR

Response

Installation created.

​
applicationId
string<uuid>
required

The unique identifier of the application this installation is for.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
createdAt
string<date-time>
required

The date and time when the installation was created.

Example:

"2021-01-01T00:00:00Z"

​
id
string<uuid>
required

The unique identifier of the installation.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
metadata
object
required

Additional information about the installation.

Example:
{ "key": "value" }
​
resource
string
required

The resource that the installation is for.

Example:

"urn:pleo:company:123e4567-e89b-12d3-a456-426614174000"

​
status
string
required

This can be one of InstallationStatus values

Example:

"ACTIVATED"

​
updatedAt
string<date-time>
required

The date and time when the installation was last updated.

Example:

"2021-01-01T00:00:00Z"

​
errorCode
string

Explains the error that inactivated the installation. This appear if the installation status is inactive.

Example:

"NOT_ENTITLED"