Get a canon gl account
Canon module
GET/canon/gl-accounts/{account_code}canonGlAccounts.get
A GL account in the fixed 23-account chart. Tenants cannot add accounts. Returns one canon gl account with its `ETag`. A canon gl account 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 |
|---|---|---|---|
| account_code | GlAccountCode | Yes | GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Constraints: pattern ^[0-9]{4}$ |
| 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: CanonGlAccount
| Field | Type | Required | Description |
|---|---|---|---|
| account_code | GlAccountCode | Yes | GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Constraints: pattern ^[0-9]{4}$ |
| account_name | string | Yes | Account name.Constraints: length 1 to 200 |
| account_type | string | Yes | Account type.Constraints: length 1 to 200 |
| tax_type | TaxType | Yes | Tax type from the Universal Posting Line specification (Bible tab 36).Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| description | string | Yes | Account description.Constraints: length 1 to 20000 |
| normal_balance | "Debit" | "Credit" | null | Yes | Normal balance of the account's type: Debit or Credit. |
{
"account_code": "5400",
"account_name": "Environment",
"account_type": "Expense",
"tax_type": "Tax on Purchases",
"description": "Environment class costs.",
"normal_balance": "Debit"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/gl-accounts/5400" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonGlAccounts.get("5400");response = xos.canon_gl_accounts.get("5400")xos canon-gl-accounts get 5400