Returns a list of tax codes

curl --request POST \
  --url https://external.pleo.io/v0/tax-codes:search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "archived": true,
  "taxCodeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://external.pleo.io/v0/tax-codes:search"

payload = {
    "archived": True,
    "taxCodeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
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({archived: true, taxCodeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://external.pleo.io/v0/tax-codes: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/v0/tax-codes: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([
    'archived' => true,
    'taxCodeIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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/v0/tax-codes:search"

	payload := strings.NewReader("{\n  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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/v0/tax-codes:search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v0/tax-codes: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  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "data": [
    {
      "archived": true,
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Standardmoms (25 %)",
      "rate": 123,
      "type": "inclusive",
      "updatedAt": "2023-11-07T05:31:56Z",
      "accountingIntegrationSystem": "<string>",
      "code": "01",
      "ingoingTaxAccount": "<string>",
      "outgoingTaxAccount": "<string>"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

POST

tax-codes:search

Returns a list of tax codes

curl --request POST \
  --url https://external.pleo.io/v0/tax-codes:search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "archived": true,
  "taxCodeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

import requests

url = "https://external.pleo.io/v0/tax-codes:search"

payload = {
    "archived": True,
    "taxCodeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
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({archived: true, taxCodeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};

fetch('https://external.pleo.io/v0/tax-codes: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/v0/tax-codes: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([
    'archived' => true,
    'taxCodeIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  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/v0/tax-codes:search"

	payload := strings.NewReader("{\n  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\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/v0/tax-codes:search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json;charset=UTF-8")
  .body("{\n  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://external.pleo.io/v0/tax-codes: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  \"archived\": true,\n  \"taxCodeIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

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

{
  "data": [
    {
      "archived": true,
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Standardmoms (25 %)",
      "rate": 123,
      "type": "inclusive",
      "updatedAt": "2023-11-07T05:31:56Z",
      "accountingIntegrationSystem": "<string>",
      "code": "01",
      "ingoingTaxAccount": "<string>",
      "outgoingTaxAccount": "<string>"
    }
  ],
  "pagination": {
    "currentRequestPagination": {
      "parameters": {},
      "after": "<string>",
      "before": "<string>",
      "limit": 123,
      "offset": 123,
      "sortingKeys": [
        "<string>"
      ],
      "sortingOrder": [
        "ASC"
      ]
    },
    "hasNextPage": true,
    "hasPreviousPage": true,
    "endCursor": "<string>",
    "startCursor": "<string>",
    "total": 123
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

company_id

string<uuid>

Fetch a list of tax codes for a given company

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

archived

boolean

If set to true will only return tax codes that have been archived, if set to false will only return tax codes that have not been archived. By default,both archived and non-archived tax codes will be returned.

taxCodeIds

string<uuid>[]

Useful for fetching a list of tax codes given a specific list of IDs.

type

enum<string>

Classification of the tax codes to fetch

Available options:

inclusive,

exclusive,

reverse

Response

default - application/json;charset=UTF-8

default response

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)

Returns a list of tax codes

Authorizations

Query Parameters

Body

Response