Features supported

• Support asynchronous invocation: NO
• Supports paging: YES, with certain conditions -- orderBy must be modified, and page direction must be 1 (ascending order)
• Field selection: YES
• Supplemental data: YES

PagingField SelectionSupplemental Data

curl --request GET \
  --url 'https://api.fareclock.com/duration-entries?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 duration 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.
employee	integer	No	Employee ID. If specified, orgUnit and department are ignored.
orderBy	string	No	date (default) or modified. Paging requires orderBy=modified.
supplementalData	string	No	no to exclude all supplemental data.
supplementalDataFields[]	string	No	Repeat for each supplemental data kind to include: employee, department, orgUnit, payClass, label, timeOffCode.
fields[]	string	No	Repeat for each field to include in results.
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": null,
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    },
    "orgUnit": {
      "6403555720167424": {
        "name": "Main Office",
        "payrollId": "ORG-001",
        "timezone": "America/New_York"
      }
    },
    "employee": {
      "6122080743456768": {
        "firstName": "Jane",
        "lastName": "Smith",
        "payrollId": "EMP-001"
      }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}

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

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the duration 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": null,
      "timeOffCode": 6685030696878080,
      "timeOffRequest": null,
      "created": "2020-06-02T23:11:08.690835Z",
      "modified": "2020-06-02T23:11:08.696838Z"
    }
  ],
  "supplementalData": {
    "timeOffCode": {
      "6685030696878080": { "name": "Vacation" }
    },
    "orgUnit": {
      "6403555720167424": {
        "name": "Main Office",
        "payrollId": "ORG-001",
        "timezone": "America/New_York"
      }
    },
    "employee": {
      "6122080743456768": {
        "firstName": "Jane",
        "lastName": "Smith",
        "payrollId": "EMP-001"
      }
    }
  },
  "serverDt": "2020-06-02T23:11:08.831741Z"
}