Skip to main content
POST
/
v0
/
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"
  ],
  "type": "inclusive"
}
'
{
  "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.

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
​
pagination
object
required