List taxes

GET

admin

api

accounts

taxes

List taxes

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/accounts/taxes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/accounts/taxes', 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://erp.arukz.com/admin/api/v1/accounts/taxes",
  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>"
  ],
]);

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

curl_close($curl);

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

{
  "data": [
    {
      "id": 1,
      "type_tax_use": "sale",
      "tax_scope": null,
      "amount_type": "percent",
      "price_include_override": null,
      "tax_exigibility": "on_invoice",
      "name": "15 %",
      "description": "<p>CESS 5%</p>",
      "invoice_label": "Tax 15 %",
      "invoice_legal_notes": null,
      "amount": "15.0000",
      "is_active": 1,
      "include_base_amount": 1,
      "is_base_affected": 0,
      "analytic": null,
      "sort": 1,
      "company_id": 1,
      "tax_group_id": 1,
      "cash_basis_transition_account_id": null,
      "country_id": 233,
      "creator_id": 1,
      "created_at": "2026-01-07T11:08:43.000000Z",
      "updated_at": "2026-01-07T11:08:43.000000Z",
      "invoice_repartition_lines": [],
      "refund_repartition_lines": []
    },
    {
      "id": 1,
      "type_tax_use": "sale",
      "tax_scope": null,
      "amount_type": "percent",
      "price_include_override": null,
      "tax_exigibility": "on_invoice",
      "name": "15 %",
      "description": "<p>CESS 5%</p>",
      "invoice_label": "Tax 15 %",
      "invoice_legal_notes": null,
      "amount": "15.0000",
      "is_active": 1,
      "include_base_amount": 1,
      "is_base_affected": 0,
      "analytic": null,
      "sort": 1,
      "company_id": 1,
      "tax_group_id": 1,
      "cash_basis_transition_account_id": null,
      "country_id": 233,
      "creator_id": 1,
      "created_at": "2026-01-07T11:08:43.000000Z",
      "updated_at": "2026-01-07T11:08:43.000000Z",
      "invoice_repartition_lines": [],
      "refund_repartition_lines": []
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Query Parameters

include

string

Comma-separated list of relationships to include.

Available options: company, taxGroup, cashBasisTransitionAccount, country, creator, childrenTaxes, invoiceRepartitionLines, refundRepartitionLines

Example:

"invoiceRepartitionLines,refundRepartitionLines"

filter[id]

string

Comma-separated list of IDs to filter by

filter[name]

string

Filter by tax name (partial match)

filter[company_id]

integer

Filter by company ID

filter[tax_group_id]

integer

Filter by tax group ID

filter[country_id]

integer

Filter by country ID

filter[type_tax_use]

enum<string>

Filter by tax type usage

Available options:

sale,

purchase,

none

filter[amount_type]

enum<string>

Filter by amount type

Available options:

fixed,

group,

percent,

division,

code

filter[tax_scope]

enum<string>

Filter by tax scope

Available options:

service,

consu

filter[price_include_override]

enum<string>

Filter by price include override

Available options:

default,

tax_included,

tax_excluded

filter[is_active]

boolean

Filter by active status

sort

string

required

Sort field

Example:

"sort"

page

integer

required

Page number

Example:

1

Response

Success

⌘I

List taxes

curl --request GET \
  --url https://erp.arukz.com/admin/api/v1/accounts/taxes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://erp.arukz.com/admin/api/v1/accounts/taxes', 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://erp.arukz.com/admin/api/v1/accounts/taxes",
  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>"
  ],
]);

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

curl_close($curl);

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

{
  "data": [
    {
      "id": 1,
      "type_tax_use": "sale",
      "tax_scope": null,
      "amount_type": "percent",
      "price_include_override": null,
      "tax_exigibility": "on_invoice",
      "name": "15 %",
      "description": "<p>CESS 5%</p>",
      "invoice_label": "Tax 15 %",
      "invoice_legal_notes": null,
      "amount": "15.0000",
      "is_active": 1,
      "include_base_amount": 1,
      "is_base_affected": 0,
      "analytic": null,
      "sort": 1,
      "company_id": 1,
      "tax_group_id": 1,
      "cash_basis_transition_account_id": null,
      "country_id": 233,
      "creator_id": 1,
      "created_at": "2026-01-07T11:08:43.000000Z",
      "updated_at": "2026-01-07T11:08:43.000000Z",
      "invoice_repartition_lines": [],
      "refund_repartition_lines": []
    },
    {
      "id": 1,
      "type_tax_use": "sale",
      "tax_scope": null,
      "amount_type": "percent",
      "price_include_override": null,
      "tax_exigibility": "on_invoice",
      "name": "15 %",
      "description": "<p>CESS 5%</p>",
      "invoice_label": "Tax 15 %",
      "invoice_legal_notes": null,
      "amount": "15.0000",
      "is_active": 1,
      "include_base_amount": 1,
      "is_base_affected": 0,
      "analytic": null,
      "sort": 1,
      "company_id": 1,
      "tax_group_id": 1,
      "cash_basis_transition_account_id": null,
      "country_id": 233,
      "creator_id": 1,
      "created_at": "2026-01-07T11:08:43.000000Z",
      "updated_at": "2026-01-07T11:08:43.000000Z",
      "invoice_repartition_lines": [],
      "refund_repartition_lines": []
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "/?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "/",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

{
  "message": "Unauthenticated."
}

Get started

Endpoints

Authorizations

Query Parameters

Response