Update a tax rate
Finance module
PATCH/tax-rates/{id}taxRates.update
A tax rate with its effective dates. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability org.legal_entities.write.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tax rate. |
Request body: TaxRateUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| rate_percent | number | No | Rate in percent. |
| effective_from | string (date) | No | First day the rate applies. |
| effective_to | string (date) | null | No | Last day the rate applies. |
| tax_type | TaxType | No | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08"
}Response 200: TaxRate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the tax rate. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| tax_jurisdiction_id | string (uuid) | Yes | Identifier of the tax jurisdiction. |
| rate_percent | number | Yes | Rate in percent. |
| effective_from | string (date) | Yes | First day the rate applies. |
| effective_to | string (date) | null | Yes | Last day the rate applies. |
| tax_type | TaxType | Yes | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"tax_jurisdiction_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08",
"tax_type": "Tax on Purchases"
}Code samples
curl -X PATCH "$XOS_BASE_URL/tax-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08"}'const { data, etag } = await xos.taxRates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"rate_percent": 7,
"effective_from": "2026-10-08",
"effective_to": "2026-10-08"
}, { ifMatch: etag });response = xos.tax_rates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"rate_percent": 7, "effective_from": "2026-10-08", "effective_to": "2026-10-08"}, if_match=etag)xos tax-rates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"rate_percent":7,"effective_from":"2026-10-08","effective_to":"2026-10-08"}' --if-match auto