Skip to content

Get a tax rate

Finance module

GET/tax-rates/{id}taxRates.get

A tax rate with its effective dates. Returns one tax rate with its `ETag`. A tax rate the caller may not see returns 404.

  • Requires the capability finance.gl.read.
  • OAuth scopes: finance.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

taxRates.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the tax rate.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: TaxRate

taxRates.get: TaxRate
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the tax rate.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
tax_jurisdiction_idstring (uuid)YesIdentifier of the tax jurisdiction.
rate_percentnumberYesRate in percent.
effective_fromstring (date)YesFirst day the rate applies.
effective_tostring (date) | nullYesLast day the rate applies.
tax_typeTaxTypeYesTax 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 GET "$XOS_BASE_URL/tax-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.taxRates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.tax_rates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos tax-rates get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f