List canon gl account rows

Módulo Canon

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.

Requiere la capacidad canon.taxonomy.read.
Alcances de OAuth: canon.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonGlAccounts.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
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).Restricciones: 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.

Respuesta 200: una página de CanonGlAccount

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

{
  "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
}

Ejemplos de código

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