FreeDay

A free day: one calendar date on which the organisation is closed, either instantiated from a recurring holiday or added by hand.

View as Markdown

Summary view: FreeDayList, 8 fields. What a list returns by default.
Detail view: FreeDay, 8 fields. The default for a single read and for every write.
Read with: api:read:free_daysandfree_days::manage
Write with: api:write:free_daysandfree_days::manage

Example

detail view

{
  "id": 1,
  "description": "Office closed for the annual outing",
  "date": "2026-07-03",
  "holiday_id": 1,
  "holiday": null,
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}

Free days are excluded from the working days a furlough request consumes. The label is a copy taken at creation time and drifts independently of the holiday it came from.

Used by

GETList free days/free-daysFreeDayList

POSTCreate a free day/free-daysFreeDay

GETRead a free day/free-days/{free_day}FreeDay

PATCHUpdate a free day/free-days/{free_day}FreeDay

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

descriptionstring≤ 255

Label for the free day, e.g. Christmas Day. For a holiday-derived day this is a copy of the holiday name taken when the free day was created, so renaming the holiday does not rewrite it.

datedate (YYYY-MM-DD)

Calendar date the organisation is closed.

holiday_idinteger or null

Recurring holiday this free day instantiates, or null for a day added by hand. The foreign key nulls on delete, so removing the holiday leaves the free day behind as a manual day still carrying the copied label.

holidayRef or HolidaySummary or null

The recurring holiday this free day instantiates; absent for a manually added day.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

linksFreeDayLinks

Show 1 child field

links.selfurl

The canonical URI of this record.

Variants

FreeDayList 8 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

FreeDaySummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: holiday_id, holiday, created_at, updated_at, links

FreeDayLinks 1 field

The links object on this resource.

Keys: self

Something wrong or missing on this page? Tell us