Saltar al contenido

Get a tax jurisdiction

Módulo Finance

GET/tax-jurisdictions/{id}taxJurisdictions.get

A tax jurisdiction the org collects or pays tax in. Returns one tax jurisdiction with its `ETag`. A tax jurisdiction the caller may not see returns 404.

  • Requiere la capacidad finance.gl.read.
  • Alcances de OAuth: finance.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

taxJurisdictions.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tax jurisdiction.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: TaxJurisdiction

taxJurisdictions.get: TaxJurisdiction
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the tax jurisdiction.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
jurisdiction_idJurisdictionIdSíJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
namestringSíTax jurisdiction name.Restricciones: length 1 to 300
{
  "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",
  "jurisdiction_id": "US-FL",
  "name": "Florida Sales Tax"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/tax-jurisdictions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.taxJurisdictions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.tax_jurisdictions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos tax-jurisdictions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f