FAfactorialhr
TimePlanning > PlanningVersion

Creates a Planning version

Changed on

Creates a Planning version

post/api/2026-10-01/resources/time_planning/planning_versions

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/time_planning/planning_versions
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: time_tracking
    • or API key in header x-api-key

Request body

effective_atstring required

Planning version start date

planning_toolstring required

Type of planning tool (shift_management, work_schedule, contract_hours)

number_of_rest_days_in_centsinteger

Amount of rest days per week if applicable (in cents)

employee_idstring required

Employee identifier

schedule_idstring

Work schedule identifier to include if applicable

Example request

{
  "effective_at": "2020-09-07",
  "planning_tool": "shift_management",
  "number_of_rest_days_in_cents": 200,
  "employee_id": "1",
  "schedule_id": "1"
}

Response

CREATED

idstring

Planning version identifier

effective_atstring required

Planning version start date

planning_toolstring required

Type of planning tool (shift_management, work_schedule, contract_hours)

number_of_rest_days_in_centsinteger

Amount of rest days per week if applicable (in cents)

employee_idstring required

Employee identifier

work_schedule_schedule_idstring

Work schedule identifier to include if applicable

Example response

{
  "id": "1",
  "effective_at": "2020-09-07",
  "planning_tool": "shift_management",
  "number_of_rest_days_in_cents": 200,
  "employee_id": "1",
  "work_schedule_schedule_id": "1"
}

Changes