Saltar al contenido

List cost center rows

Módulo Finance

GET/cost-centerscostCenters.list

A tenant cost center (GL dimension 1), created from canon templates or per event scope. Returns a cursor page of cost center rows the caller may see. The default order is `code` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad finance.gl.read.
  • Alcances de OAuth: finance.
  • 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

costCenters.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 CostCenter

costCenters.list: CostCenter
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the cost center.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
codeCostCenterCodeSíCost center identifier (GL dimension 1).Restricciones: pattern ^CC-[A-Z0-9-]+$
namestringSíCost center name.Restricciones: length 1 to 300
kind"Standing" | "Overhead" | "Event"SíCost center kind.
scope_node_idstring (uuid) | nullSíIdentifier of the scope node.
template_idstring | nullSíCanon cost center template.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "code": "CC-VENUE",
      "name": "Event 01 Opening Weekend",
      "kind": "Standing",
      "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "template_id": "CC-VENUE"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/cost-centers" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.costCenters.listAll()) {
  console.log(row);
}
for row in xos.cost_centers.list_all():
    print(row)
xos cost-centers list --all