API Reference
Home

v1/absence_reasons

post
https://shyftplan.com/api/v1/absence_reasons

Create a new absence reason.

Body Params
string
required

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

E-mail address of the API user.

string
required

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

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

string
enum
required
Defaults to standard

Absence days calculation type.

Allowed:
float
required

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.

string
enum
required
Defaults to employee_profile

Absence hours calculation type.

Allowed:
string
required

Name of the absence reason.

string

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

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.

boolean
Defaults to false

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

string
length ≤ 3

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

Responses

Updated 3 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago