Create tax

POST

admin

api

accounts

taxes

Create tax

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/accounts/taxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "VAT 20%",
  "type_tax_use": "sale",
  "amount_type": "percent",
  "amount": 20,
  "tax_group_id": 1,
  "invoice_repartition_lines": [
    {
      "repartition_type": "base",
      "factor_percent": null,
      "account_id": null,
      "use_in_tax_closing": false
    },
    {
      "repartition_type": "tax",
      "factor_percent": 100,
      "account_id": 1,
      "use_in_tax_closing": false
    }
  ],
  "refund_repartition_lines": [
    {
      "repartition_type": "base",
      "factor_percent": null,
      "account_id": null,
      "use_in_tax_closing": false
    },
    {
      "repartition_type": "tax",
      "factor_percent": 100,
      "account_id": 1,
      "use_in_tax_closing": false
    }
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/taxes"

payload = {
    "name": "VAT 20%",
    "type_tax_use": "sale",
    "amount_type": "percent",
    "amount": 20,
    "tax_group_id": 1,
    "invoice_repartition_lines": [
        {
            "repartition_type": "base",
            "factor_percent": None,
            "account_id": None,
            "use_in_tax_closing": False
        },
        {
            "repartition_type": "tax",
            "factor_percent": 100,
            "account_id": 1,
            "use_in_tax_closing": False
        }
    ],
    "refund_repartition_lines": [
        {
            "repartition_type": "base",
            "factor_percent": None,
            "account_id": None,
            "use_in_tax_closing": False
        },
        {
            "repartition_type": "tax",
            "factor_percent": 100,
            "account_id": 1,
            "use_in_tax_closing": False
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'VAT 20%',
    type_tax_use: 'sale',
    amount_type: 'percent',
    amount: 20,
    tax_group_id: 1,
    invoice_repartition_lines: [
      {
        repartition_type: 'base',
        factor_percent: null,
        account_id: null,
        use_in_tax_closing: false
      },
      {
        repartition_type: 'tax',
        factor_percent: 100,
        account_id: 1,
        use_in_tax_closing: false
      }
    ],
    refund_repartition_lines: [
      {
        repartition_type: 'base',
        factor_percent: null,
        account_id: null,
        use_in_tax_closing: false
      },
      {
        repartition_type: 'tax',
        factor_percent: 100,
        account_id: 1,
        use_in_tax_closing: false
      }
    ]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'VAT 20%',
    'type_tax_use' => 'sale',
    'amount_type' => 'percent',
    'amount' => 20,
    'tax_group_id' => 1,
    'invoice_repartition_lines' => [
        [
                'repartition_type' => 'base',
                'factor_percent' => null,
                'account_id' => null,
                'use_in_tax_closing' => false
        ],
        [
                'repartition_type' => 'tax',
                'factor_percent' => 100,
                'account_id' => 1,
                'use_in_tax_closing' => false
        ]
    ],
    'refund_repartition_lines' => [
        [
                'repartition_type' => 'base',
                'factor_percent' => null,
                'account_id' => null,
                'use_in_tax_closing' => false
        ],
        [
                'repartition_type' => 'tax',
                'factor_percent' => 100,
                'account_id' => 1,
                'use_in_tax_closing' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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"
  },
  "message": "Tax created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

Tax name. Must not be greater than 255 characters.

Example:

"VAT 20%"

type_tax_use

enum<string>

required

Tax type usage.

Available options:

sale,

purchase,

none

Example:

"sale"

amount_type

enum<string>

required

Tax computation type.

Available options:

fixed,

group,

percent,

division,

code

Example:

"percent"

amount

number

required

Tax amount/percentage. Must be at least 0.

Example:

20

tax_group_id

integer

required

Tax group ID. The id of an existing record in the accounts_tax_groups table.

Example:

1

invoice_repartition_lines

object[]

required

Tax repartition lines for invoices (at least 1 base and 1 tax line required). For updates: include "id" to update existing line, omit to create new. Lines not included will be deleted. Must have at least 2 items.

Show child attributes

Example:

[
  {
    "repartition_type": "base",
    "factor_percent": null,
    "account_id": null,
    "use_in_tax_closing": false
  },
  {
    "repartition_type": "tax",
    "factor_percent": 100,
    "account_id": 1,
    "use_in_tax_closing": false
  }
]

refund_repartition_lines

object[]

required

Tax repartition lines for refunds (must match invoice lines structure). For updates: include "id" to update existing line, omit to create new. Lines not included will be deleted. Must have at least 2 items.

Show child attributes

Example:

[
  {
    "repartition_type": "base",
    "factor_percent": null,
    "account_id": null,
    "use_in_tax_closing": false
  },
  {
    "repartition_type": "tax",
    "factor_percent": 100,
    "account_id": 1,
    "use_in_tax_closing": false
  }
]

company_id

integer | null

Company ID. The id of an existing record in the companies table.

Example:

1

country_id

integer | null

Country ID. The id of an existing record in the countries table.

Example:

233

tax_scope

enum<string> | null

Tax scope.

Available options:

service,

consu

Example:

"service"

price_include_override

enum<string> | null

Price include override.

Available options:

default,

tax_included,

tax_excluded

Example:

"default"

cash_basis_transition_account_id

integer | null

Cash basis transition account ID. The id of an existing record in the accounts_accounts table.

Example:

1

description

string | null

Tax description.

Example:

"Standard VAT rate"

invoice_label

string | null

Label to display on invoices. Must not be greater than 255 characters.

Example:

"VAT"

invoice_legal_notes

string | null

Legal notes to display on invoices.

Example:

"Subject to VAT regulations"

tax_exigibility

string | null

Tax exigibility. Must not be greater than 255 characters.

Example:

"on_invoice"

is_active

boolean | null

Tax status active/inactive.

Example:

false

include_base_amount

boolean | null

Include base amount in tax calculation.

Example:

false

is_base_affected

boolean | null

Is base affected by other taxes.

Example:

false

analytic

boolean | null

Enable analytic accounting.

Example:

false

Response

Created

⌘I

Create tax

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/accounts/taxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "VAT 20%",
  "type_tax_use": "sale",
  "amount_type": "percent",
  "amount": 20,
  "tax_group_id": 1,
  "invoice_repartition_lines": [
    {
      "repartition_type": "base",
      "factor_percent": null,
      "account_id": null,
      "use_in_tax_closing": false
    },
    {
      "repartition_type": "tax",
      "factor_percent": 100,
      "account_id": 1,
      "use_in_tax_closing": false
    }
  ],
  "refund_repartition_lines": [
    {
      "repartition_type": "base",
      "factor_percent": null,
      "account_id": null,
      "use_in_tax_closing": false
    },
    {
      "repartition_type": "tax",
      "factor_percent": 100,
      "account_id": 1,
      "use_in_tax_closing": false
    }
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/taxes"

payload = {
    "name": "VAT 20%",
    "type_tax_use": "sale",
    "amount_type": "percent",
    "amount": 20,
    "tax_group_id": 1,
    "invoice_repartition_lines": [
        {
            "repartition_type": "base",
            "factor_percent": None,
            "account_id": None,
            "use_in_tax_closing": False
        },
        {
            "repartition_type": "tax",
            "factor_percent": 100,
            "account_id": 1,
            "use_in_tax_closing": False
        }
    ],
    "refund_repartition_lines": [
        {
            "repartition_type": "base",
            "factor_percent": None,
            "account_id": None,
            "use_in_tax_closing": False
        },
        {
            "repartition_type": "tax",
            "factor_percent": 100,
            "account_id": 1,
            "use_in_tax_closing": False
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'VAT 20%',
    type_tax_use: 'sale',
    amount_type: 'percent',
    amount: 20,
    tax_group_id: 1,
    invoice_repartition_lines: [
      {
        repartition_type: 'base',
        factor_percent: null,
        account_id: null,
        use_in_tax_closing: false
      },
      {
        repartition_type: 'tax',
        factor_percent: 100,
        account_id: 1,
        use_in_tax_closing: false
      }
    ],
    refund_repartition_lines: [
      {
        repartition_type: 'base',
        factor_percent: null,
        account_id: null,
        use_in_tax_closing: false
      },
      {
        repartition_type: 'tax',
        factor_percent: 100,
        account_id: 1,
        use_in_tax_closing: false
      }
    ]
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'VAT 20%',
    'type_tax_use' => 'sale',
    'amount_type' => 'percent',
    'amount' => 20,
    'tax_group_id' => 1,
    'invoice_repartition_lines' => [
        [
                'repartition_type' => 'base',
                'factor_percent' => null,
                'account_id' => null,
                'use_in_tax_closing' => false
        ],
        [
                'repartition_type' => 'tax',
                'factor_percent' => 100,
                'account_id' => 1,
                'use_in_tax_closing' => false
        ]
    ],
    'refund_repartition_lines' => [
        [
                'repartition_type' => 'base',
                'factor_percent' => null,
                'account_id' => null,
                'use_in_tax_closing' => false
        ],
        [
                'repartition_type' => 'tax',
                'factor_percent' => 100,
                'account_id' => 1,
                'use_in_tax_closing' => false
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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"
  },
  "message": "Tax created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Get started

Endpoints

Authorizations

Body

Response