> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pleo

> How to set up the Pleo connector, plus the actions that are available.

![Pleo](https://stackone-logos.com/api/pleo/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/pleo/changelog.md)

[89 actions](#actions) · 2 auth methods

Expense Management
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/pleo/guides/connector-profile/api-key.md)
>
> Uses a standalone API key from the Pleo Web App, which reaches the companies chosen in its access level. Pleo must turn...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/pleo/guides/connector-profile/oauth-2-0.md)
>
> Requires an OAuth client registered with Pleo through its Technology Partner Early Access Programme. Uses PKCE, and each...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/pleo/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/pleo/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

accountCategory:read

accountCategory:write

accounting-entries:read

accounting-entries:write

accounts:read

accounts:write

companies:read

company-balance:read

export-items:read

export-jobs:read

export-jobs:write

tag-groups:read

tag-groups:write

tax-codes:read

tax-codes:write

team:delete

team:read

team:write

users:read

vendors:read

vendors:write

No scopes found

89 actions

ActionDescriptionRequired scopes

Fetch A Single Accounting Entry By Id`pleo_external_get_accounting_entry`

Fetch a single accounting entry by id

`accounting-entries:read`

Fetch Accounting Entries Based On Filters`pleo_external_search_accounting_entries`

Fetch accounting entries based on filters

`accounting-entries:read`

Enrich Accounting Entry V2`pleo_enrich_accounting_entry`

Enrich Accounting Entry V2

`accounting-entries:write`

Create A New Account`pleo_create_account`

The integration sends a request to this endpoint to create a corresponding account in Pleo for any new record created in...

`accounts:write`

Create Multiple Accounts In A Single Request`pleo_create_accounts_batch`

Create multiple accounts in a single request

`accounts:write`

Delete An Account`pleo_delete_account`

Deletes an existing account in Pleo

`accounts:write`

Fetch A List Of Accounts`pleo_search_accounts`

Retrieves a list of accounts with companyId and other optional filters

`accounts:read`

Retrieve An Account In Pleo By Its ID`pleo_get_account`

Retrieve an account in Pleo by its ID

`accounts:read`

Update An Account`pleo_update_account`

Update details of an existing account in Pleo

`accounts:write`

Create A New Bookkeeping Category`pleo_create_bookkeeping_category`

Create a bookkeeping category, an expense purpose, inside a category group

`accountCategory:write`

Delete A Bookkeeping Category`pleo_delete_bookkeeping_category`

Delete one bookkeeping category by its ID

`accountCategory:write`

Fetch A List Of Bookkeeping Categories`pleo_search_bookkeeping_categories`

Search bookkeeping categories, the individual expense purposes

`accountCategory:read`

Retrieve A Bookkeeping Category By Its ID`pleo_get_bookkeeping_category`

Get one bookkeeping category, an expense purpose, by its ID

`accountCategory:read`

Update A Bookkeeping Category`pleo_update_bookkeeping_category`

Update one bookkeeping category, an expense purpose

`accountCategory:write`

Get Aggregated Bookkeeping Category Groups`pleo_get_aggregated_bookkeeping_category_groups`

List bookkeeping category groups for a company, each with its bookkeeping categories nested inside

`accountCategory:read`

Create A New Bookkeeping Category Group`pleo_create_bookkeeping_category_group`

Create a bookkeeping category group that organises categories

`accountCategory:write`

Delete A Bookkeeping Category Group`pleo_delete_bookkeeping_category_group`

Delete a whole bookkeeping category group by its ID

`accountCategory:write`

Fetch A List Of Bookkeeping Category Groups`pleo_search_bookkeeping_category_groups`

Search bookkeeping category groups, the collections that hold categories

`accountCategory:read`

Retrieve A Bookkeeping Category Group By Its ID`pleo_get_bookkeeping_category_group`

Get one bookkeeping category group by its ID

`accountCategory:read`

Update A Bookkeeping Category Group`pleo_update_bookkeeping_category_group`

Update a whole bookkeeping category group

`accountCategory:write`

Get Company`pleo_get_company`

Get a Pleo company by ID.

`companies:read`

Search For Companies`pleo_search_for_companies`

Use this endpoint to search for companies associated with a specific organisation

`companies:read`

Get The Balance For A Company`pleo_get_external_balance`

Get the balance for a company

`company-balance:read`

Create A New Tag Group Dimension`pleo_create_tag_group_dimension`

Create a dimension, an extra attribute column, on a tag group

`tag-groups:write`

Delete A Tag Group Dimension`pleo_delete_tag_group_dimension`

Delete a dimension definition from a tag group

`tag-groups:write`

Retrieve A List Of Tag Group Dimensions`pleo_get_tag_group_dimensions`

Retrieve a list of tag group dimensions

`tag-groups:read`

Retrieve A Tag Group Dimension`pleo_get_tag_group_dimension`

Get one dimension definition of a tag group

`tag-groups:read`

Update A Tag Group Dimension`pleo_update_tag_group_dimension`

Change the definition of a dimension on a tag group

`tag-groups:write`

Create A New Dimension Value`pleo_create_dimension_value`

Set the value one tag holds for one dimension

`tag-groups:write`

Delete A Dimension Value`pleo_delete_dimension_value`

Remove the value one tag holds for one dimension

`tag-groups:write`

Retrieve Dimension Values`pleo_get_tag_dimension_values`

List all dimension values of one tag

`tag-groups:read`

Retrieve A Dimension Value`pleo_get_dimension_value`

Get the value one tag holds for one specific dimension

`tag-groups:read`

Update A Dimension Value`pleo_update_dimension_value`

Change the value one tag holds for one dimension

`tag-groups:write`

List Employees`pleo_list_employees`

List the employees of the companies the Pleo API key can reach.

`users:read`

Get Employee`pleo_get_employee`

Get a Pleo employee by ID.

`users:read`

Get Export Items`pleo_get_export_items`

An export item = an accounting entry transformed into an exportable entry

`export-items:read`

Create A New Tag Group`pleo_create_tag_group`

Create a tag group, the container that holds tags, in Pleo

`tag-groups:write`

Delete A Tag Group`pleo_delete_tag_group`

Delete a whole tag group by its ID

`tag-groups:write`

Retrieve The Tag Groups For A Company Or An Organisation In Aggregated Format`pleo_get_aggregated_tag_groups`

List tag groups together with their dimensions in one response

`tag-groups:read`

Retrieve Tag Groups For A Company Or An Organisation`pleo_get_tag_groups`

List the tag group records of a company or organisation

`tag-groups:read`

Returns An Aggregated Tag Group By Its ID`pleo_get_aggregated_tag_group_by_id`

Get one tag group by ID together with its dimensions

`tag-groups:read`

Retrieve A Tag Group By Its ID`pleo_get_tag_group`

Get one tag group record by its ID

`tag-groups:read`

Update A Tag Group`pleo_update_tag_group`

Rename or change the details of a whole tag group

`tag-groups:write`

Get Unified Credentials`pleo_unified_get_me`

Get the current Pleo connection's unified credentials.

List Unified Groups`pleo_unified_list_groups`

List unified groups in Pleo.

`team:read`

Get Unified Group`pleo_unified_get_group`

Get a unified Pleo group by ID.

`team:read`

List Unified Users`pleo_unified_list_users`

List unified users in Pleo.

`users:read`

Get Unified User`pleo_unified_get_user`

Get a unified Pleo user by ID.

`users:read`

Get API Key Details`pleo_get_introspection`

Get the details of the Pleo API key the connection uses.

Create A New Export Job`pleo_create_export_job`

Use this endpoint to create a new export job that would transfer a list of specific accounting entries from Pleo to the...

`export-jobs:write`

Create An Export Job Event`pleo_create_export_job_event`

Create an Export Job Event

`export-jobs:write`

Get A List Of Export Jobs`pleo_get_export_jobs_list`

Get a list of Export Jobs

`export-jobs:read`

Get An Export Job`pleo_get_export_job_by_id`

Retrieve an export job by a specific export job ID

`export-jobs:read`

Get Export Job Items`pleo_get_export_job_items`

An export job item tracks the export progress of a specific accounting entry in an export job

`export-jobs:read`

Update Export Job Items`pleo_update_export_job_items`

Update the status and other attributes of the export job items in batches of 100

`export-jobs:write`

Get All Receipts Of An Accounting Entry`pleo_get_all_receipts`

Get all receipts of an accounting entry

`accounting-entries:read`

Returns A Receipt With Time Bound Access To The Receipt File`pleo_get_receipt_file`

Returns a receipt with time-bound access to the receipt file

`accounting-entries:read`

Apply Filters To Search For Specific Accounting Entry Receipts`pleo_search_receipts_by_post`

Apply filters to search for specific accounting entry receipts

`accounting-entries:read`

Create A Subscription`pleo_create_subscription`

Creates a subscription for given event type(s)

Delete Subscription By Id`pleo_delete_subscription`

Delete subscription by id

Get Subscription Activities`pleo_get_subscription_activities`

List the delivery and change activity recorded for a webhook subscription

Get Subscription By Id`pleo_get_subscription_by_id`

Fetches subscription details by the specific subscription ID

Get Subscription Secret By Id`pleo_get_subscription_secret`

Get subscription secret by id

Get Subscriptions`pleo_get_subscriptions`

Retrieves a list of subscriptions for the specific event types (registered for the specific company or organisation by t...

Update A Subscription`pleo_update_subscription`

Modifies the subscription details

Create A New Tag For A Tag Group`pleo_create_tag`

Create a tag, one selectable value, inside an existing tag group

`tag-groups:write`

Delete A Tag`pleo_delete_tag`

Delete a tag from its tag group by the tag ID

`tag-groups:write`

Retrieve A Tag By Its ID`pleo_get_tag`

Get one tag by its ID

`tag-groups:read`

Retrieve Tags For A Tag Group`pleo_get_tags`

Retrieve tags for a tag group

`tag-groups:read`

Retrieve Tags In Aggregated Format`pleo_search_aggregated_tags`

Retrieve tags in aggregated format

`tag-groups:read`

Update A Tag`pleo_update_tag`

Change the name, code or archived state of one tag

`tag-groups:write`

Create A Tax Code`pleo_create_tax_code`

Create a tax code for a company with its rate, type and tax accounts

`tax-codes:write`

Delete A Tax Code`pleo_delete_tax_code`

Delete a tax code by its ID

`tax-codes:write`

Get A Tax Code`pleo_get_tax_code`

Get one tax code by its ID, with its rate, type and tax accounts

`tax-codes:read`

Returns A List Of Tax Codes`pleo_get_tax_codes`

Returns a list of tax codes

`tax-codes:read`

Update A Tax Code`pleo_update_tax_code`

Replace the name, code, rate, type or tax accounts of a tax code

`tax-codes:write`

List Teams`pleo_list_teams`

List the teams of the Pleo company or organisation.

`team:read`

Get Team`pleo_get_team`

Get a Pleo team by ID, with its member ids.

`team:read`

Add Members To A Team`pleo_add_team_members`

Use this endpoint to add one or more Employees to a Team

`team:write`

Create A Team`pleo_create_team`

Use this endpoint to create a new team for the company or organisation the access token is scoped to

`team:write`

Delete A Team By ID`pleo_delete_team_by_id`

Use this endpoint to delete a specific team by its teamId

`team:delete`

Remove A Member From A Team`pleo_remove_team_member`

Remove a member from a Team

`team:write`

Partially Update A Team`pleo_update_team`

Use this endpoint to update a Team's name and/or code

`team:write`

Activate A Vendor`pleo_activate_vendor`

Updates the vendor state to Active, reflecting its availability in the target ERP/accounting system

`vendors:write`

Archive A Vendor`pleo_archive_vendor_by_id`

Archives a Vendor in Pleo by its id

`vendors:write`

Create A New Vendor`pleo_post_vendor`

This endpoint has the following functions - - Create a corresponding record in Pleo for any new vendor created in the ER...

`vendors:write`

Fetches Vendors By Search Criteria`pleo_search_vendors`

Fetches Vendors by search criteria

`vendors:read`

Retrieves A Vendor In Pleo By Its Id`pleo_get_vendor_by_id`

Retrieves a Vendor in Pleo by its id

`vendors:read`

Update A Vendor`pleo_update_vendor`

Updates a Vendor for a company in Pleo

`vendors:write`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.