Skip to content

Get a cost center

Finance module

GET/cost-centers/{id}costCenters.get

A tenant cost center (GL dimension 1), created from canon templates or per event scope. Returns one cost center with its `ETag`. A cost center 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

costCenters.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the cost center.
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: CostCenter

costCenters.get: CostCenter
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the cost center.
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.
codeCostCenterCodeYesCost center identifier (GL dimension 1).Constraints: pattern ^CC-[A-Z0-9-]+$
namestringYesCost center name.Constraints: length 1 to 300
kind"Standing" | "Overhead" | "Event"YesCost center kind.
scope_node_idstring (uuid) | nullYesIdentifier of the scope node.
template_idstring | nullYesCanon cost center template.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "code": "CC-VENUE",
  "name": "Event 01 Opening Weekend",
  "kind": "Standing",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "template_id": "CC-VENUE"
}

Code samples

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