Skip to main content
POST
/
wage-rules
Create Wage Rule
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/wage-rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Test Wage Rule",
  "default_wage": 10.99
}
'
{
  "id": "TGJzm",
  "name": "TWR001",
  "default_wage": 10.56,
  "deleted": 0,
  "insert_date": "Jan 9, 2024",
  "pending": false,
  "updateError": false,
  "deleteError": false
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Wage Rule Request Body

​
name
string
required

Name of the wage rule.

Minimum string length: 1
​
default_wage
number<float>
required

Default wage amount.

Required range: x >= 0

Response

Created

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.