Taxes

Check whether a tax is in use

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.

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

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

taxstring uuid required

Public identifier (UUID v7) of the tax.

Headers

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

TaxUsageV1Resource

taxes_idstring required

Example response

{
  "data": {
    "object": "tax_usage",
    "taxes_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0f",
    "in_use": true,
    "total_count": 9,
    "used_by": {
      "products": 3,
      "suppliers": 1,
      "supplier_profiles": 0,
      "invoice_lines": 2,
      "quote_lines": 1,
      "proforma_lines": 0,
      "delivery_note_lines": 0,
      "recurring_invoices": 1,
      "company_tax_defaults": 1
    }
  },
  "taxes_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a9b"
}

Changes

No recorded changes to this operation across all 1 revision of this API.