Get a canon cost center template
Canon module
GET/canon/cost-center-templates/{cost_center_id}canonCostCenterTemplates.get
A cost center template (GL dimension 1). Returns one canon cost center template with its `ETag`. A canon cost center template the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| cost_center_id | CostCenterCode | Yes | Cost center identifier (GL dimension 1).Constraints: pattern ^CC-[A-Z0-9-]+$ |
| fields | Fields | No | Sparse 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: CanonCostCenterTemplate
| Field | Type | Required | Description |
|---|---|---|---|
| cost_center_id | CostCenterCode | Yes | Cost center identifier (GL dimension 1).Constraints: pattern ^CC-[A-Z0-9-]+$ |
| cost_center | string | Yes | Cost center name.Constraints: length 1 to 200 |
| kind | string | Yes | Cost center kind.Constraints: length 1 to 200 |
| scope_code | string | null | Yes | Scope code the cost center belongs to.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| note | string | null | Yes | Note from the Bible.Constraints: length 1 to 20000 |
{
"cost_center_id": "CC-VENUE",
"cost_center": "Venue Standing Operations",
"kind": "Standing",
"scope_code": "E01",
"note": "Runs whether or not an event does."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/cost-center-templates/CC-VENUE" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonCostCenterTemplates.get("CC-VENUE");response = xos.canon_cost_center_templates.get("CC-VENUE")xos canon-cost-center-templates get CC-VENUE