Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Payroll > PolicyPeriod

Change statuses a Policy period

Change statuses a Policy period

post/api/2026-07-01/resources/payroll/policy_periods/change_status

Request body

idstring required

Policy period id

status'preparation' | 'supplements_definition' | 'under_review' | 'payroll_calculation' | 'payment_processing' | 'paid' required

Status of the policy period

notify_employeeboolean required

Flag to notify employees

employee_idsstring[] required

Ids of the employees

Example request

{
  "id": "1",
  "status": "preparation",
  "notify_employee": true,
  "employee_ids": [
    "1",
    "2",
    "3"
  ]
}

Response

OK

idstring required

Policy period id

namestring

Policy name with start and end date

starts_onstring required

The start date of the policy period

policy_idstring required

The id of the policy associated with the policy period

company_idstring required

The id of the company

ends_onstring required

The start date of the policy period

periodstring required

Period for the policy

statusstring

Policy period status

policy_namestring

Policy name

calculation_started_atstring

The date and time the calculation started

Example response

{
  "id": "1",
  "name": "Policy name example 20 aug - 13 sep",
  "starts_on": "2020-01-01",
  "policy_id": "1",
  "company_id": "1",
  "ends_on": "2020-01-01",
  "period": "20 aug - 13 sep 2021",
  "status": "preparation",
  "policy_name": "Policy name example",
  "calculation_started_at": "2020-01-01"
}