Skip to content

Update a wage determination

Crew module

PATCH/wage-determinations/{id}wageDeterminations.update

A prevailing wage determination by jurisdiction. 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

wageDeterminations.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the wage determination.

Request body: WageDeterminationUpdate

wageDeterminations.update: WageDeterminationUpdate
FieldTypeRequiredDescription
jurisdiction_idJurisdictionIdNoJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
role_codeRoleCodeNoWorkforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
minimum_rate_minorinteger (int64)NoPrevailing minimum rate per hour. Integer minor units of the row's currency.Constraints: range 0 to any
currency_codestringNoISO 4217 currency.Constraints: pattern ^[A-Z]{3}$
effective_fromstring (date)NoFirst day the determination applies.
effective_tostring (date) | nullNoLast day the determination applies.
sourcestringNoDetermination source or reference.Constraints: length 1 to 300
{
  "minimum_rate_minor": 4800,
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08",
  "source": "FL20260001"
}

Response 200: WageDetermination

wageDeterminations.update: WageDetermination
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the wage determination.
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.
jurisdiction_idJurisdictionIdYesJurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
role_codeRoleCodeYesWorkforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
minimum_rate_minorinteger (int64) | nullYesPrevailing minimum rate per hour. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency.Constraints: pattern ^[A-Z]{3}$
effective_fromstring (date)YesFirst day the determination applies.
effective_tostring (date) | nullYesLast day the determination applies.
sourcestringYesDetermination source or reference.Constraints: length 1 to 300
{
  "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",
  "jurisdiction_id": "US-FL",
  "role_code": "5000.50.01",
  "minimum_rate_minor": 4800,
  "currency_code": "USD",
  "effective_from": "2026-10-08",
  "effective_to": "2026-10-08",
  "source": "FL20260001"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/wage-determinations/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 '{"minimum_rate_minor":4800,"currency_code":"USD","effective_from":"2026-10-08","effective_to":"2026-10-08","source":"FL20260001"}'
const { data, etag } = await xos.wageDeterminations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "minimum_rate_minor": 4800,
    "currency_code": "USD",
    "effective_from": "2026-10-08",
    "effective_to": "2026-10-08",
    "source": "FL20260001"
  }, { ifMatch: etag });
response = xos.wage_determinations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"minimum_rate_minor": 4800, "currency_code": "USD", "effective_from": "2026-10-08", "effective_to": "2026-10-08", "source": "FL20260001"}, if_match=etag)
xos wage-determinations update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"minimum_rate_minor":4800,"currency_code":"USD","effective_from":"2026-10-08","effective_to":"2026-10-08","source":"FL20260001"}' --if-match auto