---
title: "Check whether a tax is in use"
method: GET
path: "/companies/{company}/taxes/{tax}/is-in-use"
tags: ["Taxes"]
---

# Check whether a tax is in use

`GET /companies/{company}/taxes/{tax}/is-in-use`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/taxes/{tax}/is-in-use`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return whether your company uses the tax: documents, products, contacts and company defaults of your company only (usage by other companies is not counted). Useful for safe-deletion checks before calling DELETE.

## Path parameters

- `company` string, uuid, required
- `tax` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

`TaxUsageV1Resource`

- object
  - `data` TaxUsage, required: Where a tax is used across your catalog and documents. It lets you decide whether it is safe to delete or deactivate the tax (`in_use=false` means it is safe to delete).
    - `object` 'tax_usage', required
    - `taxes_id` string, required: UUID v7 of the requested tax.
    - `in_use` boolean, required: `true` when `total_count > 0`.
    - `total_count` integer, required: Sum of the counters in `used_by`.
    - `used_by` object, required: Number of references by kind of resource. Purchase invoice lines (they store a rate, not a tax reference) are not counted.
      - `products` integer, required: Products that reference the tax.
      - `suppliers` integer, required: Suppliers that use the tax as their default tax.
      - `supplier_profiles` integer, required: Supplier contact profiles that use the tax as their default tax and are not already counted in `suppliers` (a supplier is never counted twice).
      - `invoice_lines` integer, required: Invoice lines that reference the tax as VAT, withholding, surcharge or generic tax.
      - `quote_lines` integer, required
      - `proforma_lines` integer, required
      - `delivery_note_lines` integer, required
      - `recurring_invoices` integer, required: Recurring invoice templates with at least one line that references the tax (each template counts once).
      - `company_tax_defaults` integer, required: Document and category slots of your company tax configuration that use the tax as the default.
  - `taxes_id` string, required

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)