Fetch a list of accounts

curl --request POST \
  --url https://external.pleo.io/v1/chart-of-accounts:search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "companyId": "123e4567-e89b-12d3-a456-426614174011",
  "archived": false,
  "code": "2001",
  "externalId": "123e4567-e89b-12d3-a456-426614174011",
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "name": "Bank Charges"
}
'

import requests

url = "https://external.pleo.io/v1/chart-of-accounts:search"

payload = {
    "companyId": "123e4567-e89b-12d3-a456-426614174011",
    "archived": False,
    "code": "2001",
    "externalId": "123e4567-e89b-12d3-a456-426614174011",
    "ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "name": "Bank Charges"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json;charset=UTF-8"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json;charset=UTF-8'
  },
  body: JSON.stringify({
    companyId: '123e4567-e89b-12d3-a456-426614174011',
    archived: false,
    code: '2001',
    externalId: '123e4567-e89b-12d3-a456-426614174011',
    ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    name: 'Bank Charges'
  })
};

fetch('https://external.pleo.io/v1/chart-of-accounts:search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://external.pleo.io/v1/chart-of-accounts:search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companyId' => '123e4567-e89b-12d3-a456-426614174011',
    'archived' => false,
    'code' => '2001',
    'externalId' => '123e4567-e89b-12d3-a456-426614174011',
    'ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'name' => 'Bank Charges'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json;charset=UTF-8"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://external.pleo.io/v1/chart-of-accounts:search"

	payload := strings.NewReader("{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json;charset=UTF-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://external.pleo.io/v1/chart-of-accounts:search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v1/chart-of-accounts:search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "accountingSystem": "xero",
      "archived": false,
      "code": "2001",
      "companyId": "123e4567-e89b-12d3-a456-426614174006",
      "externalId": "External Id",
      "id": "123e4567-e89b-12d3-a456-426614174005",
      "name": "Bank Charges",
      "taxCodeExternalId": "IVA 20"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {}
    },
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "string",
    "total": 1
  }
}

"Bad request: for example, missing required fields, tax code does not exist in Pleo."

POST

chart-of-accounts:search

Fetch a list of accounts

curl --request POST \
  --url https://external.pleo.io/v1/chart-of-accounts:search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "companyId": "123e4567-e89b-12d3-a456-426614174011",
  "archived": false,
  "code": "2001",
  "externalId": "123e4567-e89b-12d3-a456-426614174011",
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "name": "Bank Charges"
}
'

import requests

url = "https://external.pleo.io/v1/chart-of-accounts:search"

payload = {
    "companyId": "123e4567-e89b-12d3-a456-426614174011",
    "archived": False,
    "code": "2001",
    "externalId": "123e4567-e89b-12d3-a456-426614174011",
    "ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "name": "Bank Charges"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json;charset=UTF-8"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json;charset=UTF-8'
  },
  body: JSON.stringify({
    companyId: '123e4567-e89b-12d3-a456-426614174011',
    archived: false,
    code: '2001',
    externalId: '123e4567-e89b-12d3-a456-426614174011',
    ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    name: 'Bank Charges'
  })
};

fetch('https://external.pleo.io/v1/chart-of-accounts:search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://external.pleo.io/v1/chart-of-accounts:search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companyId' => '123e4567-e89b-12d3-a456-426614174011',
    'archived' => false,
    'code' => '2001',
    'externalId' => '123e4567-e89b-12d3-a456-426614174011',
    'ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'name' => 'Bank Charges'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json;charset=UTF-8"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://external.pleo.io/v1/chart-of-accounts:search"

	payload := strings.NewReader("{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json;charset=UTF-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://external.pleo.io/v1/chart-of-accounts:search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v1/chart-of-accounts:search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n  \"companyId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"archived\": false,\n  \"code\": \"2001\",\n  \"externalId\": \"123e4567-e89b-12d3-a456-426614174011\",\n  \"ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"name\": \"Bank Charges\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "accountingSystem": "xero",
      "archived": false,
      "code": "2001",
      "companyId": "123e4567-e89b-12d3-a456-426614174006",
      "externalId": "External Id",
      "id": "123e4567-e89b-12d3-a456-426614174005",
      "name": "Bank Charges",
      "taxCodeExternalId": "IVA 20"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {}
    },
    "endCursor": "string",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "string",
    "total": 1
  }
}

"Bad request: for example, missing required fields, tax code does not exist in Pleo."

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

before

string

Lower bound of the page of data to return (cannot be used together with [after] or [offset])

after

string

Upper bound of the page of data to return (cannot be used together with [before] or [offset])

offset

integer<int64>

Offset of the page of data to return (cannot be used together with [before] or [after])

limit

integer<int32>

The maximum amount of items to return

sorting_keys

string[]

The keys to sort the results by

sorting_order

enum<string>[]

The order to sort the results by. Must be the same length as [sortingKeys]; one order per key

Available options:

ASC,

ASC_NULLS_FIRST,

ASC_NULLS_LAST,

DESC,

DESC_NULLS_FIRST,

DESC_NULLS_LAST

Body

application/json;charset=UTF-8

Represents a request to search for accounts.

companyId

string<uuid>

required

Filter by company ID.

Example:

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

archived

boolean | null

Filter by archived status.

Example:

false

code

string | null

Search by code.

Example:

"2001"

externalId

string | null

Search by external id.

Example:

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

ids

(string<uuid> | null)[] | null

Filter by a list of account IDs.

name

string | null

Search by name.

Example:

"Bank Charges"

Response

Retrieval of accounts successful.

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

ABOUT THE PLEO API

EXPORT API

TAGS API

TAX CODE API

APP MARKETPLACE API

EMPLOYEES API

BOOKKEEPING CORE API

WEBHOOK SUBSCRIPTIONS API

COMPANIES API

VENDORS API

PLEO.IO API (DEPRECATED)

Fetch a list of accounts

Authorizations

Query Parameters

Body

Response