Get a canon category gl
Canon module
GET/canon/category-gl/{cat_urid}canonCategoryGl.get
The GL account each category posts to. Returns one canon category gl with its `ETag`. A canon category gl 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 |
|---|---|---|---|
| cat_urid | Urid | Yes | Category URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| 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: CanonCategoryGl
| Field | Type | Required | Description |
|---|---|---|---|
| cat_urid | Urid | Yes | Category URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| default_cost_center | string | Yes | Default cost center (dimension 1) of the category.Constraints: length 1 to 300 |
| account_code | GlAccountCode | null | Yes |
{
"cat_urid": "4000.01.01",
"default_cost_center": "Production",
"account_code": "5400"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/category-gl/4000.01.01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonCategoryGl.get("4000.01.01");response = xos.canon_category_gl.get("4000.01.01")xos canon-category-gl get 4000.01.01