List overtime rule rows

Módulo Crew

GET/overtime-rulesovertimeRules.list

A jurisdiction's wage and hour rule from canon: daily and weekly overtime thresholds and minimum multipliers. A lower jurisdiction inherits its parent's rule. Returns a cursor page of overtime rule rows the caller may see. The default order is `jurisdiction_id` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad crew.rate_card.read.
Alcances de OAuth: crew.
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

overtimeRules.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 OvertimeRule

overtimeRules.list: OvertimeRule
Campo	Tipo	Obligatorio	Descripción
jurisdiction_id	JurisdictionId	Sí	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
source	string	Sí	Statute or source of the rule.Restricciones: length 1 to 300
weekly_ot_after_hours	number \| null	Sí	Weekly hours after which overtime applies.
daily_ot_after_hours	number \| null	Sí	Daily hours after which overtime applies.
daily_dt_after_hours	number \| null	Sí	Daily hours after which double time applies.
min_ot_multiplier	number \| null	Sí	Minimum overtime multiplier.
min_dt_multiplier	number \| null	Sí	Minimum double time multiplier.

{
  "data": [
    {
      "jurisdiction_id": "US-FL",
      "source": "Fair Labor Standards Act, 29 U.S.C. 207",
      "weekly_ot_after_hours": 40,
      "daily_ot_after_hours": 8,
      "daily_dt_after_hours": 12,
      "min_ot_multiplier": 1.5,
      "min_dt_multiplier": 2
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/overtime-rules" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos overtime-rules list --all