Taxes
Part of the Accounts API. Base URL https://your-domain.com/admin/api/v1 — replace the host with your own installation and the token placeholder with a real Bearer token (see Authentication).
List taxes
GET/admin/api/v1/accounts/taxesRetrieve a paginated list of taxes with filtering and sorting
🔒 Requires a valid Bearer token.
Query parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
include | string | No | Comma-separated list of relationships to include. Available options: company, taxGroup, cashBasisTransitionAccount, country, creator, childrenTaxes, invoiceRepartitionLines, refundRepartitionLines | invoiceRepartitionLines,refundRepartitionLines |
filter[id] | string | No | Comma-separated list of IDs to filter by | |
filter[name] | string | No | Filter by tax name (partial match) | |
filter[company_id] | integer | No | Filter by company ID | |
filter[tax_group_id] | integer | No | Filter by tax group ID | |
filter[country_id] | integer | No | Filter by country ID | |
filter[type_tax_use] | string | No | Filter by tax type usage | |
filter[amount_type] | string | No | Filter by amount type | |
filter[tax_scope] | string | No | Filter by tax scope | |
filter[price_include_override] | string | No | Filter by price include override | |
filter[is_active] | boolean | No | Filter by active status | |
sort | string | Yes | Sort field | sort |
page | integer | Yes | Page number | 1 |
bash
curl -X GET "https://your-domain.com/admin/api/v1/accounts/taxes?include=invoiceRepartitionLines%2CrefundRepartitionLines&sort=sort&page=1" \
-H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json"javascript
const response = await fetch("https://your-domain.com/admin/api/v1/accounts/taxes?include=invoiceRepartitionLines%2CrefundRepartitionLines&sort=sort&page=1", {
method: "GET",
headers: {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
},
});
const data = await response.json();
console.log(data);php
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/accounts/taxes?include=invoiceRepartitionLines%2CrefundRepartitionLines&sort=sort&page=1', [
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
]);
$data = json_decode($response->getBody(), true);python
import requests
url = "https://your-domain.com/admin/api/v1/accounts/taxes?include=invoiceRepartitionLines%2CrefundRepartitionLines&sort=sort&page=1"
headers = {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
}
response = requests.get(url, headers=headers)
data = response.json()
print(data)Example response 200
json
{
"data": [
{
"id": 1,
"type_tax_use": "sale",
"tax_scope": null,
"amount_type": "percent",
"formula": "price_unit * 0.10",
"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-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z",
"invoice_repartition_lines": [
{
"id": 1,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "invoice",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 2,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "invoice",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
],
"refund_repartition_lines": [
{
"id": 3,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "refund",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 4,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "refund",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
]
},
{
"id": 1,
"type_tax_use": "sale",
"tax_scope": null,
"amount_type": "percent",
"formula": "price_unit * 0.10",
"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-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z",
"invoice_repartition_lines": [
{
"id": 1,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "invoice",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 2,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "invoice",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
],
"refund_repartition_lines": [
{
"id": 3,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "refund",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 4,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "refund",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
]
}
],
"links": {
"first": "/?page=1",
"last": "/?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "/?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"path": "/",
"per_page": 10,
"to": 2,
"total": 2
}
}Error response — 401
json
{
"message": "Unauthenticated."
}Create tax
POST/admin/api/v1/accounts/taxesCreate a new tax
🔒 Requires a valid Bearer token.
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Tax name. Must not be greater than 255 characters. |
type_tax_use | string | Yes | Tax type usage. |
amount_type | string | Yes | Tax computation type. |
amount | number | Yes | Tax amount/percentage. Not used when the computation is "group" or "code". Must be at least 0. |
formula | string | No | Arithmetic formula used when the computation is "code". Supports numbers, + - * / ( ), the functions min, max and the variables price_unit, quantity, price_subtotal. Must not be greater than 255 characters. |
tax_group_id | integer | Yes | Tax group ID. Must match an existing stored value. |
company_id | integer | No | Company ID. Must match an existing stored value. |
country_id | integer | No | Country ID. Must match an existing stored value. |
tax_scope | string | No | Tax scope. |
price_include_override | string | No | Price include override. |
cash_basis_transition_account_id | integer | No | Cash basis transition account ID. Must match an existing stored value. |
description | string | No | Tax description. |
invoice_label | string | No | Label to display on invoices. Must not be greater than 255 characters. |
invoice_legal_notes | string | No | Legal notes to display on invoices. |
tax_exigibility | string | No | Tax exigibility. Must not be greater than 255 characters. |
is_active | boolean | No | Tax status active/inactive. |
include_base_amount | boolean | No | Include base amount in tax calculation. |
is_base_affected | boolean | No | Is base affected by other taxes. |
analytic | boolean | No | Enable analytic accounting. |
invoice_repartition_lines | object[] | Yes | 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. |
refund_repartition_lines | object[] | Yes | 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. |
invoice_repartition_lines[].id | integer | No | Must match an existing stored value. |
invoice_repartition_lines[].repartition_type | string | Yes | |
invoice_repartition_lines[].factor_percent | number | No | Must be at least -100. Must not be greater than 100. |
invoice_repartition_lines[].account_id | integer | No | Must match an existing stored value. |
invoice_repartition_lines[].use_in_tax_closing | boolean | No | |
refund_repartition_lines[].id | integer | No | Must match an existing stored value. |
refund_repartition_lines[].repartition_type | string | Yes | |
refund_repartition_lines[].factor_percent | number | No | Must be at least -100. Must not be greater than 100. |
refund_repartition_lines[].account_id | integer | No | Must match an existing stored value. |
refund_repartition_lines[].use_in_tax_closing | boolean | No |
bash
curl -X POST "https://your-domain.com/admin/api/v1/accounts/taxes" \
-H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": true,
"include_base_amount": false,
"is_base_affected": false,
"analytic": false,
"invoice_repartition_lines": [
{
"repartition_type": "base",
"factor_percent": null,
"account_id": null,
"use_in_tax_closing": true
},
{
"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
}
]
}'javascript
const response = await fetch("https://your-domain.com/admin/api/v1/accounts/taxes", {
method: "POST",
headers: {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": true,
"include_base_amount": false,
"is_base_affected": false,
"analytic": false,
"invoice_repartition_lines": [
{
"repartition_type": "base",
"factor_percent": null,
"account_id": null,
"use_in_tax_closing": true
},
{
"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
}
]
}),
});
const data = await response.json();
console.log(data);php
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://your-domain.com/admin/api/v1/accounts/taxes', [
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'name' => 'VAT 20%',
'type_tax_use' => 'sale',
'amount_type' => 'percent',
'amount' => 20,
'formula' => 'min(price_unit * quantity * 0.2, 500)',
'tax_group_id' => 1,
'company_id' => 1,
'country_id' => 233,
'tax_scope' => 'service',
'price_include_override' => 'default',
'cash_basis_transition_account_id' => 1,
'description' => 'Standard VAT rate',
'invoice_label' => 'VAT',
'invoice_legal_notes' => 'Subject to VAT regulations',
'tax_exigibility' => 'on_invoice',
'is_active' => true,
'include_base_amount' => false,
'is_base_affected' => false,
'analytic' => false,
'invoice_repartition_lines' => [
[
'repartition_type' => 'base',
'factor_percent' => null,
'account_id' => null,
'use_in_tax_closing' => true,
],
[
'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,
],
],
],
]);
$data = json_decode($response->getBody(), true);python
import requests
url = "https://your-domain.com/admin/api/v1/accounts/taxes"
headers = {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": True,
"include_base_amount": False,
"is_base_affected": False,
"analytic": False,
"invoice_repartition_lines": [
{
"repartition_type": "base",
"factor_percent": None,
"account_id": None,
"use_in_tax_closing": True,
},
{
"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,
},
],
}
response = requests.post(url, headers=headers, json=payload)
data = response.json()
print(data)Example response 201
json
{
"data": {
"id": 1,
"type_tax_use": "sale",
"tax_scope": null,
"amount_type": "percent",
"formula": "price_unit * 0.10",
"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-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
"message": "Tax created successfully."
}Error response — 401
json
{
"message": "Unauthenticated."
}Show tax
GET/admin/api/v1/accounts/taxes/{id}Retrieve a specific tax by its ID
🔒 Requires a valid Bearer token.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The tax ID |
Query parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
include | string | No | Comma-separated list of relationships to include. Available options: company, taxGroup, cashBasisTransitionAccount, country, creator, childrenTaxes, invoiceRepartitionLines, refundRepartitionLines | invoiceRepartitionLines,refundRepartitionLines |
bash
curl -X GET "https://your-domain.com/admin/api/v1/accounts/taxes/{id}?include=invoiceRepartitionLines%2CrefundRepartitionLines" \
-H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json"javascript
const response = await fetch("https://your-domain.com/admin/api/v1/accounts/taxes/{id}?include=invoiceRepartitionLines%2CrefundRepartitionLines", {
method: "GET",
headers: {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
},
});
const data = await response.json();
console.log(data);php
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-domain.com/admin/api/v1/accounts/taxes/{id}?include=invoiceRepartitionLines%2CrefundRepartitionLines', [
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
]);
$data = json_decode($response->getBody(), true);python
import requests
url = "https://your-domain.com/admin/api/v1/accounts/taxes/{id}?include=invoiceRepartitionLines%2CrefundRepartitionLines"
headers = {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
}
response = requests.get(url, headers=headers)
data = response.json()
print(data)Example response 200
json
{
"data": {
"id": 1,
"type_tax_use": "sale",
"tax_scope": null,
"amount_type": "percent",
"formula": "price_unit * 0.10",
"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-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z",
"invoice_repartition_lines": [
{
"id": 1,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "invoice",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 2,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "invoice",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
],
"refund_repartition_lines": [
{
"id": 3,
"account_id": null,
"tax_id": 1,
"company_id": 1,
"sort": 1,
"repartition_type": "base",
"document_type": "refund",
"use_in_tax_closing": "0",
"factor_percent": null,
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
{
"id": 4,
"account_id": 22,
"tax_id": 1,
"company_id": 1,
"sort": 2,
"repartition_type": "tax",
"document_type": "refund",
"use_in_tax_closing": "1",
"factor_percent": "100.00",
"creator_id": 1,
"created_at": "2026-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
}
]
}
}Error response — 401
json
{
"message": "Unauthenticated."
}Update tax
PUT/admin/api/v1/accounts/taxes/{id}Update an existing tax
🔒 Requires a valid Bearer token.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The tax ID |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | Tax name. Must not be greater than 255 characters. |
type_tax_use | string | No | Tax type usage. |
amount_type | string | No | Tax computation type. |
amount | number | No | Tax amount/percentage. Not used when the computation is "group" or "code". Must be at least 0. |
formula | string | No | Arithmetic formula used when the computation is "code". Supports numbers, + - * / ( ), the functions min, max and the variables price_unit, quantity, price_subtotal. Must not be greater than 255 characters. |
tax_group_id | integer | No | Tax group ID. Must match an existing stored value. |
company_id | integer | No | Company ID. Must match an existing stored value. |
country_id | integer | No | Country ID. Must match an existing stored value. |
tax_scope | string | No | Tax scope. |
price_include_override | string | No | Price include override. |
cash_basis_transition_account_id | integer | No | Cash basis transition account ID. Must match an existing stored value. |
description | string | No | Tax description. |
invoice_label | string | No | Label to display on invoices. Must not be greater than 255 characters. |
invoice_legal_notes | string | No | Legal notes to display on invoices. |
tax_exigibility | string | No | Tax exigibility. Must not be greater than 255 characters. |
is_active | boolean | No | Tax status active/inactive. |
include_base_amount | boolean | No | Include base amount in tax calculation. |
is_base_affected | boolean | No | Is base affected by other taxes. |
analytic | boolean | No | Enable analytic accounting. |
invoice_repartition_lines | object[] | No | 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. |
refund_repartition_lines | object[] | No | 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. |
invoice_repartition_lines[].id | integer | No | Must match an existing stored value. |
invoice_repartition_lines[].repartition_type | string | Yes | |
invoice_repartition_lines[].factor_percent | number | No | Must be at least -100. Must not be greater than 100. |
invoice_repartition_lines[].account_id | integer | No | Must match an existing stored value. |
invoice_repartition_lines[].use_in_tax_closing | boolean | No | |
refund_repartition_lines[].id | integer | No | Must match an existing stored value. |
refund_repartition_lines[].repartition_type | string | Yes | |
refund_repartition_lines[].factor_percent | number | No | Must be at least -100. Must not be greater than 100. |
refund_repartition_lines[].account_id | integer | No | Must match an existing stored value. |
refund_repartition_lines[].use_in_tax_closing | boolean | No |
bash
curl -X PUT "https://your-domain.com/admin/api/v1/accounts/taxes/{id}" \
-H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": true,
"include_base_amount": false,
"is_base_affected": false,
"analytic": false,
"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": true
},
{
"repartition_type": "tax",
"factor_percent": 100,
"account_id": 1,
"use_in_tax_closing": false
}
]
}'javascript
const response = await fetch("https://your-domain.com/admin/api/v1/accounts/taxes/{id}", {
method: "PUT",
headers: {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": true,
"include_base_amount": false,
"is_base_affected": false,
"analytic": false,
"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": true
},
{
"repartition_type": "tax",
"factor_percent": 100,
"account_id": 1,
"use_in_tax_closing": false
}
]
}),
});
const data = await response.json();
console.log(data);php
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('PUT', 'https://your-domain.com/admin/api/v1/accounts/taxes/{id}', [
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
'json' => [
'name' => 'VAT 20%',
'type_tax_use' => 'sale',
'amount_type' => 'percent',
'amount' => 20,
'formula' => 'min(price_unit * quantity * 0.2, 500)',
'tax_group_id' => 1,
'company_id' => 1,
'country_id' => 233,
'tax_scope' => 'service',
'price_include_override' => 'default',
'cash_basis_transition_account_id' => 1,
'description' => 'Standard VAT rate',
'invoice_label' => 'VAT',
'invoice_legal_notes' => 'Subject to VAT regulations',
'tax_exigibility' => 'on_invoice',
'is_active' => true,
'include_base_amount' => false,
'is_base_affected' => false,
'analytic' => false,
'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' => true,
],
[
'repartition_type' => 'tax',
'factor_percent' => 100,
'account_id' => 1,
'use_in_tax_closing' => false,
],
],
],
]);
$data = json_decode($response->getBody(), true);python
import requests
url = "https://your-domain.com/admin/api/v1/accounts/taxes/{id}"
headers = {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
}
payload = {
"name": "VAT 20%",
"type_tax_use": "sale",
"amount_type": "percent",
"amount": 20,
"formula": "min(price_unit * quantity * 0.2, 500)",
"tax_group_id": 1,
"company_id": 1,
"country_id": 233,
"tax_scope": "service",
"price_include_override": "default",
"cash_basis_transition_account_id": 1,
"description": "Standard VAT rate",
"invoice_label": "VAT",
"invoice_legal_notes": "Subject to VAT regulations",
"tax_exigibility": "on_invoice",
"is_active": True,
"include_base_amount": False,
"is_base_affected": False,
"analytic": False,
"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": True,
},
{
"repartition_type": "tax",
"factor_percent": 100,
"account_id": 1,
"use_in_tax_closing": False,
},
],
}
response = requests.put(url, headers=headers, json=payload)
data = response.json()
print(data)Example response 200
json
{
"data": {
"id": 1,
"type_tax_use": "sale",
"tax_scope": null,
"amount_type": "percent",
"formula": "price_unit * 0.10",
"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-10-09T09:50:40.000000Z",
"updated_at": "2026-10-09T09:50:40.000000Z"
},
"message": "Tax updated successfully."
}Error response — 401
json
{
"message": "Unauthenticated."
}Delete tax
DELETE/admin/api/v1/accounts/taxes/{id}Delete a tax
🔒 Requires a valid Bearer token.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The tax ID |
bash
curl -X DELETE "https://your-domain.com/admin/api/v1/accounts/taxes/{id}" \
-H "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json"javascript
const response = await fetch("https://your-domain.com/admin/api/v1/accounts/taxes/{id}", {
method: "DELETE",
headers: {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
},
});
const data = await response.json();
console.log(data);php
<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-domain.com/admin/api/v1/accounts/taxes/{id}', [
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_TOKEN}',
'Accept' => 'application/json',
'Content-Type' => 'application/json',
],
]);
$data = json_decode($response->getBody(), true);python
import requests
url = "https://your-domain.com/admin/api/v1/accounts/taxes/{id}"
headers = {
"Authorization": "Bearer {YOUR_AUTH_TOKEN}",
"Accept": "application/json",
"Content-Type": "application/json",
}
response = requests.delete(url, headers=headers)
data = response.json()
print(data)Example response 200
json
{
"message": "Tax deleted successfully."
}Error response — 401
json
{
"message": "Unauthenticated."
}