Archive a tax rate

POST/v1/tax-rates/{id}/archive

Hides a tax rate from pickers. Documents that already use it are not changed.

Tax rates are archived rather than deleted so history stays complete. Lines on existing documents keep their frozen name, percent and calculation. See Taxes.

Permission: settings.manage
Type: Write. Creates or changes data and writes an audit entry.
Auth: API key, MCP token or signed-in session
Capability: archive_tax_rate
CLI: freeinvoiceautomation tax-rate archive
Available: At launch, 1 January 2027

archive_tax_rate

curl --request POST \
  --url https://api.freeinvoiceautomation.com/v1/tax-rates/<id>/archive \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: <unique-key>'

{
  "data": {
    "id": "0193f2a0-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
    "business_id": "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f",
    "name": "VAT 20%",
    "rate": "20.0000",
    "calculation": "exclusive",
    "compound": false,
    "preset_key": null,
    "archived_at": "2027-03-10T08:00:00Z",
    "created_at": "2027-01-02T08:31:10Z",
    "updated_at": "2027-03-10T08:00:00Z"
  }
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Headers

Idempotency-Keystring

Any unique string up to 255 characters. A retry with the same key and body returns the first response. See Idempotency.

Path Parameters

idstring<uuid>required

Id of the tax rate.

Response

200 - application/json

idstring<uuid>

Unique id of the tax rate.

business_idstring<uuid>

The business the rate belongs to.

namestring

Label printed on lines and totals, e.g. VAT 20%.

ratestring

Percent as a decimal string with up to four decimals, e.g. "20.0000" = 20%.

calculationenum<string>

exclusive adds the tax on top of the line price; inclusive treats the price as already containing the tax.

Available options: exclusive, inclusive

compoundboolean

When true, the tax is charged on the line amount plus the other taxes on that line.

preset_keystring | null

Key of the tax preset the rate was created from, if any.

archived_atstring<date-time> | null

When the rate was archived. Archived rates cannot be picked for new lines but stay on old documents.

created_atstring<date-time>

When the rate was created.

updated_atstring<date-time>

When the rate was last changed.

Suggest edits Raise issue

Create or update a tax ratePrevious List numbering sequencesNext

archive_tax_rate

curl --request POST \
  --url https://api.freeinvoiceautomation.com/v1/tax-rates/<id>/archive \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: <unique-key>'

{
  "data": {
    "id": "0193f2a0-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
    "business_id": "0193f29e-11aa-7c3b-8d2e-5a6b7c8d9e0f",
    "name": "VAT 20%",
    "rate": "20.0000",
    "calculation": "exclusive",
    "compound": false,
    "preset_key": null,
    "archived_at": "2027-03-10T08:00:00Z",
    "created_at": "2027-01-02T08:31:10Z",
    "updated_at": "2027-03-10T08:00:00Z"
  }
}