Create Actual Time Off

Request

Creates a new actual time off record for an employee. Multiple entries for the same person on the same date are permitted.

Security

ApiKey

Body

person_idstring, (uuid)required

The id of the person to whom the actual time off belongs.

recorded_datestring, (date)required

The date on which the time off was recorded, in YYYY-MM-DD format.

hoursnumber, (double)required

The number of hours of time off recorded.

time_off_categorystring(TimeOffCategory)required

The category of time off.

Enum:"personal_time_off""holiday"

descriptionstring or null

Optional notes associated with the actual time off entry.

curl -i -X POST \
  https://developer.getparallax.com/_mock/api-documentation/swagger/v1/actual-time-off \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
    "recorded_date": "2019-08-24",
    "hours": 0.1,
    "time_off_category": "personal_time_off",
    "description": "string"
  }'

Responses

Created

Bodyapplication/json

idstring, (uuid)

The id of the actual time off entry.

person_idstring, (uuid)

The id of the person to whom the actual time off belongs.

recorded_datestring, (date)

The date on which the time off was recorded, in YYYY-MM-DD format.

hoursnumber, (double)

The number of hours of time off recorded.

time_off_categorystring(TimeOffCategory)

The category of time off.

Enum:"personal_time_off""holiday"

descriptionstring or null

Optional notes associated with the actual time off entry.

Response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  "recorded_date": "2019-08-24",
  "hours": 0.1,
  "time_off_category": "personal_time_off",
  "description": "string"
}