List std labor rate card rows

Canon module

GET/canon/std/labor-rate-cardscanonStdLaborRateCards.list

A labor rate card line. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std labor rate card rows the caller may see. The default order is `rate_card_id` ascending. 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

canonStdLaborRateCards.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 StdLaborRateCard

canonStdLaborRateCards.list: StdLaborRateCard
Field	Type	Required	Description
rate_card_id	string	Yes	Canon rate card identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
role_code	RoleCode	Yes	Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
job_title	string \| null	Yes	Job title of the role.Constraints: length 1 to 300
class_code	DeptCode	Yes	Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$
department	string	Yes	Department of the role.Constraints: length 1 to 200
worker_classification	string	Yes	Worker classification label.Constraints: length 1 to 200
pay_basis	string	Yes	Pay basis.Constraints: length 1 to 200
arrangement	string	Yes	Arrangement.Constraints: length 1 to 200
standard_rate_minor	integer (int64) \| null	Yes	Standard rate. Integer minor units of the resource currency; null means unpriced, never zero.
min_grade_rate_minor	integer (int64) \| null	Yes	Lowest grade rate. Integer minor units of the resource currency; null means unpriced, never zero.
max_grade_rate_minor	integer (int64) \| null	Yes	Highest grade rate. Integer minor units of the resource currency; null means unpriced, never zero.
per_diem_rate_minor	integer (int64) \| null	Yes	Per diem rate. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string	Yes	ISO 4217 currency of the rates.Constraints: pattern ^[A-Z]{3}$
overtime_rule_id	string	Yes	Canon overtime rule.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
ot_multiplier	number	Yes	Overtime multiplier.
dt_multiplier	number	Yes	Double time multiplier.
gl_account	string \| null	Yes	Expense GL account of the role's department.Constraints: length 1 to 50
gl_account_name	string \| null	Yes	Name of that GL account.Constraints: length 1 to 300

{
  "data": [
    {
      "rate_card_id": "LRC-001",
      "role_code": "5000.50.01",
      "job_title": "Head Rigger",
      "class_code": "4000",
      "department": "Production",
      "worker_classification": "Employee",
      "pay_basis": "Hourly",
      "arrangement": "Per Engagement",
      "standard_rate_minor": 4500,
      "min_grade_rate_minor": 3800,
      "max_grade_rate_minor": 5200,
      "per_diem_rate_minor": 6500,
      "currency_code": "USD",
      "overtime_rule_id": "OTR-001",
      "ot_multiplier": 1.5,
      "dt_multiplier": 2,
      "gl_account": "5400",
      "gl_account_name": "Production Labor"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/std/labor-rate-cards" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos canon-std-labor-rate-cards list --all