Saltar al contenido

List change order line rows

Módulo Finance

GET/change-order-lineschangeOrderLines.list

A line of a change order. Returns a cursor page of change order line rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad finance.change_order.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

changeOrderLines.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 ChangeOrderLine

changeOrderLines.list: ChangeOrderLine
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the change order line.
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.
change_order_idstring (uuid)SíIdentifier of the change order.
budget_line_idstring (uuid) | nullSíIdentifier of the affected budget line.
uridUridAtAnyGrainSíURID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
descriptionstringSíLine description.Restricciones: length 1 to 300
quantitynumberSíQuantity; defaults to 1.
unit_price_minorinteger (int64) | nullSíUnit price; null when unpriced. Integer minor units of the resource currency; null means unpriced, never zero.
is_no_costbooleanSíWhether the line is deliberately free of charge.
account_codeGlAccountCode | nullSí
cost_center_idstring (uuid) | nullSíIdentifier of the cost center (dimension 1) of the budget line the change revises.
{
  "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",
      "change_order_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "urid": "4000.01",
      "description": "Bar build and dressing",
      "quantity": 24,
      "unit_price_minor": 1200000,
      "is_no_cost": false,
      "account_code": "5400",
      "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/change-order-lines" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.changeOrderLines.listAll()) {
  console.log(row);
}
for row in xos.change_order_lines.list_all():
    print(row)
xos change-order-lines list --all