Skip to content

Create a rate card

Crew module

POST/rate-cardsrateCards.create

A labor rate card. Creates a rate card. 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: RateCardCreate

rateCards.create: RateCardCreate
FieldTypeRequiredDescription
namestringYesRate card name.Constraints: length 1 to 300
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
effective_fromstring (date)YesFirst day the card applies.
effective_tostring (date) | nullNoLast day the card applies.
{
  "name": "Local Stagehand Rates 2026",
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08"
}

Response 201: RateCard

rateCards.create: RateCard
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the rate card.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
namestringYesRate card name.Constraints: length 1 to 300
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
effective_fromstring (date)YesFirst day the card applies.
effective_tostring (date) | nullYesLast day the card 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",
  "name": "Local Stagehand Rates 2026",
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08"
}

Code samples

curl -X POST "$XOS_BASE_URL/rate-cards" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Local Stagehand Rates 2026","currency_code":"USD","effective_from":"2026-10-08","effective_to":"2026-10-08"}'
const { data } = await xos.rateCards.create({
    "name": "Local Stagehand Rates 2026",
    "currency_code": "USD",
    "effective_from": "2026-10-08",
    "effective_to": "2026-10-08"
  });
response = xos.rate_cards.create({"name": "Local Stagehand Rates 2026", "currency_code": "USD", "effective_from": "2026-10-08", "effective_to": "2026-10-08"})
xos rate-cards create --data '{"name":"Local Stagehand Rates 2026","currency_code":"USD","effective_from":"2026-10-08","effective_to":"2026-10-08"}'