Skip to main content
GET
/
wage-rules
/
{id}
Get Wage Rule
curl --request GET \
  --url https://api.roostedhr.com/api/1_12/wage-rules/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "default_wage": 123,
  "deleted": 0,
  "insert_date": "<string>",
  "pending": true,
  "updateError": true,
  "deleteError": true
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Wage Rule ID

Response

OK

A wage rule used to define default wage rates.

​
id
string

Unique wage rule identifier.

​
name
string

Name of the wage rule.

​
default_wage
number<float> | null

Default wage amount.

​
deleted
integer

Soft-delete flag (0 = active, 1 = deleted).

Required range: 0 <= x <= 1
​
insert_date
string | null

Date the wage rule was created.

​
pending
boolean

Whether the wage rule is pending.

​
updateError
boolean

Whether the last update had an error.

​
deleteError
boolean

Whether the last delete had an error.