> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update tax
> Update an existing tax
Also accepts `PATCH` with the same body.
## OpenAPI
````yaml /api-reference/openapi.json put /admin/api/v1/accounts/taxes/{id}
openapi: 3.0.3
info:
title: ARUKZ ERP API
version: v1
description: >-
The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners,
accounts, projects and reference data. Every call acts as the user whose
token it carries and sees only that user's company.
servers:
- url: https://erp.arukz.com
description: ARUKZ ERP (hosted)
security:
- bearerAuth: []
tags:
- name: Authentication
description: Sign in for a token and sign out.
- name: Sales
description: Quotations, sales orders and their lines, deliveries and invoices.
- name: Purchases
description: Purchase orders, receipts, bills, agreements and vendor price lists.
- name: Inventory
description: >-
Warehouses, locations, lots, stock quantities, receipts, deliveries,
transfers and scrap.
- name: Products
description: 'The product catalogue: categories, attributes, variants and packaging.'
- name: Partners
description: Customers, vendors, contacts, addresses and bank accounts.
- name: Accounts
description: >-
Invoices, bills, credit notes, refunds, taxes, journals and the chart of
accounts.
- name: Projects
description: Projects, tasks, stages and milestones.
- name: Reference data
description: Currencies and rates, banks, countries, states and units of measure.
paths:
/admin/api/v1/accounts/taxes/{id}:
put:
tags:
- Accounts
summary: Update tax
description: |-
Update an existing tax
Also accepts `PATCH` with the same body.
operationId: accounts-taxes-update-tax
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: The tax ID
example: 1
description: The tax ID
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Tax name. Must not be greater than 255 characters.
example: VAT 20%
type_tax_use:
type: string
description: Tax type usage.
enum:
- sale
- purchase
- none
example: sale
amount_type:
type: string
description: Tax computation type.
enum:
- fixed
- group
- percent
- division
- code
example: percent
amount:
type: number
description: Tax amount/percentage. Must be at least 0.
example: 20
tax_group_id:
type: integer
description: >-
Tax group ID. The `id` of an existing record in the
accounts_tax_groups table.
example: 1
company_id:
type: integer
description: >-
Company ID. The `id` of an existing record in the companies
table.
nullable: true
example: 1
country_id:
type: integer
description: >-
Country ID. The `id` of an existing record in the countries
table.
nullable: true
example: 233
tax_scope:
type: string
description: Tax scope.
enum:
- service
- consu
nullable: true
example: service
price_include_override:
type: string
description: Price include override.
enum:
- default
- tax_included
- tax_excluded
nullable: true
example: default
cash_basis_transition_account_id:
type: integer
description: >-
Cash basis transition account ID. The `id` of an existing
record in the accounts_accounts table.
nullable: true
example: 1
description:
type: string
description: Tax description.
nullable: true
example: Standard VAT rate
invoice_label:
type: string
description: >-
Label to display on invoices. Must not be greater than 255
characters.
nullable: true
example: VAT
invoice_legal_notes:
type: string
description: Legal notes to display on invoices.
nullable: true
example: Subject to VAT regulations
tax_exigibility:
type: string
description: Tax exigibility. Must not be greater than 255 characters.
nullable: true
example: on_invoice
is_active:
type: boolean
description: Tax status active/inactive.
nullable: true
example: false
include_base_amount:
type: boolean
description: Include base amount in tax calculation.
nullable: true
example: false
is_base_affected:
type: boolean
description: Is base affected by other taxes.
nullable: true
example: false
analytic:
type: boolean
description: Enable analytic accounting.
nullable: true
example: false
invoice_repartition_lines:
type: array
items:
type: object
properties:
id:
type: integer
description: >-
The `id` of an existing record in the
accounts_tax_partition_lines table.
example: 16
repartition_type:
type: string
enum:
- base
- tax
example: architecto
factor_percent:
type: number
description: Must be at least -100. Must not be greater than 100.
nullable: true
example: 22
account_id:
type: integer
description: >-
The `id` of an existing record in the
accounts_accounts table.
nullable: true
example: 16
use_in_tax_closing:
type: boolean
example: true
required:
- repartition_type
description: >-
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.
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:
type: array
items:
type: object
properties:
id:
type: integer
description: >-
The `id` of an existing record in the
accounts_tax_partition_lines table.
example: 16
repartition_type:
type: string
enum:
- base
- tax
example: architecto
factor_percent:
type: number
description: Must be at least -100. Must not be greater than 100.
nullable: true
example: 22
account_id:
type: integer
description: >-
The `id` of an existing record in the
accounts_accounts table.
nullable: true
example: 16
use_in_tax_closing:
type: boolean
example: true
required:
- repartition_type
description: >-
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.
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
responses:
'200':
description: Success
content:
application/json:
example:
data:
id: 1
type_tax_use: sale
tax_scope: null
amount_type: percent
price_include_override: null
tax_exigibility: on_invoice
name: 15 %
description: CESS 5%
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 updated successfully.
'401':
description: Unauthenticated
content:
application/json:
example:
message: Unauthenticated.
'404':
description: Tax not found
content:
application/json:
example:
message: Resource not found.
'422':
description: Validation error
content:
application/json:
example:
message: The given data was invalid.
errors:
name:
- The name field is required.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
An API token from [Sign in](/api-reference/authentication), sent as
`Authorization: Bearer `. Tokens last 30 days.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.