curl --request GET \
--url https://api.zivio.net/api/v4/tax_types \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/tax_types"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/tax_types', 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://api.zivio.net/api/v4/tax_types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/tax_types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/tax_types")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/tax_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_bodyList Tax Types
Retrieve a paginated list of tax_types. Use filters to narrow results.
Filtering
Use the filter[<attribute>] parameter to filter results. Multiple filters are combined with AND logic.
Basic Examples
# Equality (implicit)
GET /api/v4/tax_types?filter[label]=active
# Multiple values (implicit IN)
GET /api/v4/tax_types?filter[label]=draft,pending
# With explicit operator
GET /api/v4/tax_types?filter[created_at][gte]=2024-01-01
# Range query
GET /api/v4/tax_types?filter[rate][between]=0.05,0.5
# Multiple filters (AND)
GET /api/v4/tax_types?filter[label]=active&filter[rate][gte]=0.05
Available Attributes
| Attribute | Type | Operators | Permitted Values |
|---|---|---|---|
| archived | boolean | eq, not_eq | - |
| country_code | string | eq, not_eq, in, not_in, like, not_like | - |
| created_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
| domestic_recharge | boolean | eq, not_eq | - |
| id | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| key | string | eq, not_eq, in, not_in, like, not_like | - |
| label | string | eq, not_eq, in, not_in, like, not_like | - |
| rate | decimal | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| tax_reference | integer | eq, not_eq, in, not_in, gt, gte, lt, lte, between | - |
| updated_at | datetime | eq, not_eq, gt, gte, lt, lte, between | - |
Custom Fields
This resource supports custom field filtering using cf[key] syntax:
# Equality
GET /api/v4/tax_types?cf[priority]=high
# With operator
GET /api/v4/tax_types?cf[department][in]=engineering,design
# Check existence
GET /api/v4/tax_types?cf[priority][exists]=
# Negation
GET /api/v4/tax_types?cf[priority][not_eq]=low
OR Conditions
Use or[group] to combine filter groups with OR logic. Filters within a group are ANDed:
# Simple OR
GET /api/v4/tax_types?or[1][label]=pending&or[2][label]=active
# Complex OR (label=pending AND rate>=0.05) OR (label=active)
GET /api/v4/tax_types?or[1][label]=pending&or[1][rate][gte]=0.05&or[2][label]=active
Sorting
Use sort[<attribute>] to order results. Default direction is ascending.
# Ascending (implicit)
GET /api/v4/tax_types?sort[created_at]=
# Descending
GET /api/v4/tax_types?sort[created_at]=desc
# Combined with filters
GET /api/v4/tax_types?filter[label]=active&sort[created_at]=desc
curl --request GET \
--url https://api.zivio.net/api/v4/tax_types \
--header 'Authorization: Bearer <token>' \
--header 'zivio-tenant-id: <api-key>'import requests
url = "https://api.zivio.net/api/v4/tax_types"
headers = {
"Authorization": "Bearer <token>",
"zivio-tenant-id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};
fetch('https://api.zivio.net/api/v4/tax_types', 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://api.zivio.net/api/v4/tax_types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zivio-tenant-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zivio.net/api/v4/tax_types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("zivio-tenant-id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zivio.net/api/v4/tax_types")
.header("Authorization", "Bearer <token>")
.header("zivio-tenant-id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zivio.net/api/v4/tax_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'
response = http.request(request)
puts response.read_bodyAuthorizations
OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.
Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.
Query Parameters
Page number for pagination
Number of results per page (max 100)
x <= 100Filterable attributes:
integer (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): id, tax_reference datetime (operators: eq, not_eq, gt, gte, lt, lte, between): created_at, updated_at string (operators: eq, not_eq, in, not_in, like, not_like): country_code, key, label decimal (operators: eq, not_eq, in, not_in, gt, gte, lt, lte, between): rate boolean (operators: eq, not_eq): archived, domestic_recharge
Note: like is a case-insensitive substring match — pass the bare term (filter[title][like]=redesign). Do not add % wildcards; they are not needed.
OR condition groups. Filters within a group are ANDed; groups are ORed.
Syntax: or[group_key][<attribute>]=value or or[group_key][<attribute>][operator]=value
Examples:
- Simple OR:
or[1][state]=draft&or[2][state]=pending - Complex:
or[1][state]=draft&or[1][budget][gte]=50000&or[2][state]=closed - With custom fields:
or[1][cf][priority]=high&or[2][state]=pending
Group keys can be any string (1, 2, a, b, etc.) - they just need to be unique.
Custom field filters using concise syntax.
Syntax:
- Equality:
cf[key]=value - With operator:
cf[key][operator]=value
Operators: eq (default), not_eq, in, not_in, contains, not_contains, exists, not_exists
Examples:
cf[priority]=high- exact matchcf[department][in]=eng,design- matches anycf[priority][not_eq]=low- not equalcf[notes][contains]=urgent- contains textcf[legacy_field][exists]=- field exists (value ignored)cf[deprecated][not_exists]=- field does not exist
Custom field filters within OR condition groups.
Syntax: or[group][cf][key]=value or or[group][cf][key][operator]=value
Example: or[1][cf][priority]=high&or[2][state]=pending
Sort results by attribute. Direction defaults to ascending.
Syntax: sort[<attribute>]= (ascending) or sort[<attribute>]=desc (descending)
Sortable attributes: archived, country_code, created_at, domestic_recharge, id, key, label, rate, tax_reference, updated_at
Examples:
- Ascending:
sort[created_at]=orsort[created_at]=asc - Descending:
sort[created_at]=desc
Response
List of tax_types
Show child attributes
Show child attributes

