v2/absence_reasons/{id}

patch https://shyftplan.com/api/v2/absence_reasons/{id}

Update existing absence reason.

Path Params

int32

required

Absence Reason ID.

Body Params

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

company_id

int32

required

≥ 1

ID of the shyftplan account.

name

string

Name of the absence reason.

type

string

Type of an absence reason.

time_account: External (managed outside shyftplan) time account absence reason type.
with_entitlement: Reason type for absences with a yearly entitlement per employee. Deductions from this entitlement are performed inside shyftplan.
without_entitlement: Reason type for absences with no fixed maximum entitlement per employee. Typical example of an absence reason with this type: Sickness.

calculation_type

string

Defaults to standard

Calculation method for the (days and hours) value of absences of an absence reason. For a limited time only, this determines only the calculation method for the absence days, while the hours are calculated according to a separate parameter.

short_name

string

length ≤ 3

Abbreviation for the absence reason (for display purposes in shyftplan).

days

float

Default entitlement in days for the absence reason. Must be empty or null for an absence reason of type time_account.

carry_over_days_enabled

boolean

Defaults to false

Can remaining days of the absence entitlement for an absence reason be transferred to the subsequent year?

carry_over_days_deadline_date

string

Expiration date of carry over absence days. Format: DD.MM

hours_calculation_type

string

Absence hours calculation type.

is_absence_attachments_allowed

boolean

Defaults to false

Can an attachment file be uploaded for absences of an absence reason?

employee_management_enabled

boolean

Can employees manage their own time-account absences for the absence reason?

lower_limit_minutes

int32

The lower limit (in minutes) for the balance of a time-account absence reason of an employee.

lower_warning_minutes

int32

The lower warning threshold (in minutes) for the balance of a time-account absence reason of an employee.

upper_warning_minutes

int32

The upper warning threshold (in minutes) for the balance of a time-account absence reason of an employee.

upper_limit_minutes

int32

The upper limit threshold (in minutes) for the balance of a time-account absence reason of an employee.

update_all_employment_time_accounts

boolean

Defaults to false

Update the upper/lower warnings/limits in all employment time accounts accordingly?

permission_level

string

Defaults to all_users

Group with access to the absence reason.

employees_can_edit_days_and_hours

boolean

Defaults to false

Are emloyees allowed to edit days and hours of absences for this reason?

Responses

Response body

object

int32

required

≥ 1

ID of the object.

company_id

int32

required

≥ 1

ID of the shyftplan account.

name

string

required

type

string

required

Type of an absence reason.

time_account: External (managed outside shyftplan) time account absence reason type.
with_entitlement: Reason type for absences with a yearly entitlement per employee. Deductions from this entitlement are performed inside shyftplan.
without_entitlement: Reason type for absences with no fixed maximum entitlement per employee. Typical example of an absence reason with this type: Sickness.

time_account with_entitlement without_entitlement

short_name

string

length ≤ 3

Abbreviation for the absence reason (for display purposes in shyftplan).

days

float

required

Default entitlement in days for the absence reason. Must be empty or null for an absence reason of type time_account.

carry_over_days_enabled

boolean

required

Can a year's remaining absence days for the absence reason be taken transferred to the next year?

carry_over_days_deadline

string

The date of the last day each year for an employee to take any of the previous year's remaining days of absence for an absence reason. Format: DD.MM

calculation_type

string

The method of days calculation for an absence reason.

hours_calculation_type

string

Absence hours calculation type.

employee_profile scheduled_shifts

is_absence_attachments_allowed

boolean

Can an attachment be uploaded for absences of this absence reason?

has_localization

boolean

Is there a translation string available for this absence reason?

is_default

boolean

Will this absence reason be taken as the default one? Exactly one absence reason will have this set to true. The default reason will be used for the aggregation column in the absence planning mode in shyftplan.

created_at

date-time

Date-time (ISO 8601) when the object was created.

updated_at

date-time

Date-time (ISO 8601) when the object was created.

deleted_at

date-time

Date-time (ISO 8601) when the object was deleted.

lower_limit_minutes

int32

The lower limit (in minutes) for the balance of a time-account absence reason of an employee.

lower_warning_minutes

int32

The lower warning threshold (in minutes) for the balance of a time-account absence reason of an employee.

upper_warning_minutes

int32

The upper warning threshold (in minutes) for the balance of a time-account absence reason of an employee.

upper_limit_minutes

int32

The upper limit threshold (in minutes) for the balance of a time-account absence reason of an employee.

employee_management_enabled

boolean

required

Can employees manage absences of this absence reason?

Language


xxxxxxxxxx
14
1
curl --request PATCH \
2
     --url https://shyftplan.com/api/v2/absence_reasons/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "calculation_type": "standard",
8
  "carry_over_days_enabled": false,
9
  "is_absence_attachments_allowed": false,
10
  "update_all_employment_time_accounts": false,
11
  "permission_level": "all_users",
12
  "employees_can_edit_days_and_hours": false
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Bad request.

401Unauthorized.

403Forbidden.

404Company not found.

422Invalid request.