Tax Rate

Update a tax rate by id

Updates an existing tax rate at PUT /tax-rate/:id.

patch/v1/tax-rate/{id}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/tax-rate/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Tax Rate ID

Request body

namestring

Name of the tax rate.

externalIdstring

External provider id for the tax rate (e.g. the QuickBooks TaxRate Id). Integration correlation key.

sourcestring

Origin of the tax rate — the integration provider that created it.

Example request

{
  "name": "Standard Rate",
  "externalId": "12",
  "source": "quickbooks"
}

Response

The tax rate has been successfully updated.

idstring

Unique identifier for the TaxRate.

createdAtstring date-time

Timestamp when the TaxRate was created.

updatedAtstring date-time

Timestamp when the TaxRate was last updated.

companyIdstring

Company ID associated with the TaxRate.

namestring

Name of the tax rate.

externalIdstring

External provider id for the tax rate (e.g. the QuickBooks TaxRate Id). Integration correlation key.

sourcestring

Origin of the tax rate — the integration provider that created it.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "name": "Standard Rate",
  "externalId": "12",
  "source": "quickbooks"
}

Changes

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