v2/absence_reasons

post

https://shyftplan.com/api/v2/absence_reasons

Create a new absence reason.

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 a shyftplan account.

name

string

required

Name of the absence reason.

type

string

enum

required

Type of the 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.

Allowed:

calculation_type

string

enum

required

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.

Allowed:

short_name

string

length ≤ 3

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

days

float

Default entitlement (for new employments) in days for the absence reason.

Required for an absence reason of type with_entitlement. For an absence reason of type time_account or without_entitlement, you must eiter omit the parameter completely, or set the value to an empty string or null.

carry_over_days_enabled

boolean

Defaults to false

Determines whether employments can use remaining days of entitlement for an absence reason in the subsequent year (true).

Must be true if you want to set absence_reason_carry_over_date. Must be false, if you want to change the absence-reason type to without_entitlement or time_account.

carry_over_days_deadline_date

string

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

hours_calculation_type

string

enum

Absence hours calculation type.

Allowed:

is_absence_attachments_allowed

boolean

Defaults to false

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

employee_management_enabled

boolean

Defaults to true

Allow employees to manage their own time-account 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.

permission_level

string

enum

Defaults to all_users

Group with access to the absence reason.

Allowed:

employees_can_edit_days_and_hours

boolean

Defaults to false

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

Responses

Language

Loading…

Response

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

application/json

201Success.

400Bad request.

401Unauthorized.

403Forbidden.

404Company not found

422Invalid request.