API Reference
Home

v1/absences

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

Create an absence for an employment.

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
≥ 1

ID of a shyftplan account.

int32
required
≥ 1

ID of the absence reason.

float
required
≥ 0

Duration of the absence in working days.

int32
required
≥ 1

ID of the employment.

date-time
required

Date-time (ISO 8601) for the end of the object's span.

boolean
required

Determines whether the absence duration is counted as working time.

    Available options:
  • true: Only retrieve absences that are marked as 'paid' (absence counts as working time).
  • false: Only retrieve unpaid absences.

date-time
required

Date-time (ISO 8601) for the begin of the object's span.

string
enum

State of the absence.

    Available options:
  • new: Absence application (by manager or employee) on which no decision has been made.
  • accepted: Approved absence (by manager).
  • refused: Application refused by a manager.
  • withdrawn: Application withdrawn by the employee.

Allowed:
string

Note saved with the object.

boolean

Is the absence spanning full days only?

boolean
Defaults to false

Should the absence be created in spite of conflicts with shifts or absences of the employee?

More info

This parameter has no effect when two settings in shyftplan are both disabled - these are:

  • Company profile > Shift schedules > Absence Conflicts
  • Company profile > Absences > Maximum number of absence days

Otherwise, this parameter has the following effect:

    For a conflict with pre-existing absences:
  • If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved.
  • If at least one of the force* parameters is set to true, the absence will be created.
    For a conflict with shift assignments:
  • If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved. The employee stays assigned to conflicting shifts.
  • If force_collision_and_remove is true then the absence will be created and the employee unassigned from conflicting shifts.
  • If force_collision_and_remove is false and "force_collision" is true then the absence is created, but the employee stays assigned to conflicting shifts.
boolean
Defaults to false

Should the absence be created in spite of conflicts with shifts or absences of the employee, and should the employee be unassigned from conflicting shifts?

More info

This parameter has no effect when two settings in shyftplan are both disabled - these are:

  • Company profile > Shift schedules > Absence Conflicts
  • Company profile > Absences > Maximum number of absence days

Otherwise, this parameter has the following effect:

    For a conflict with pre-existing absences:
  • If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved.
  • If at least one of the force* parameters is set to true, the absence will be created.
    For a conflict with shift assignments:
  • If both force_collision and force_collision_and_remove are set to false, the new absence will not be created. Instead, an error will be saved. The employee stays assigned to conflicting shifts.
  • If force_collision_and_remove is true then the absence will be created and the employee unassigned from conflicting shifts.
  • If force_collision_and_remove is false and "force_collision" is true then the absence is created, but the employee stays assigned to conflicting shifts.
file

Attachment file (max. 5MB)

absence_days_breakdown
array of objects

List of absence minutes per calendar day.

absence_days_breakdown
Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?