Features supported

• Support asynchronous invocation: YES
• Supports paging: NO
• Field selection: NO
• Supplemental data: YES

AsyncSupplemental Data

curl --request GET \
  --url 'https://api.fareclock.com/timeoffentries?from=2024-01-01&to=2024-01-31' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
from	date	Yes	Start of date range for the date of time off entry.
to	date	Yes	Inclusive end of date range.
orgUnit	integer	No	Organization unit ID of employee.
department	integer	No	Department ID.
payClass	integer	No	Pay class ID.
labels	integer	No	User label ID.
worker	integer	No	Employee ID filter for list queries.
timeOffCode	integer	No	Time Off Code ID.
supplementalData	string	No	no to exclude all supplemental data.
supplementalDataFields[]	string	No	Repeat for each supplemental data kind to include.
userCustomFields	string	No	Custom fields query string.

{
  "results": [
    {
      "id": 4538783999459328,
      "type": "PAID_TIME_OFF",
      "date": "2020-06-02",
      "duration": 480.0,
      "employee": 6122080743456768,
      "orgUnit": 6403555720167424,
      "department": 4996180836614144,
      "payClass": 5277655813324800,
      "labels": ["user:5559130790035456"],
      "lastEditedBy": "admin@example.com",
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}

curl --request POST \
  --url 'https://api.fareclock.com/timeoffentries' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "employee": 6122080743456768,
  "date": "2020-06-02",
  "timeOffCode": 6685030696878080,
  "duration": 480,
  "notes": "api create"
}'

{
  "employee": 6122080743456768,
  "date": "2020-06-02",
  "timeOffCode": 6685030696878080,
  "duration": 480,
  "notes": "api create"
}

{
  "results": [
    {
      "id": 4538783999459328,
      "type": "PAID_TIME_OFF",
      "date": "2020-06-02",
      "duration": 480.0,
      "employee": 6122080743456768,
      "orgUnit": 6403555720167424,
      "department": 4996180836614144,
      "payClass": 5277655813324800,
      "labels": ["user:5559130790035456"],
      "lastEditedBy": "admin@example.com",
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}

curl --request GET \
  --url 'https://api.fareclock.com/timeoffentries/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the time off entry

{
  "results": [
    {
      "id": 4538783999459328,
      "type": "PAID_TIME_OFF",
      "date": "2020-06-02",
      "duration": 480.0,
      "employee": 6122080743456768,
      "orgUnit": 6403555720167424,
      "department": 4996180836614144,
      "payClass": 5277655813324800,
      "labels": ["user:5559130790035456"],
      "lastEditedBy": "admin@example.com",
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}

curl --request PUT \
  --url 'https://api.fareclock.com/timeoffentries/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "date": "2020-06-02",
  "timeOffCode": 6685030696878080,
  "duration": 420,
  "notes": "updated by manager"
}'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the time off entry

{
  "date": "2020-06-02",
  "timeOffCode": 6685030696878080,
  "duration": 420,
  "notes": "updated by manager"
}

{
  "results": [
    {
      "id": 4538783999459328,
      "type": "PAID_TIME_OFF",
      "date": "2020-06-02",
      "duration": 480.0,
      "employee": 6122080743456768,
      "orgUnit": 6403555720167424,
      "department": 4996180836614144,
      "payClass": 5277655813324800,
      "labels": ["user:5559130790035456"],
      "lastEditedBy": "admin@example.com",
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}

curl --request DELETE \
  --url 'https://api.fareclock.com/timeoffentries/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the time off entry