v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

User Wages

Create User Wage

post/v2/company/{company_id}/users/{user_id}/wages

Path parameters

company_idinteger required

Company ID

user_idinteger required

User ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

effective_datestring required

A date with YYYY-MM-DD format

role_idinteger

Role ID

wage_type'hourly' | 'weekly_salary' | 'annual_salary' required

The wage type

wage_centsinteger required

The wage value. In cents

enabled_daysobject nullable

Days of the week when the wage is applicable (optional, defaults to all days). Days keyed by full name (Sunday-Saturday).

Example request

{
  "effective_date": "2020-01-01",
  "enabled_days": {
    "Sunday": true,
    "Monday": true,
    "Tuesday": true,
    "Wednesday": true,
    "Thursday": true,
    "Friday": true,
    "Saturday": false
  }
}

Response

Wage created

object'user_wage' required

Example response

{
  "data": {
    "effective_date": "2020-01-01",
    "enabled_days": {
      "Sunday": true,
      "Monday": true,
      "Tuesday": true,
      "Wednesday": true,
      "Thursday": true,
      "Friday": true,
      "Saturday": false
    },
    "created": "2020-01-20T12:00:00.000Z",
    "modified": "2020-01-20T12:00:00.000Z"
  }
}