Create an union local rate
Crew module
POST/union-local-ratesunionLocalRates.create
A union local's scale rate for a role. Creates an union local rate. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability crew.rate_card.write.
- OAuth scopes: crew.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: UnionLocalRateCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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 (int64) | Yes | Scale rate per hour. Integer minor units of the row's currency.Constraints: range 0 to any |
| 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 | 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",
"role_code": "5000.50.01",
"rate_minor": 5600,
"currency_code": "USD",
"effective_from": "2026-10-08",
"fringe_minor": 1200,
"effective_to": "2026-10-08"
}Response 201: 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 POST "$XOS_BASE_URL/union-local-rates" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"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"}'const { data } = await xos.unionLocalRates.create({
"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"
});response = xos.union_local_rates.create({"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"})xos union-local-rates create --data '{"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"}'