Create a pay rate

Módulo Crew

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.

Requiere la capacidad crew.rate_card.write.
Alcances de OAuth: crew.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PayRateCreate

payRates.create: PayRateCreate
Campo	Tipo	Obligatorio	Descripción
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
rate_minor	integer (int64)	Sí	Pay rate per hour. Integer minor units of the row's currency.Restricciones: range 0 to any
effective_from	string (date)	Sí	First day the rate applies.
membership_id	string (uuid)	Sí	Identifier of the membership of the person paid.
currency_code	string	Sí	ISO 4217 currency of the rate.Restricciones: 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"
}

Respuesta 201: PayRate

payRates.create: PayRate
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the pay rate.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
role_code	RoleCode	Sí	Workforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
rate_minor	integer \| Masked \| null	Sí
effective_from	string (date)	Sí	First day the rate applies.
membership_id	string (uuid)	Sí	Identifier of the membership of the person paid.
currency_code	string	Sí	ISO 4217 currency of the rate.Restricciones: 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"
}

Ejemplos de código

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