List canon gl account rows

Canon module

GET/canon/gl-accountscanonGlAccounts.list

A GL account in the fixed 23-account chart. Tenants cannot add accounts. Returns a cursor page of canon gl account rows the caller may see. Coded list: the default order is numeric code order by `account_code`. Supports sparse fieldsets and the filter grammar.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonGlAccounts.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of CanonGlAccount

canonGlAccounts.list: 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.

{
  "data": [
    {
      "account_code": "1000",
      "account_name": "Cash and Bank",
      "account_type": "Asset",
      "tax_type": "None",
      "description": "Environment class costs.",
      "normal_balance": "Debit"
    },
    {
      "account_code": "5400",
      "account_name": "Environment",
      "account_type": "Expense",
      "tax_type": "Tax on Purchases",
      "description": "Environment class costs.",
      "normal_balance": "Debit"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/gl-accounts" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonGlAccounts.listAll()) {
  console.log(row);
}

for row in xos.canon_gl_accounts.list_all():
    print(row)

xos canon-gl-accounts list --all