Create a pay rate
Crew module
POST/pay-ratespayRates.create
An append-only pay rate ledger entry for a person. Restricted. Creates a pay 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: PayRateCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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 | Pay rate per hour. Integer minor units of the row's currency.Constraints: range 0 to any |
| effective_from | string (date) | Yes | First day the rate applies. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person paid. |
| currency_code | string | Yes | ISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$ |
{
"role_code": "5000.50.01",
"rate_minor": 5200,
"effective_from": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
}Response 201: PayRate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the pay 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. |
| 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 | |
| effective_from | string (date) | Yes | First day the rate applies. |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person paid. |
| currency_code | string | Yes | ISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$ |
{
"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",
"role_code": "5000.50.01",
"rate_minor": 5200,
"effective_from": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
}Code samples
curl -X POST "$XOS_BASE_URL/pay-rates" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"role_code":"5000.50.01","rate_minor":5200,"effective_from":"2026-10-08","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD"}'const { data } = await xos.payRates.create({
"role_code": "5000.50.01",
"rate_minor": 5200,
"effective_from": "2026-10-08",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"currency_code": "USD"
});response = xos.pay_rates.create({"role_code": "5000.50.01", "rate_minor": 5200, "effective_from": "2026-10-08", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "currency_code": "USD"})xos pay-rates create --data '{"role_code":"5000.50.01","rate_minor":5200,"effective_from":"2026-10-08","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","currency_code":"USD"}'