Saltar al contenido

List canon category gl rows

Módulo Canon

GET/canon/category-glcanonCategoryGl.list

The GL account each category posts to. Returns a cursor page of canon category gl rows the caller may see. Coded list: the default order is numeric code order by `cat_urid`. 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

canonCategoryGl.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 CanonCategoryGl

canonCategoryGl.list: CanonCategoryGl
CampoTipoObligatorioDescripción
cat_uridUridSíCategory URID `DDDD.DD.DD` from `xpms.dim_category` (Section 3.3). There is no fourth segment.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
default_cost_centerstringSíDefault cost center (dimension 1) of the category.Restricciones: length 1 to 300
account_codeGlAccountCode | nullSí
{
  "data": [
    {
      "cat_urid": "0000.01.01",
      "default_cost_center": "Production",
      "account_code": "5400"
    },
    {
      "cat_urid": "0000.02.01",
      "default_cost_center": "Production",
      "account_code": "5400"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/canon/category-gl" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.canonCategoryGl.listAll()) {
  console.log(row);
}
for row in xos.canon_category_gl.list_all():
    print(row)
xos canon-category-gl list --all