Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Time Entry Report

Generate a detailed report

Detailed report data on FREE subscription plan is limited to a maximum interval length of one month (31 days).

post/v1/workspaces/{workspaceId}/reports/detailed

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:60f91b3ffdaf031696ecxxxx

Request body

amountShown'EARNED' | 'COST' | 'PROFIT' | 'HIDE_AMOUNT' | 'EXPORT'

If provided, you'll get filtered result including reports with provided amount shown.

amountsstring[]
approvalState'APPROVED' | 'UNAPPROVED' | 'ALL'

If provided, you'll get filtered result including reports with provided approval state.

archivedboolean

Indicates whether the report is archived

billableboolean

Indicates whether the report is billable

dateFormatstring

Provide date in format YYYY-MM-DD

dateRangeEndstring required

Provide date in format YYYY-MM-DDTHH:MM:SS.ssssss. The system interprets this value based on the user's timezone (provided in the timeZone request parameter or the timezone configured in the user profile)

dateRangeStartstring required

Provide date in format YYYY-MM-DDTHH:MM:SS.ssssss. The system interprets this value based on the user's timezone (provided in the timeZone request parameter or the timezone configured in the user profile)

dateRangeType'ABSOLUTE' | 'TODAY' | 'YESTERDAY' | 'THIS_WEEK' | 'LAST_WEEK' | 'PAST_TWO_WEEKS' | 'THIS_MONTH' | 'LAST_MONTH' | 'THIS_YEAR' | 'LAST_YEAR'

Provide the date range type

descriptionstring

Represents search term for filtering report entries by description

exportType'JSON' | 'JSON_V1' | 'PDF' | 'CSV' | 'XLSX' | 'ZIP'

If provided, you'll get filtered result including reports with provided export type.

invoicingState'INVOICED' | 'UNINVOICED' | 'ALL'

If provided, you'll get filtered result including reports with provided invoicing state.

roundingboolean

Indicates whether the report filter is rounding

sortOrder'ASCENDING' | 'DESCENDING'

If provided, you'll get sorted result by provided sort order.

timeFormatstring

Provide time in format THH:MM:SS.ssssss

timeZonestring

If provided, you'll get filtered result including reports with provided time zone.

userLocalestring

If provided, you'll get filtered result including reports with provided user locale.

weekStart'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'

If provided, you'll get filtered result including reports with provided week start.

withoutDescriptionboolean

If set to 'true', report will only include entries with empty description

zoomLevel'WEEK' | 'MONTH' | 'YEAR'

If provided, you'll get filtered result including reports with provided zoom level.

Example request

{
  "amountShown": "COST",
  "amounts": [
    "[EARNED, COST]"
  ],
  "approvalState": "APPROVED",
  "attendanceFilter": {
    "balanceFilters": [
      {
        "value": "150"
      }
    ],
    "breakFilters": [
      {
        "value": "50"
      }
    ],
    "capacityFilters": [
      {
        "value": "750"
      }
    ],
    "endFilters": [
      {
        "value": "17:00"
      }
    ],
    "hasTimeOff": true,
    "overtimeFilters": [
      {
        "value": "150"
      }
    ],
    "startFilters": [
      {
        "value": "15:00"
      }
    ],
    "undertimeFilters": [
      {
        "value": "150"
      }
    ],
    "workFilters": [
      {
        "value": "750"
      }
    ]
  },
  "billable": true,
  "clients": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "currency": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "customFields": [
    {
      "id": "5b71544ab0798751107918b3",
      "numberCondition": "EQUAL",
      "type": "NUMBER"
    }
  ],
  "dateFormat": "2018-11-01",
  "dateRangeEnd": "2018-11-30T23:59:59.999",
  "dateRangeStart": "2018-11-01T00:00:00",
  "dateRangeType": "LAST_MONTH",
  "description": "some description keyword",
  "detailedFilter": {
    "auditFilter": {
      "duration": 2,
      "withoutTask": true
    },
    "options": {
      "totals": "CALCULATE"
    },
    "page": 1,
    "pageSize": 20,
    "sortColumn": "ID"
  },
  "exportType": "JSON",
  "invoicingState": "INVOICED",
  "projects": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "sortOrder": "ASCENDING",
  "summaryFilter": {
    "groups": [
      "\"[5b715448b07987511071111\", \"5b715448b079875110792222\"]"
    ],
    "sortColumn": "GROUP",
    "summaryChartType": "PROJECT"
  },
  "tags": {
    "containedInTimeentry": "CONTAINS_ONLY",
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "tasks": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "timeFormat": "T00:00:00",
  "timeZone": "Europe/Belgrade",
  "userCustomFields": [
    {
      "id": "5b71544ab0798751107918b3",
      "numberCondition": "EQUAL",
      "type": "NUMBER"
    }
  ],
  "userGroups": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "userLocale": "en",
  "users": {
    "contains": "CONTAINS",
    "ids": [
      "5b715448b079875110792222",
      "5b715448b079875110791111"
    ],
    "status": "ACTIVE"
  },
  "weekStart": "MONDAY",
  "weeklyFilter": {
    "group": "5b715448b079875110791111",
    "subgroup": "5b715448b079875110792222"
  },
  "zoomLevel": "WEEK"
}

Response

OK