Tenant API — Tax types

Base path: /api/tenant/v1/tax-types

Requires Accounting module entitlement and accounting.* permissions.

List tax types

GET /tax-types

Query parameters:

Parameter	Purpose
search	Filter by name, code, or authority reference
kind	Filter: sales_tax or withholding
direction	Filter when value is a tax direction enum (add_on_sale, deduct_on_payment_in, deduct_on_payment_out); sort order when value is asc or desc (with sort)
is_active	Filter by active flag
trashed	true (include soft-deleted) or only
sort	Sort column: name (default), code, kind, direction, rate, created_at, updated_at — unknown values fall back to name
page, per_page	Pagination

Examples:

• Paginated list sorted by name: ?sort=name&direction=asc
• Withholding types for customer payments: ?kind=withholding&direction=deduct_on_payment_in

Create tax type

POST /tax-types

{
  "name": "Standard VAT",
  "code": "VAT-STD",
  "kind": "sales_tax",
  "direction": "add_on_sale",
  "rate": 15,
  "calculation_base": "net_of_discount",
  "payable_account_id": 12,
  "authority_reference": null,
  "is_active": true
}

Withholding examples:

• Payment in: kind: "withholding", direction: "deduct_on_payment_in", receivable_account_id
• Payment out: kind: "withholding", direction: "deduct_on_payment_out", payable_account_id

Show / update / delete

• GET /tax-types/{id}
• PUT /tax-types/{id}
• DELETE /tax-types/{id}
• POST /tax-types/{id}/restore
• DELETE /tax-types/{id}/force

Related endpoints

• Billing lines accept lines.*.tax_type_id on invoices, credit notes, quotations, estimates, POs (when Accounting entitled).
• Payments: withholding_tax_type_id, withholding_authority_reference on create/update; withholding_amount computed on post. Show responses include withholding_tax_type summary when loaded.
• Expenses: same withholding fields on POST /expenses/{id}/pay; paid expense show includes withholding_tax_type.
• Contacts / vendors: default_withholding_tax_type_id.

See developer guide for journal semantics.