Update an union local rate
Crew module
PATCH/union-local-rates/{id}unionLocalRates.update
A union local's scale rate for a role. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability crew.rate_card.write.
- OAuth scopes: crew.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the union local rate. |
Request body: UnionLocalRateUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| union_local | string | No | Union local.Constraints: length 1 to 300 |
| role_code | RoleCode | No | Workforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$ |
| rate_minor | integer (int64) | No | Scale rate per hour. Integer minor units of the row's currency.Constraints: range 0 to any |
| currency_code | string | No | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| effective_from | string (date) | No | First day the rate applies. |
| fringe_minor | integer (int64) | null | No | Fringe per hour. Integer minor units of the resource currency; null means unpriced, never zero. |
| effective_to | string (date) | null | No | Last day the rate applies. |
{
"union_local": "Local 500",
"rate_minor": 5600,
"currency_code": "USD",
"effective_from": "2026-10-08",
"fringe_minor": 1200,
"effective_to": "2026-10-08"
}Response 200: UnionLocalRate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the union local rate. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| union_local | string | Yes | Union local.Constraints: length 1 to 300 |
| 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}$ |
| rate_minor | integer | Masked | null | Yes | |
| currency_code | string | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| effective_from | string (date) | Yes | First day the rate applies. |
| fringe_minor | integer (int64) | null | Yes | Fringe per hour. Integer minor units of the resource currency; null means unpriced, never zero. |
| effective_to | string (date) | null | Yes | Last day the rate applies. |
{
"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",
"union_local": "Local 500",
"role_code": "5000.50.01",
"rate_minor": 5600,
"currency_code": "USD",
"effective_from": "2026-10-08",
"fringe_minor": 1200,
"effective_to": "2026-10-08"
}Code samples
curl -X PATCH "$XOS_BASE_URL/union-local-rates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"union_local":"Local 500","rate_minor":5600,"currency_code":"USD","effective_from":"2026-10-08","fringe_minor":1200,"effective_to":"2026-10-08"}'const { data, etag } = await xos.unionLocalRates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"union_local": "Local 500",
"rate_minor": 5600,
"currency_code": "USD",
"effective_from": "2026-10-08",
"fringe_minor": 1200,
"effective_to": "2026-10-08"
}, { ifMatch: etag });response = xos.union_local_rates.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"union_local": "Local 500", "rate_minor": 5600, "currency_code": "USD", "effective_from": "2026-10-08", "fringe_minor": 1200, "effective_to": "2026-10-08"}, if_match=etag)xos union-local-rates update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"union_local":"Local 500","rate_minor":5600,"currency_code":"USD","effective_from":"2026-10-08","fringe_minor":1200,"effective_to":"2026-10-08"}' --if-match auto