Get an overtime rule

Módulo Crew

GET/overtime-rules/{jurisdiction_id}overtimeRules.get

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 one overtime rule with its `ETag`. A overtime rule the caller may not see returns 404.

Requiere la capacidad crew.rate_card.read.
Alcances de OAuth: crew.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

overtimeRules.get: Parámetros de ruta y de consulta
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]+)*$
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_])*$

Respuesta 200: OvertimeRule

overtimeRules.get: 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.

{
  "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
}

Ejemplos de código

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

const { data, etag } = await xos.overtimeRules.get("US-FL");

response = xos.overtime_rules.get("US-FL")

xos overtime-rules get US-FL