Get a canon gl account

Módulo Canon

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.

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

Parámetros de ruta y de consulta

canonGlAccounts.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
account_code	GlAccountCode	Sí	GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Restricciones: pattern ^[0-9]{4}$
fields	Fields	No	Sparse 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: CanonGlAccount

canonGlAccounts.get: CanonGlAccount
Campo	Tipo	Obligatorio	Descripción
account_code	GlAccountCode	Sí	GL account code from the fixed chart in `xpms.dim_gl_account` (Section 3.11).Restricciones: pattern ^[0-9]{4}$
account_name	string	Sí	Account name.Restricciones: length 1 to 200
account_type	string	Sí	Account type.Restricciones: length 1 to 200
tax_type	TaxType	Sí	Tax type from the Universal Posting Line specification (Bible tab 36).Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
description	string	Sí	Account description.Restricciones: length 1 to 20000
normal_balance	"Debit" \| "Credit" \| null	Sí	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"
}

Ejemplos de código

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