Get an overtime rule
Crew module
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.
- Requires the capability crew.rate_card.read.
- OAuth scopes: crew.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: 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.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: OvertimeRule
| Field | Type | Required | Description |
|---|---|---|---|
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| source | string | Yes | Statute or source of the rule.Constraints: length 1 to 300 |
| weekly_ot_after_hours | number | null | Yes | Weekly hours after which overtime applies. |
| daily_ot_after_hours | number | null | Yes | Daily hours after which overtime applies. |
| daily_dt_after_hours | number | null | Yes | Daily hours after which double time applies. |
| min_ot_multiplier | number | null | Yes | Minimum overtime multiplier. |
| min_dt_multiplier | number | null | Yes | 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
}Code samples
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